Merge pull request #93 from ISISComputingGroup/add_migration_notes_warning

GRyall · web-flow · commit d5efc4c5b2e4 · 2025-10-02T16:22:24.000+01:00
Add migration notes warning to all inst details pages
diff --git a/doc/processes/Instrument-Details.md b/doc/processes/Instrument-Details.md
@@ -1,9 +1,6 @@
 # Instrument Migration Notes
 
-```{warning}
-These instrument details pages provide historical context about the devices on a specific instrument,
-at the time they were migrated to IBEX. **These pages may not be up to date with the latest instrument
-configuration.**
+```{include} instrument_details/migration_notes_warning.mdinc
 ```
    
 ```{toctree}
diff --git a/doc/processes/instrument_details/ALF-Instrument-Details.md b/doc/processes/instrument_details/ALF-Instrument-Details.md
@@ -1,5 +1,8 @@
 # ALF
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the new control system on ALF.
 
 ### Background & Timeline
diff --git a/doc/processes/instrument_details/ARGUS-Instrument-Details.md b/doc/processes/instrument_details/ARGUS-Instrument-Details.md
@@ -1,5 +1,8 @@
 # ARGUS
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the IBEX control system on ARGUS.
 
 ## Background & Timeline ##
diff --git a/doc/processes/instrument_details/CHIPIR-Instrument-Details.md b/doc/processes/instrument_details/CHIPIR-Instrument-Details.md
@@ -1,5 +1,8 @@
 # CHIPIR
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the new control system on CHIPR.
 ## Background & Timeline ##
 CHIPIR is a neutron instrument dedicated to the irradiation of microelectronics with atmospheric-like neutrons, on TS2. The [CHIPIR](https://www.isis.stfc.ac.uk/Pages/Chipir.aspx) web page describes the background to the instrument.
diff --git a/doc/processes/instrument_details/CHRONUS-Instrument-Details.md b/doc/processes/instrument_details/CHRONUS-Instrument-Details.md
@@ -1,5 +1,8 @@
 # CHRONUS
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the IBEX control system on CHRONUS.
 
 ## Background & Timeline
diff --git a/doc/processes/instrument_details/CRISP-Instrument-Details.md b/doc/processes/instrument_details/CRISP-Instrument-Details.md
@@ -1,5 +1,8 @@
 # CRISP
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the IBEX control system on CRISP.
 ## Background & Timeline ##
 CRISP is a reflectometer instrument at ISIS, on TS1. The [CRISP](https://www.isis.stfc.ac.uk/Pages/CRISP.aspx) web page describes the background to the instrument.
diff --git a/doc/processes/instrument_details/DETMON-Instrument-Details.md b/doc/processes/instrument_details/DETMON-Instrument-Details.md
@@ -1,5 +1,8 @@
 # DETMON
 
+```{include} migration_notes_warning.mdinc
+```
+
 ## Background & Timeline ##
 DETMON is a support system for use by the detector teams to monitor and view the status of the HV (High Voltage) crates that are in use across ISIS.
 A pilot system should be created before Cycle 2019-01, the final system does not at present have a dead line.
diff --git a/doc/processes/instrument_details/EMMA-Instrument-Details.md b/doc/processes/instrument_details/EMMA-Instrument-Details.md
@@ -1,5 +1,8 @@
 # EMMA
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the IBEX control system on EMMA.
 ## Background & Timeline ##
 EMMA is an instrument at ISIS, on TS1 and used primarily for test purposes. The primary users of EMMA are the sample environment team and the detector team.  There appears to be no web pages (or other material) describing the background to the instrument.
diff --git a/doc/processes/instrument_details/EMU-Instrument-Details.md b/doc/processes/instrument_details/EMU-Instrument-Details.md
@@ -1,5 +1,8 @@
 # EMU
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the IBEX control system on EMU.
 ## Background & Timeline ##
 EMU is a new 96-detector muon spin rotation spectrometer which is optimised for zero field and longitudinal field measurements at ISIS, on TS1. The [EMU](https://www.isis.stfc.ac.uk/Pages/EMU.aspx) web page describes the background to the instrument.
diff --git a/doc/processes/instrument_details/ENGIN-X-Instrument-Details.md b/doc/processes/instrument_details/ENGIN-X-Instrument-Details.md
@@ -1,5 +1,8 @@
 # ENGIN-X
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the IBEX control system on ENGIN-X.
 ## Background & Timeline ##
 ENGIN-X is a long established instrument at ISIS, on TS1. The [ENGIN-X](http://www.isis.stfc.ac.uk/instruments/engin-x/engin-x2900.html) web page describes the background to the instrument.  ENGIN-X is dedicated to engineering science experiments. It is optimized for the measurement of strain, and thus stress, deep within crystalline materials.
diff --git a/doc/processes/instrument_details/GEM-Instrument-Details.md b/doc/processes/instrument_details/GEM-Instrument-Details.md
@@ -1,5 +1,8 @@
 # GEM
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the IBEX control system on GEM.
 ## Background & Timeline ##
 GEM is a diffractometer instrument at ISIS, on TS1. The [GEM](http://www.isis.stfc.ac.uk/instruments/gem/gem2467.html) web page describes the background to the instrument.
diff --git a/doc/processes/instrument_details/HIFI-Instrument-Details.md b/doc/processes/instrument_details/HIFI-Instrument-Details.md
@@ -1,5 +1,8 @@
 # HIFI
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the IBEX control system on HIFI.
 ## Background & Timeline ##
 HIFI is high magnetic-field muon instrument at ISIS, on TS1. The [HIFI](https://www.isis.stfc.ac.uk/Pages/HIFI.aspx) web page describes the background to the instrument.
diff --git a/doc/processes/instrument_details/HIFI_CRYOMAG-Instrument-Details.md b/doc/processes/instrument_details/HIFI_CRYOMAG-Instrument-Details.md
@@ -1,5 +1,8 @@
 # HIFI-CRYOMAG
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page contains information pertinent to the conversion of the HIFI_CRYOMAG control system from LabVIEW to EPICS.
 
 ## Background & Timeline ##
diff --git a/doc/processes/instrument_details/HRPD-Instrument-Details.md b/doc/processes/instrument_details/HRPD-Instrument-Details.md
@@ -1,5 +1,8 @@
 # HRPD
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the IBEX control system on HRPD.
 
 ## Background & Timeline ##
diff --git a/doc/processes/instrument_details/IMAT-Instrument-Details.md b/doc/processes/instrument_details/IMAT-Instrument-Details.md
@@ -1,5 +1,8 @@
 # IMAT
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the new control system on IMAT.
 ## Background & Timeline ##
 The [IMAT](http://www.isis.stfc.ac.uk/instruments/imat/imat8259.html) web page describes the background to the instrument.  Additional material is also available on the [IMAT sharepoint](https://stfc365.sharepoint.com/sites/ISISExperimentControls/ICP%20Discussions/Forms/AllItems.aspx?id=%2Fsites%2FISISExperimentControls%2FICP%20Discussions%2FIMAT&viewid=45d81cb9%2D9571%2D4a80%2Da5cc%2D2cb4871703a3).
diff --git a/doc/processes/instrument_details/INES-Instrument-Details.md b/doc/processes/instrument_details/INES-Instrument-Details.md
@@ -1,5 +1,8 @@
 # INES
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the IBEX control system on INES.
 ## Background & Timeline ##
 INES is a powder diffractometer instrument at ISIS, on TS1. The [INES](https://www.isis.stfc.ac.uk/Pages/ines.aspx) web page describes the background to the instrument.
diff --git a/doc/processes/instrument_details/INTER-Instrument-Details.md b/doc/processes/instrument_details/INTER-Instrument-Details.md
@@ -1,5 +1,8 @@
 # INTER
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the IBEX control system on INTER.
 ## Background & Timeline ##
 INTER is a high-intensity chemical interfaces reflectometer instrument at ISIS, on TS2. The [INTER](https://www.isis.stfc.ac.uk/Pages/inter.aspx) web page describes the background to the instrument.
diff --git a/doc/processes/instrument_details/IRIS-Instrument-Details.md b/doc/processes/instrument_details/IRIS-Instrument-Details.md
@@ -1,5 +1,8 @@
 # IRIS
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the new control system on IRIS.
 
 ## Online info
diff --git a/doc/processes/instrument_details/LARMOR-Instrument-Details.md b/doc/processes/instrument_details/LARMOR-Instrument-Details.md
@@ -1,5 +1,8 @@
 # LARMOR
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the new control system on LARMOR.
 
 ## Background & Timeline ##
diff --git a/doc/processes/instrument_details/LET-Instrument-Details.md b/doc/processes/instrument_details/LET-Instrument-Details.md
@@ -1,5 +1,8 @@
 # LET
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the IBEX control system on LET.
 
 ## Background & Timeline ##
diff --git a/doc/processes/instrument_details/LOQ-Instrument-Details.md b/doc/processes/instrument_details/LOQ-Instrument-Details.md
@@ -1,5 +1,8 @@
 # LOQ
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the IBEX control system on LOQ.
 ## Background & Timeline ##
 LOQ is a time-of-flight SANS instrument instrument at ISIS, on TS1. The [LOQ](https://www.isis.stfc.ac.uk/Pages/LOQ.aspx) web page describes the background to the instrument.
diff --git a/doc/processes/instrument_details/MAPS-Instrument-Details.md b/doc/processes/instrument_details/MAPS-Instrument-Details.md
@@ -1,5 +1,8 @@
 # MAPS
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the IBEX control system on MAPS.
 
 ## Background & Timeline ##
diff --git a/doc/processes/instrument_details/MARI-Instrument-Details.md b/doc/processes/instrument_details/MARI-Instrument-Details.md
@@ -1,5 +1,8 @@
 # MARI
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the IBEX control system on MARI.
 
 ## Background & Timeline ##
diff --git a/doc/processes/instrument_details/MERLIN-Instrument-Details.md b/doc/processes/instrument_details/MERLIN-Instrument-Details.md
@@ -1,5 +1,8 @@
 # MERLIN
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the IBEX control system on MERLIN.
 
 ## Background & Timeline ##
diff --git a/doc/processes/instrument_details/MUON-Front-End-Instrument-Details.md b/doc/processes/instrument_details/MUON-Front-End-Instrument-Details.md
@@ -1,5 +1,8 @@
 # MUONFE
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page contains information pertinent to the automation of the Muon Front End Beamline Control at ISIS.
 
 ## Background & Timeline ##
diff --git a/doc/processes/instrument_details/MUSR-Instrument-Details.md b/doc/processes/instrument_details/MUSR-Instrument-Details.md
@@ -1,5 +1,8 @@
 # MUSR
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the IBEX control system on MUSR.
 ## Background & Timeline ##
 MUSR is a general purpose muon spin rotation spectrometer at ISIS, on TS1. However, the emphasis of the experimental work conducted is investigating magnetism and superconductivity.  The [MUSR](https://www.isis.stfc.ac.uk/Pages/MUSR.aspx) web page describes the background to the instrument.
diff --git a/doc/processes/instrument_details/MUX-Instrument-Details.md b/doc/processes/instrument_details/MUX-Instrument-Details.md
@@ -1,4 +1,7 @@
 # MUX
 
+```{include} migration_notes_warning.mdinc
+```
+
 MUX is the name of the system to run the Negative Muon items. It does not use a standard muon DAE, but instead 
 uses the [CAE Hexagon digitisers](/specific_iocs/other/CAEN-Hexagon.md) to acquire data
diff --git a/doc/processes/instrument_details/NIMROD-Instrument-Details.md b/doc/processes/instrument_details/NIMROD-Instrument-Details.md
@@ -1,5 +1,8 @@
 # NIMROD
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the IBEX control system on NIMROD.
 ## Background & Timeline ##
 NIMROD is a diffractometer instrument at ISIS, on TS2. The [NIMROD](https://www.isis.stfc.ac.uk/Pages/NIMROD.aspx) web page describes the background to the instrument.
diff --git a/doc/processes/instrument_details/OFFSPEC-Instrument-Details.md b/doc/processes/instrument_details/OFFSPEC-Instrument-Details.md
@@ -1,5 +1,8 @@
 # OFFSPEC
 
+```{include} migration_notes_warning.mdinc
+```
+
 ## Background & Timeline ##
 OFFSPEC is an advanced reflectometer instrument at ISIS, on TS2. The [OFFSPEC](https://www.isis.stfc.ac.uk/Pages/OFFSPEC.aspx) web page describes the background to the instrument.
 
diff --git a/doc/processes/instrument_details/OSIRIS-Instrument-Details.md b/doc/processes/instrument_details/OSIRIS-Instrument-Details.md
@@ -1,5 +1,8 @@
 # OSIRIS
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the new control system on OSIRIS.
 ## Background & Timeline ##
 OSIRIS is a long established instrument at ISIS, on TS1. The [OSIRIS](https://www.isis.stfc.ac.uk/Pages/osiris.aspx) web page describes the background to the instrument.  A schematic layout of OSIRIS is shown in ​[this diagram](https://www.isis.stfc.ac.uk/Gallery/OSIRIS_3D_BW_Labelled.JPG).<br>
diff --git a/doc/processes/instrument_details/PEARL-Instrument-Details.md b/doc/processes/instrument_details/PEARL-Instrument-Details.md
@@ -1,5 +1,8 @@
 # PEARL
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the IBEX control system on PEARL.
 
 ## Background & Timeline ##
diff --git a/doc/processes/instrument_details/POLARIS-Instrument-Details.md b/doc/processes/instrument_details/POLARIS-Instrument-Details.md
@@ -1,5 +1,8 @@
 # POLARIS
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the IBEX control system on POLARIS.
 ## Background & Timeline ##
 POLARIS is a diffractometer instrument at ISIS, on TS1. The [POLARIS](http://www.isis.stfc.ac.uk/instruments/polaris/polaris4643.html) web page describes the background to the instrument.
diff --git a/doc/processes/instrument_details/POLREF-Instrument-Details.md b/doc/processes/instrument_details/POLREF-Instrument-Details.md
@@ -1,5 +1,8 @@
 # POLREF
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the IBEX control system on POLREF.
 
 ## Background & Timeline ##
diff --git a/doc/processes/instrument_details/RIKEN-Front-End-Instrument-Details.md b/doc/processes/instrument_details/RIKEN-Front-End-Instrument-Details.md
@@ -1,5 +1,8 @@
 # RIKENFE
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page contains information pertinent to the automation of the RIKEN Front End Beamline Control at ISIS.
 
 ## Background ##
diff --git a/doc/processes/instrument_details/SANDALS-Instrument-Details.md b/doc/processes/instrument_details/SANDALS-Instrument-Details.md
@@ -1,5 +1,8 @@
 # SANDALS
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the IBEX control system on SANDALS.
 ## Background & Timeline ##
 SANDALS is a diffractometer instrument at ISIS, on TS1. The [SANDALS](https://www.isis.stfc.ac.uk/Pages/sandals.aspx) web page describes the background to the instrument.
diff --git a/doc/processes/instrument_details/SANS2D-Instrument-Details.md b/doc/processes/instrument_details/SANS2D-Instrument-Details.md
@@ -1,5 +1,8 @@
 # SANS2D
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the IBEX control system on SANS2D.
 ## Background & Timeline ##
 SANS2D is a Time-of-Flight Small-Angle Neutron Scattering instrument, on TS2. The [SANS2D](https://www.isis.stfc.ac.uk/Pages/SANS2D.aspx) web page describes the background to the instrument.  Information about the [construction of SANS2D](https://stfc365.sharepoint.com/sites/ISISProjects-Archive/TS2%20Construction/Forms/AllItems.aspx?FolderCTID=0x012000B3C16B2D4C3C4D48AAFC5C89840FE109&id=%2Fsites%2FISISProjects%2DArchive%2FTS2%20Construction%2FInstruments%20%28WBS%208%2E0%29%2FSANS2D), which is useful background for understanding the operation of the instrument, is also available.
diff --git a/doc/processes/instrument_details/SURF-Instrument-Details.md b/doc/processes/instrument_details/SURF-Instrument-Details.md
@@ -1,5 +1,8 @@
 # SURF
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the IBEX control system on SURF.
 ## Background & Timeline ##
 SURF is a reflectometer on TS1, used primarily for liquid interface research. The [SURF](https://www.isis.stfc.ac.uk/Pages/SURF.aspx) web page describes the background to the instrument.
diff --git a/doc/processes/instrument_details/SXD-Instrument-Details.md b/doc/processes/instrument_details/SXD-Instrument-Details.md
@@ -1,5 +1,8 @@
 # SXD
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the IBEX control system on SXD.
 ## Background & Timeline ##
 SXD is a Single Crystal Diffractometer, on TS1, which uses the time-of-flight techniques. The [SXD](https://www.isis.stfc.ac.uk/Pages/SXD.aspx) web page describes the background to the instrument.
diff --git a/doc/processes/instrument_details/TOSCA-Instrument-Details.md b/doc/processes/instrument_details/TOSCA-Instrument-Details.md
@@ -1,5 +1,8 @@
 # TOSCA
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the IBEX control system on TOSCA.
 ## Background & Timeline ##
 TOSCA is an indirect geometry spectrometer, on TS1. The [TOSCA](https://www.isis.stfc.ac.uk/Pages/TOSCA.aspx) web page describes the background to the instrument.
diff --git a/doc/processes/instrument_details/VESUVIO-Instrument-Details.md b/doc/processes/instrument_details/VESUVIO-Instrument-Details.md
@@ -1,5 +1,8 @@
 # VESUVIO
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the new control system on VESUVIO.
 ## Background & Timeline ##
 VESUVIO (previously known as EVS) is a long established instrument at ISIS, on TS1. The [VESUVIO](http://www.isis.stfc.ac.uk/instruments/vesuvio/) web page describes the background to the instrument.  An image of VESUVIO is shown in ​[this diagram](http://www.isis.stfc.ac.uk/instruments/vesuvio/vesuvio-configuration6163.jpg).<br>
diff --git a/doc/processes/instrument_details/WISH-Instrument-Details.md b/doc/processes/instrument_details/WISH-Instrument-Details.md
@@ -1,5 +1,8 @@
 # WISH
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the IBEX control system on WISH.
 ## Background & Timeline ##
 WISH is a long-wavelength diffractometer, on TS2. The [WISH](https://www.isis.stfc.ac.uk/Pages/WISH.aspx) web page describes the background to the instrument.
diff --git a/doc/processes/instrument_details/ZOOM-Instrument-Details.md b/doc/processes/instrument_details/ZOOM-Instrument-Details.md
@@ -1,5 +1,8 @@
 # ZOOM
 
+```{include} migration_notes_warning.mdinc
+```
+
 This page collects information that will be useful for the implementation of the new control system on ZOOM.
 ## Background & Timeline ##
 The [ZOOM](http://www.isis.stfc.ac.uk/instruments/zoom/zoom8060.html) web page describes the background to the instrument. Additional material is also available on the [ZOOM sharepoint](https://stfc365.sharepoint.com/sites/ISISProjects-1015/ZOOM/Forms/AllItems.aspx).  ZOOM is expected to have 36 motion axes.
diff --git a/doc/processes/instrument_details/migration_notes_warning.mdinc b/doc/processes/instrument_details/migration_notes_warning.mdinc
@@ -0,0 +1,5 @@
+```{warning}
+These instrument details pages provide historical context about the devices on a specific instrument,
+at the time they were migrated to IBEX. **These pages may not be up to date with the latest instrument
+configuration.**
+```
