Skip to content

Commit

Permalink
Really fix the labels
Browse files Browse the repository at this point in the history
  • Loading branch information
JackieS-NL committed May 30, 2024
1 parent 71d6844 commit 58e3a12
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 13 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,8 @@

.. This is the label that can be used as for cross referencing this procedure.
.. Recommended format is "Directory Name"-"Title Name" -- Spaces should be replaced by hyphens.
.. _Templates-Title-of-Troubleshooting-Procedure:
.. _LATISS-Troubleshooting-ATcamera-recovery:

.. Each section should includes a label for cross referencing to a given area.
.. Recommended format for all labels is "Title Name"-"Section Name" -- Spaces should be replaced by hyphens.
.. To reference a label that isn't associated with an reST object such as a title or figure, you must include the link an explicit title using the syntax :ref:`link text <label-name>`.
Expand All @@ -25,7 +26,7 @@ AT camera recovery
#########################


.. _Overview:
.. _ATcamera-recovery/Overview:

Overview
========
Expand Down Expand Up @@ -54,7 +55,7 @@ but is more general than that specific incident.
We need a separate document to provide this background information since it will need to be referred to from multiple places.

This comment has been minimized.

Copy link
@kaubel

kaubel Jun 3, 2024

Contributor

Very good overview.


.. _Error-Diagnosis:
.. _ATcamera-recovery/Error-Diagnosis:

Error diagnosis
===============
Expand All @@ -66,7 +67,7 @@ Error diagnosis
.. Added error diagnosis
- ATCamera goes to `FAULT` state.

This comment has been minimized.

Copy link
@kaubel

kaubel Jun 3, 2024

Contributor

Maybe it would helpful to have a photo of the CSC, a LOVE view of it, specially considering the next step in procedure...

.. _Procedure-Steps:
.. _ATcamera-recovery/Procedure-Steps:

Procedure Steps
===============
Expand All @@ -88,7 +89,7 @@ Procedure Steps
Specific CCS commands for performing these operations are documented below.


.. _Tracking-down-a-CSC-problem:
.. _ATcamera-recovery/Tracking-down-a-CSC-problem:

Tracking down a CSC problem
--------------------------------
Expand Down Expand Up @@ -135,7 +136,7 @@ Currently we describe only the first approach.
ats-ocs-bridge clearFault
ats-ocs-bridge setAvailable
.. _Post-Condition:
.. _ATcamera-recovery/Post-Condition:

Post-Condition
==============
Expand All @@ -148,7 +149,7 @@ Post-Condition
- AT Camera can now be set to the `ENABLED` state.


.. _Contingency:
.. _ATcamera-recovery/Contingency:

Contingency
===========
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

.. This is the label that can be used as for cross referencing this procedure.
.. Recommended format is "Directory Name"-"Title Name" -- Spaces should be replaced by hyphens.
.. _Templates-Title-of-Troubleshooting-Procedure:
.. _LATISS-Troubleshooting-ATspectrograph-failed:
.. Each section should includes a label for cross referencing to a given area.
.. Recommended format for all labels is "Title Name"-"Section Name" -- Spaces should be replaced by hyphens.
.. To reference a label that isn't associated with an reST object such as a title or figure, you must include the link an explicit title using the syntax :ref:`link text <label-name>`.
Expand All @@ -24,7 +24,7 @@
ATSpectrograph failed - grating stage position and timed out
####################################################################################################

.. _Overview:
.. _ATspectrograph-failed/Overview:

Overview
========
Expand All @@ -33,7 +33,7 @@ Overview
ATspectrograph failed during ``latiss_checkout`` after the power cut off due to the UPS failure issue at AuxTel on November 2023. We have seen this error after hard resets of the ATSpectrograph.

.. _Error-Diagnosis:
.. _ATspectrograph-failed/Error-Diagnosis:

Error diagnosis
===============
Expand Down Expand Up @@ -76,7 +76,7 @@ Error diagnosis
in next_ackcmd raise base.AckTimeoutError( lsst.ts.salobj.base.AckTimeoutError: msg='Timed out waiting for command acknowledgement',
ackcmd=(ackcmd private_seqNum=1137560160, ack=<SalRetCode.CMD_NOACK: -301>, error=0, result='No command acknowledgement seen')
.. _Procedure-Steps:
.. _ATspectrograph-failed/Procedure-Steps:

Procedure Steps
===============
Expand Down Expand Up @@ -127,7 +127,7 @@ Procedure Steps
.. _Post-Condition:
.. _ATspectrograph-failed/Post-Condition:

Post-Condition
==============
Expand All @@ -139,7 +139,7 @@ Post-Condition
- The AT Spectrograph's encoder has been cleared and is now in the home position, near 0 nm.

.. _Contingency:
.. _ATspectrograph-failed/Contingency:

Contingency
===========
Expand Down

0 comments on commit 58e3a12

Please sign in to comment.