Change section headings in templates

lsst-ts · May 12, 2024 · 071cc6b · 071cc6b
1 parent 110e18e
commit 071cc6b
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 21 deletions.
diff --git a/project/Templates/informative-template.rst b/project/Templates/informative-template.rst
@@ -30,29 +30,29 @@ Informative Template
 .. _Informative-Document-Overview:
 
 Overview
-^^^^^^^^
+========
 
 .. This section should provide a brief, top-level description of the document's purpose and utilization. 
 
 .. _Informative-Document-Main-Information-Section:
 
 Main Information Section
-^^^^^^^^^^^^^^^^^^^^^^^
+========================
 
 .. todo::
    Include utilization of admonishments (caution, warning, etc.)
 
 Present the information for this document. 
 Include links or further resources for additional follow-up.  
-Find additional examples of formatting on `this page <https://developer.lsst.io/v/DM-5063/docs/rst_styleguide.html>`__ or on the list of links of the `documentation style guide <https://obs-ops.lsst.io/project/contributing.html#contributing-doc-style-guide>`__. 
+Find additional examples of formatting on the list of links of the `documentation style guide <https://obs-ops.lsst.io/project/contributing.html#contributing-doc-style-guide>`__. 
 
 .. warning::
     Keep this in mind when referring to this information. 
 
 .. _Informative-Document-Main-Information-Section-Subsection-One:
 
 Subsection One
-==============
+--------------
 
 1. numbers
 
@@ -77,14 +77,14 @@ i. lower-case roman numerals
 .. _Informative-Document-Main-Information-Section-Subsection-Two:
 
 Subsection Two
-==============
+--------------
 
 This is an example of a subsection. 
 
 .. _Informative-Document-Main-Information-Section-Subsection-Two-Subsubsection:
 
 Subsubsection
--------------
+^^^^^^^^^^^^^
 
 This is an example of a sub-subsection. 
 

diff --git a/project/Templates/procedure-template.rst b/project/Templates/procedure-template.rst
@@ -30,7 +30,7 @@ Procedure Template
 .. _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.
 
@@ -39,7 +39,7 @@ This is a template for a procedure. It is performed by authorized and trained us
 .. _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.
@@ -55,7 +55,7 @@ Precondition
 .. _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.
@@ -68,7 +68,7 @@ Post-Condition
 .. _Title-of-Procedure-Procedure-Steps:
 
 Procedure Steps
-^^^^^^^^^^^^^^^
+===============
 
 .. todo::
    Include utilization of admonishments (caution, warning, etc.)
@@ -126,7 +126,7 @@ This is an example of a sub-section, used when Condition B applied. Complete the
 .. _Title-of-Procedure-Troubleshooting:
 
 Troubleshooting
-^^^^^^^^^^^^^^^
+===============
 
 .. This section should include troubleshooting information. Information in this section should be strictly related to this procedure.
 

diff --git a/project/Templates/troubleshooting-template.rst b/project/Templates/troubleshooting-template.rst
@@ -30,7 +30,7 @@ Troubleshooting Template
 .. _Title-of-Troubleshooting-Procedure-Overview:
 
 Overview
-^^^^^^^^
+========
 
 .. In one or two sentences, explain when this troubleshooting procedure needs to be used. Describe the symptoms that the user sees to use this procedure. 
 
@@ -39,7 +39,7 @@ This is a template for a troubleshooting procedure. It is performed by authorize
 .. _Title-of-Troubleshooting-Procedure-Error-Diagnosis:
 
 Error diagnosis
-^^^^^^^^^^^^^^^
+===============
 
 .. This section should provide simple overview of known or suspected causes for the error.
 .. It is preferred to include them as a bulleted or enumerated list.
@@ -50,7 +50,7 @@ Error diagnosis
 .. _Title-of-Troubleshooting-Procedure-Procedure-Steps:
 
 Procedure Steps
-^^^^^^^^^^^^^^^
+===============
 
 .. todo::
    Make sure everything is in a safe or idle state before troubleshooting. Describe relevant safety steps if necessary.
@@ -108,7 +108,7 @@ This is an example of a sub-section, used when Condition B applied. Complete the
 .. _Title-of-Troubleshooting-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.
@@ -121,6 +121,6 @@ Post-Condition
 .. _Title-of-Troubleshooting-Procedure-Contingency:
 
 Contingency
-^^^^^^^^^^^
+===========
 
 If the procedure was not successful, report the issue in [relevant Slack channel] and/or activate the :ref:`Out of hours support <Safety-out-of-hours-support>`.
diff --git a/project/Templates/tutorial-template.rst b/project/Templates/tutorial-template.rst
@@ -35,7 +35,7 @@ Tutorial Template
 .. _Title-of-Tutorial-Overview:
 
 Overview
-^^^^^^^^
+========
 
 .. This section should provide a brief, top-level description of the tutorial's purpose and utilization. Consider including the expected user and when the procedure will be performed.
 
@@ -44,7 +44,7 @@ This is a template for a tutorial.
 .. _Title-of-Tutorial-Prerequisites:
 
 Prerequisites
-^^^^^^^^^^^^^
+=============
 
 .. This section should provide simple overview of prerequisites for using the tutorial.
 .. It is preferred to include them as a bulleted or enumerated list.
@@ -59,7 +59,7 @@ This section should list the prerequisites (e.g. required conditions) to perform
 .. _Title-of-Tutorial-Post-Condition:
 
 Post-Condition
-^^^^^^^^^^^^^^
+==============
 
 .. This section should provide a simple overview of conditions or results after using the tutorial.
 
@@ -72,7 +72,7 @@ This section describes the state of the system after performing the tutorial. If
 .. _Title-of-Tutorial-Tutorial-Steps:
 
 Tutorial Steps
-^^^^^^^^^^^^^^^
+==============
 
 .. This section should include the tutorial steps.
 .. In the case of more complicated tutorials, more sophisticated methodologies may be appropriate, such as multiple section headings or a list of linked tutorials to be performed in the specified order.
@@ -93,7 +93,7 @@ In the case of more complicated tutorials, more sophisticated methodologies may
 .. _Title-of-Tutorial-Troubleshooting:
 
 Troubleshooting
-^^^^^^^^^^^^^^^
+===============
 
 .. This section should include troubleshooting information.