Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc/Glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ A service that controls access between two or more networks.

## Genie Python

An implementation of the [OpenGenie](http://www.opengenie.org) scripting language in Python, or at least its commands specific to instrument control. Documentation [here](http://shadow.nd.rl.ac.uk/genie_python/sphinx/genie_python.html).
An implementation of the [OpenGenie](http://www.opengenie.org) scripting language in Python, or at least its commands specific to instrument control. Documentation at {external+genie_python:doc}`genie_python`.

## GIT

Expand Down
2 changes: 1 addition & 1 deletion doc/Overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ overview/Links-and-Resources
- [General IOC information](IOCs): Everything you could possibly want to know about IOCs in general, creation and conventions
- [Specific Device IOC](Specific-IOCs): Detailed information about specific IOCs & scientific hardware
- [Project Tools](Tools): Developer-facing tools which have proven useful for the project
- [System Administration & Hardware](/Systems): All about the physical & virtual computers on which IBEX runs
- {external+sysadmin:doc}`System Administration & Hardware <index>`: All about the physical & virtual computers on which IBEX runs

## Documentation & Processes

Expand Down
2 changes: 1 addition & 1 deletion doc/Providing-Support.md
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ There are a number of tips for [trouble shooting](#all_troubleshooting_links) al

1. There are a few things that have services which run, especially the databases, and it is possible after a crash/other restart that these don't start up again, starting task manager as an administrator should allow you to start the service in question
1. If it is not one of our services (e.g. swipe systems, ERA), we cannot resolve the issue, escalate as appropriate (TODO: Make sure the different escalation methods are documented)
1. If the MCR news service isn't working, then so long as there is space, restarting our [webserver](/systems/Webserver) may help.
1. If the MCR news service isn't working, then so long as there is space, restarting our {external+sysadmin:doc}`systems/Webserver` may help.

</details>

Expand Down
19 changes: 0 additions & 19 deletions doc/Systems.md

This file was deleted.

4 changes: 1 addition & 3 deletions doc/Web.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,8 @@

webdashboard/Web-Dashboard
webdashboard/PVWS
webdashboard/ISIS-Info-Slack
webdashboard/MCR-News-in-Teams
```

```{seealso}
- [WebServer](systems/Webserver) for the physical computer where the [PVWS](webdashboard/PVWS) instance, which the [Web Dashboard](webdashboard/Web-Dashboard) relies on, is hosted.
- {external+sysadmin:doc}`systems/Webserver` for the physical computer where the [PVWS](webdashboard/PVWS) instance, which the [Web Dashboard](webdashboard/Web-Dashboard) relies on, is hosted.
```
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ To help debug the PVObserver and lower levels you can build a version of the GUI
- org.csstudio.utilities.pvmanager.epics
1. This will now print out debug statements all containing the text Ticket2162
1. The logs can be filtered using a python program below (this program is very rough, don't forget to change the date)
1. This can be combined with Wireshark (see [Network traffic](/tools/Network-traffic)) to analyse traffic if needed
1. This can be combined with Wireshark to analyse traffic if needed

Example log output from disconnection to reconnection

Expand Down
3 changes: 3 additions & 0 deletions doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -113,4 +113,7 @@
"ibex_bluesky_core": ("https://isiscomputinggroup.github.io/ibex_bluesky_core/", None),
"matplotlib": ("https://matplotlib.org/stable/", None),
"secop": ("https://sampleenvironment.github.io/secop-site/", None),
# This inventory needs to be periodically updated (manually) if new pages are added or
# page layouts changed.
"sysadmin": ("https://shadow.nd.rl.ac.uk/ibex_sysadmin_manual/", "sysadmin_manual.inv"),
}
1 change: 0 additions & 1 deletion doc/deployment/Deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,5 +16,4 @@ deploy/Reviewing-Deploy-Tickets
deploy/Upgrade-ISISICP
deploy/Upgrade-Java
deploy/Installing-and-Upgrading-MySQL
deploy/NPort-install
```
4 changes: 0 additions & 4 deletions doc/deployment/Patch.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,3 @@ How to patch or hotfix a new change onto an instrument which already has IBEX.

patch/*
```

:::{seealso}
See also [powershell remoting](/systems/inst_control/PS-Remote) for a script to apply patches to many instruments simultaneously.
:::
23 changes: 0 additions & 23 deletions doc/deployment/deploy/NPort-install.md

This file was deleted.

1 change: 0 additions & 1 deletion doc/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ Web
System-components
IOCs
Specific-IOCs
Systems
```

```{toctree}
Expand Down
2 changes: 1 addition & 1 deletion doc/overview/First-Time-Build.md
Original file line number Diff line number Diff line change
Expand Up @@ -288,4 +288,4 @@ Download and install latest stable version from https://wixtoolset.org/docs/wix3
### Add your SSH key to the `keys` repository

Adding an SSH key to the [keys repository](https://github.com/isiscomputinggroup/keys) can be used to give
passwordless access to instrument machines. Follow the instructions [here](/tools/SSH-keys).
passwordless access to instrument machines. Follow the instructions {external+sysadmin:doc}`services/SSH-keys`.
5 changes: 2 additions & 3 deletions doc/overview/Links-and-Resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
- {external+ibex_user_manual:doc}`IBEX user manual <index>`
- [IBEX Project Board for Issues](https://github.com/ISISComputingGroup/IBEX/projects/1)
- [Stream Protocol Page](http://epics.web.psi.ch/software/streamdevice/doc/)
- [genie_python reference](http://shadow.nd.rl.ac.uk/genie_python/sphinx/genie_python.html)
- {external+genie_python:doc}`genie_python reference <genie_python>`
- [nagios](https://varanus.nd.rl.ac.uk/nagios/)
- [EPICS WIKI](https://wiki-ext.aps.anl.gov/epics/index.php/RRM_3-14)
- [Current program version, servers and settings](http://beamlog.nd.rl.ac.uk/inst_summary.xml)
Expand All @@ -53,7 +53,6 @@ A non-exhaustive collection of troubleshooting pages.
* [Database](/system_components/mysql/Database-Troubleshooting)
* [Web Dashboard](#webdashboard_troubleshooting)
* [genie_python](/scripting/genie_python/genie_python-Troubleshooting)
* [Computer](/systems/inst_control/Computer-Troubleshooting) (e.g. the NDX)
* [ICAT and TopCAT](/systems/external/ICAT-Troubleshooting)
* {external+sysadmin:doc}`index`
* [Mini-inst](/system_components/startup/Mini-inst-Troubleshooting)
* [Where are the log files](/iocs/troubleshooting/Log-file-location)
1 change: 0 additions & 1 deletion doc/overview/New-Starters.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,6 @@ Some pages to read over:
Pages to skim over. Read in detail only when needed:

- [Settings and Configurations](../system_components/Settings-and-Configurations)
- [Data Generation and Storage](../systems/inst_control/Data-Generation-and-Storage-on-Instrument-PCs-(NDX's))
- [Information for User Scientists](https://github.com/ISISComputingGroup/IBEX/wiki)

Every section after this line contains reference information that you do not necessarily have to read before you do your first ticket, but it is where you should take a look when you find out you need to learn new things in order to do your work.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,5 +49,5 @@ Yes, this is a good idea. Call the file `Sprintreview_start_<date>`. Add start a

- We are happy that POLREF is now running on IBEX and SURF is planning to use it this cycle.
- We are making good progress on SANS2D. Different groups coordinating well with each other (us, scientists, network team, ...)
- We are excited about Windows 10 updates. Build is "mostly" automated, process is now documented [(Link)](/systems/inst_control/mdt/Building-a-windows-10-instrument-machine-from-MDT), everyone should in principle be able to set this up.
- We are excited about Windows 10 updates. Build is "mostly" automated, process is now documented on SysAdmin manual, everyone should in principle be able to set this up.
- What to do with trivial support issues? Creating a ticket every time seems like a lot of overhead --> Put them in a teams channel, then record them permanently in a ticket at the end of the sprint. `support-issues` channel has now been created
Binary file added doc/sysadmin_manual.inv
Binary file not shown.
4 changes: 2 additions & 2 deletions doc/system_components/journal_viewer/Journal-Viewer-Data.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Journal Viewer data

The ISISICP writes run summaries to an XML journal file on the instrument, these files are in c:/data but are then copied to the archive and stored under Instrument/logs/journal.
The ISISICP writes run summaries to an XML journal file on the instrument, these files are in `c:/data` but are then copied to the archive and stored under `Instrument/logs/journal`.

The windows archive is smb mounted onto a linux server [(`sparrowhawk.nd.rl.ac.uk`, which we maintain)](/systems/Sparrowhawk) and served to the lab as https://data.isis.rl.ac.uk/journals/ where programs such as Mantid and "standalone journal viewer" can access it. This machine runs on the facilities hyper-v cluster, technology department look after it from a server patching point of view and if there are major operating system issues. Try rebooting the server via the hyper-v console manager, if that doesn't work (e.g. drops into a recovery console talking about disk errors) then contact "Technology IT Support" on outlook. It seems that emails to "Technology IT Support" are only accepted from certain accounts, ISIS experiment controls looking not to be one of them at the moment.
The windows archive is smb mounted onto a linux server ({external+sysadmin:doc}`systems/linux_support_systems/Sparrowhawk`) and served to the lab as https://data.isis.rl.ac.uk/journals/ where programs such as Mantid and "standalone journal viewer" can access it. This machine runs on the facilities hyper-v cluster, technology department look after it from a server patching point of view and if there are major operating system issues. Try rebooting the server via the hyper-v console manager, if that doesn't work (e.g. drops into a recovery console talking about disk errors) then contact "Technology IT Support" on outlook. It seems that emails to "Technology IT Support" are only accepted from certain accounts, ISIS experiment controls looking not to be one of them at the moment.

Journals can be accessed remotely (outside the lab) by users using https://shadow.nd.rl.ac.uk/journals/. More documentation on this is available at `\\isis\shares\isis_experiment_controls\web_dashboard_history.docx`
10 changes: 0 additions & 10 deletions doc/systems/External.md

This file was deleted.

10 changes: 0 additions & 10 deletions doc/systems/Inst-Control.md

This file was deleted.

25 changes: 0 additions & 25 deletions doc/systems/MinimumSpecs.md

This file was deleted.

11 changes: 0 additions & 11 deletions doc/systems/Nagios.md

This file was deleted.

22 changes: 0 additions & 22 deletions doc/systems/Shadow.md

This file was deleted.

17 changes: 0 additions & 17 deletions doc/systems/Sparrowhawk.md

This file was deleted.

24 changes: 0 additions & 24 deletions doc/systems/Test-Machines.md

This file was deleted.

24 changes: 0 additions & 24 deletions doc/systems/Webserver.md

This file was deleted.

Loading