diff --git a/MainTel/MainTel-Non-standard-Operations/MTM2-Non-standard-Procedures/MTM2-Non-standard-Procedures-index.rst b/MainTel/MainTel-Non-standard-Operations/MTM2-Non-standard-Procedures/MTM2-Non-standard-Procedures-index.rst new file mode 100644 index 00000000..de903b4f --- /dev/null +++ b/MainTel/MainTel-Non-standard-Operations/MTM2-Non-standard-Procedures/MTM2-Non-standard-Procedures-index.rst @@ -0,0 +1,12 @@ +.. MainTel-Non-standard-Operations-MTM2-Non-Standard-Procedures: + +############################## +MTM2 Non-standard procedures +############################## + +.. toctree:: + :maxdepth: 3 + :titlesonly: + :glob: + + * \ No newline at end of file diff --git a/MainTel/MainTel-Non-standard-Operations/MTM2-Non-standard-Procedures/Power-cycle-MTM2-cabinet.rst b/MainTel/MainTel-Non-standard-Operations/MTM2-Non-standard-Procedures/Power-cycle-MTM2-cabinet.rst new file mode 100644 index 00000000..dcf23bee --- /dev/null +++ b/MainTel/MainTel-Non-standard-Operations/MTM2-Non-standard-Procedures/Power-cycle-MTM2-cabinet.rst @@ -0,0 +1,137 @@ +.. This is a template for operational procedures. Each procedure will have its own sub-directory. This comment may be deleted when the template is copied to the destination. + +.. Review the README in this procedure's directory on instructions to contribute. +.. Static objects, such as figures, should be stored in the _static directory. Review the _static/README in this procedure's directory on instructions to contribute. +.. Do not remove the comments that describe each section. They are included to provide guidance to contributors. +.. Do not remove other content provided in the templates, such as a section. Instead, comment out the content and include comments to explain the situation. For example: + - If a section within the template is not needed, comment out the section title and label reference. Include a comment explaining why this is not required. + - If a file cannot include a title (surrounded by ampersands (#)), comment out the title from the template and include a comment explaining why this is implemented (in addition to applying the ``title`` directive). + +.. Include one Primary Author and list of Contributors (comma separated) between the asterisks (*): +.. |author| replace:: *Name-of-Primary-Author* +.. If there are no contributors, write "none" between the asterisks. Do not remove the substitution. +.. |contributors| replace:: *List-of-contributors* + +.. 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-Procedure: +.. 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 `. +.. An error will alert you of identical labels during the build process. + +################### +Power Cycle MTM2 cabinet +################### + +.. note:: + This is a procedure template file that is associated with a template directory structure. This note should be deleted when the section is properly populated. + +.. _Title-of-Procedure-Overview: + +Overview +======== + +.. This section should provide a brief, top-level description of the procedure's purpose and utilization. Consider including the expected user and when the procedure will be performed. + +This is a template for a procedure. It is performed by authorized and trained users. + +.. _Title-of-Procedure-Precondition: + +Precondition +============ + +.. This section should provide simple overview of preconditions before executing the procedure; for example, state of equipment, telescope or seeing conditions or notifications prior to execution. +.. It is preferred to include them as a bulleted or enumerated list. +.. If there is a different procedure that is critical before execution, carefully consider if it should be linked within this section or as part of the Procedure section below (or both). + +- This is an example bullet of a precondition (Telescope azimuth must be at 0 degrees.) + + - This is an example describing an exception (If the dome is closed, telescope elevation position is not important.) + +- This is another example bullet of a precondition (Notification to specified SLACK channel.) +- This example refers to a required action at the beginning of the procedure (It is critical the correct status of the equipment. This will be verified during :ref:`a critical step ` in the procedure.) + +.. _Title-of-Procedure-Post-Condition: + +Post-Condition +============== + +.. This section should provide a simple overview of conditions or results after executing the procedure; for example, state of equipment or resulting data products. +.. It is preferred to include them as a bulleted or enumerated list. +.. Please provide screenshots of the software status or relevant display windows to confirm. +.. Do not include actions in this section. Any action by the user should be included in the end of the Procedure section below. For example: Do not include "Verify the telescope azimuth is 0 degrees with the appropriate command." Instead, include this statement as the final step of the procedure, and include "Telescope is at 0 degrees." in the Post-condition section. + +- This is an example bullet of a post-condition (Telescope azimuth is 0 degrees.) +- This is another example of a post-condition (This procedure leaves the telescope with the E-stop activated.) + +.. _Title-of-Procedure-Procedure-Steps: + +Procedure Steps +=============== + +.. todo:: + Include utilization of admonishments (caution, warning, etc.) + +.. This section should include the procedure. There is no strict formatting or structure required for procedures. It is left to the authors to decide which format and structure is most relevant. +.. In the case of more complicated procedures, more sophisticated methodologies may be appropriate, such as multiple section headings or a list of linked procedures to be performed in the specified order. +.. For highly complicated procedures, consider breaking them into separate procedure. Some options are a high-level procedure with links, separating into smaller procedures or utilizing the reST ``include`` directive . + +This paragraph describes some general guidance for this procedure. This paragraph is optional depending on its usefulness and the complexity of the procedure. + +In the case of a very straightforward procedure, a simple numbered list could be used, like as follows: + +.. warning:: + For this example, this step is critical. + +.. _Title-of-Procedure-Critical-Step-1: + +#. This is Step 1 in a enumerated list. It happens to be very important. + +#. This is Step 2. + +#. This is step 3. + +#. Step 4 has two branches, but Step 5 is independent of Step 4. + + a. If Condition A, do the following action in :ref:`Condition A Instructions `. + + b. If Condition B, do the following action in :ref:`Condition B instructions `. + + .. _Title-of-Procedure-Final-Step: + +#. Complete the procedure's final step. + + +.. _Title-of-Procedure-Condition-A-for-Step-4: + +Condition A for Step 4 +---------------------- + +This is an example of a sub-section, used when Condition A applied. Complete the steps in this section: + +#. Step 1 for Condition A. +#. Return to :ref:`Step 5 ` in the section above. + +.. _Title-of-Procedure-Condition-B-for-Step-4: + +Condition B for Step 4 +---------------------- + +This is an example of a sub-section, used when Condition B applied. Complete the steps in this section: + +#. Step 1 for Condition B. +#. Return to :ref:`Step 5 ` in the section above. + +.. _Title-of-Procedure-Troubleshooting: + +Troubleshooting +=============== + +.. This section should include troubleshooting information. Information in this section should be strictly related to this procedure. + +.. If there is no content for this section, remove the indentation on the following line instead of deleting this sub-section. + + No troubleshooting information is applicable to this procedure. + +- This is an example bullet (If the following error is given during :ref:`Step 5 `, resolve it using a specified action.) \ No newline at end of file