1. Overview
  2. Deployment
  3. Monitoring
  4. Maintaining
  5. Common Errors and Known Solutions
  6. Features
  7. Extinction Model and Burn-in
  8. Scientific Results
  9. Low-Latency Injections
  10. References
  11. Template Banks
  12. Pastro
  13. Offline Analysis
  14. Offline Filtering Rota
  15. Offline Rota
  16. Dropped data filtering
  17. Offline SNR Optimizer/Coinc generation
  18. MDC Documentation
  19. How to contribute to this documentation
  20. Diagrams

  1. Overview
  2. Deployment
  3. Monitoring
  4. Maintaining
  5. Common Errors and Known Solutions
  6. Features
  7. Extinction Model and Burn-in
  8. Scientific Results
  9. Low-Latency Injections
  10. References
  11. Template Banks
  12. Pastro
  13. Offline Analysis
  14. Offline Filtering Rota
  15. Offline Rota
  16. Dropped data filtering
  17. Offline SNR Optimizer/Coinc generation
  18. MDC Documentation
  19. How to contribute to this documentation
  20. Diagrams

Online Operations Manual

Table of Contents


How to contribute GWSCI content

Here is a quick reference for how to contribute to documentation in this site

Getting setup to develop locally

$ cd gwsci
$ hugo serve
Start building sites … 

                   | EN  
-------------------+-----
  Pages            | 27  
  Paginator pages  |  0  
  Non-page files   |  0  
  Static files     | 53  
  Processed images |  0  
  Aliases          |  0  
  Sitemaps         |  1  
  Cleaned          |  0  

Built in 99 ms
Watching for changes in /Users/channa/git/gwsci-site/gwsci/{archetypes,content,data,layouts,static,themes}
Watching for config changes in /Users/channa/git/gwsci-site/gwsci/config.yaml
Environment: "development"
Serving pages from memory
Running in Fast Render Mode. For full rebuilds on change: hugo server --disableFastRender
Web Server is available at http://localhost:1313/ (bind address 127.0.0.1)
Press Ctrl+C to stop
  • Navigate to http://localhost:1313/ in your browser and you should see a site that automatically updates as you make changes to the content

Contributing to the online analysis operations manual

The online analysis operations manual is here in the git repo tree: https://git.ligo.org/chad-hanna/gwsci-site/-/tree/main/gwsci/content/ops

For the most part you can just modify the existing markdown files, but there are execptions.

Adding a new page and changing the sidebar table of contents

You can make a new markdown file in this directory, but to make it show up in the sidebar navigation you have to add it here: https://git.ligo.org/chad-hanna/gwsci-site/-/blob/main/gwsci/data/ops.yaml

For example, the diff to create the page you are looking at looks like this:

diff --git a/gwsci/data/ops.yaml b/gwsci/data/ops.yaml
index 663ea82..831fb86 100644
--- a/gwsci/data/ops.yaml
+++ b/gwsci/data/ops.yaml
@@ -19,3 +19,6 @@
 - title: "References"
   url: ops/references
   tag: references
+- title: "How to contribute to this documentation"
+  url: ops/howtodoc
+  tag: howtodoc

pages with complicated HTML templating

NOTE: this actual HTML template is a bit of a mess at the moment and needs to be improved

The “index” page of the operations manual is a good example of a complicated HTML template to support fancy layouts of the pipeline diagram, e.g., here: https://git.ligo.org/chad-hanna/gwsci-site/-/blob/main/gwsci/data/overview.yaml which is rendered by the following HTML template: https://git.ligo.org/chad-hanna/gwsci-site/-/blob/main/gwsci/layouts/ops/overview.html