Tox helps with docs

lsst-dm · Nov 18, 2024 · 82521b5 · 82521b5
1 parent 893e4ac
commit 82521b5
Show file tree

Hide file tree

Showing 4 changed files with 53 additions and 52 deletions.
diff --git a/doc/operator-guide/deployment.rst b/doc/operator-guide/deployment.rst
@@ -5,38 +5,38 @@ Deployment
 Database
 ========
 
-    Deployments of the Consolidated Database are currently located at
+  - Deployments of the Consolidated Database are currently located at
 
-      -  Summit
-      -  USDF (+ dev, use the same underlying database, a replication of Summit)
-      -  Base Test Stand (BTS)
-      -  Tucson Test Stand (TTS)
+    -  Summit
+    -  USDF (+ dev, use the same underlying database, a replication of Summit)
+    -  Base Test Stand (BTS)
+    -  Tucson Test Stand (TTS)
 
-    Updates to these deployments may be needed when there are edits to the schema for any of the cdb_* tables defined in <link to> sdm_schemas.
+  - Updates to these deployments may be needed when there are edits to the schema for any of the cdb_* tables defined in <link to> sdm_schemas.
 
-    Tools:
-    ------
+Tools:
+------
 
-      - Argo-CD
-      - LOVE
-      - felis
+  - Argo-CD
+  - LOVE
+  - Felis
 
-    Repositories:
-    -------------
+Repositories:
+-------------
 
-        - Phalanx
-        - sdm_schemas
-        - consdb
+    - ``phalanx`` (https://github.com/lsst-sqre/phalanx)
+    - ``sdm_schemas`` (https://github.com/lsst/sdm_schemas)
+    - ``consdb`` (https://github.com/lsst-dm/consdb)
 
-    Access needed:
-    --------------
+Access needed:
+--------------
 
-        - NOIRLab VPN
-        - Summit VPN
-        - USDF
+    - NOIRLab VPN
+    - Summit VPN
+    - USDF
 
-    Process:
-    --------
+Process:
+--------
 
 
 

diff --git a/doc/operator-guide/monitoring.rst b/doc/operator-guide/monitoring.rst
@@ -23,7 +23,8 @@ REST API Server
   - Use the appropriate argo-cd deployment graph to check deployment logs, and potentially restart the service.
 
 
-  Other issues
-  ------------
+Other issues
+------------
+
   - K8s infrastructure died The ConsDB team can verify that that is the problem, but there are likely to be wider issues seen
   - USDF or Summit K8s/IT support should be responsible for fixing.
diff --git a/doc/operator-guide/runbook.rst b/doc/operator-guide/runbook.rst
@@ -12,7 +12,7 @@ This application does ...
 Its design and architecture are documented at ...
 
 Usage
-========
+=====
 
 Most users
 ----------
@@ -21,29 +21,29 @@ Administration
 --------------
 
 Architecture
-========
+============
 
 Kubernetes vclusters used
 
 Relevant policies
 
 S3DF Dependencies
---------------
+-----------------
 
 Kubernetes
 Weka storage for Kubernetes
 ...
 
 Systems
---------------
+-------
 
 Components, Kubernetes namespaces, deployments
 
 Backups
---------------
+-------
 
 Associated Systems
---------------
+------------------
 
 IAM
 ===
@@ -52,10 +52,10 @@ Requesting Access
 -----------------
 
 Key Roles
------------------
+---------
 
 Service Accounts
------------------
+----------------
 
 Network
 =======
@@ -65,22 +65,22 @@ External endpoints, IP and port, encryption, authentication, clients, API
 SLAC-internal endpoints, IP and port, encryption, authentication, clients, API
 
 Configuration
-=======
+=============
 
 GitHub repos with deployments
 
 Monitoring
-=======
+==========
 
 Grafana or other links
 
 Maintenance
-=======
+===========
 
 Periodic tasks
 
 Documentation and Training
-=======
+==========================
 
 Links to documentation and training resources
 Here: (https://consdb.lsst.io)
@@ -96,7 +96,7 @@ Overall complaints:
 Kian-Tat Lim
 
 ``consdb`` services (hinfo, pqserver):
-----------------------------------
+--------------------------------------
 
 Brian Brondel , Valerie Becker
 
@@ -109,7 +109,7 @@ Rodrigo Boufleur , Glauber Costa Vila Verde
 
 
 Known Issues
-=======
+============
 
 Standard Procedures
-=======
+===================
diff --git a/doc/user-guide/schemas.rst b/doc/user-guide/schemas.rst
@@ -4,18 +4,18 @@ Schemas
 
 Types of schemas
 ================
-    Summit for observers and Summit systems
-    ---------------------------------------
-        * Smallest, contains primary key information from HeaderService and additional information from other Summit systems, including experimental and engineering data
-
-    USDF for staff and analytical uses
-    ----------------------------------
-        * Largest, contains a full replica of the Summit plus additional information from USDF systems including Prompt Processing and Data Release Production, possibly Calibration Products Production, and human annotations from processing campaigns
-
-    Release for science users
-    -------------------------
-        * Near-real-time "prompt" ConsDB replicates a subset of the USDF version
-        * Data Release ConsDB is a snapshot of a subset of the USDF version with data pertaining to the exposures/visits in the DR
+Summit for observers and Summit systems
+---------------------------------------
+    * Smallest, contains primary key information from HeaderService and additional information from other Summit systems, including experimental and engineering data
+
+USDF for staff and analytical uses
+----------------------------------
+    * Largest, contains a full replica of the Summit plus additional information from USDF systems including Prompt Processing and Data Release Production, possibly Calibration Products Production, and human annotations from processing campaigns
+
+Release for science users
+-------------------------
+    * Near-real-time "prompt" ConsDB replicates a subset of the USDF version
+    * Data Release ConsDB is a snapshot of a subset of the USDF version with data pertaining to the exposures/visits in the DR
 
 Schema browser
 ==============