Consolidate and improve documentation
We need to improve our documentation. We know there are several components of documentation: see e.g.,
https://documentation.divio.com
-
Step 1: Figure out where our documentation is
Existing docs:
- GstLAL O3 Online: https://ldas-jobs.ligo.caltech.edu/~gstlalcbc/doc.html
- Source: https://docs.google.com/document/u/1/d/e/2PACX-1vS1014eAe587cIVnoP_KcsaSYxCa6BH0i_w489jBW4sErrAwv3glZI3Gj7wJAWcrfo6xHA-vCyuH_dP/pub?urp=gmail_link&gxids=7757#h.n8pcsdk1dn6k or https://docs.google.com/document/d/1ueap7Gj7x8qLmcdjumtbwZ_ue_kWocc3PRBrQtiBwQY/edit?skip_itp2_check=true#heading=h.q1zeppegd1qe
- Gitlab docs: https://lscsoft.docs.ligo.org/gstlal/
- https://git.ligo.org/gstlal/osg-workflow#osg-workflow
- https://git.ligo.org/gstlal/online-analysis#quickstart
- https://dcc.ligo.org/cgi-bin/private/DocDB/Search?.submit=Title&titlesearch=gstlal&titlesearchmode=allsub
- https://git.ligo.org/lscsoft/gstlal/-/blob/master/README.md
- https://arxiv.org/abs/2010.05082
- https://wiki.ligo.org/Computing/DASWG/GstLAL
Operational : git.ligo.org/gstlal ???
-
Step 2: Figure out our local community's highest needs - Want a working gstlal installation (support containers, conda, src, something for everyone). This boils down to: does this work: https://lscsoft.docs.ligo.org/gstlal/installation.html
- Want to know how to use the software for real stuff
- PSD generation
- frame generation (recoloring, add injections, etc)
- SVD/template bank generation
- mass models/dtdphi
- event followup
- offline CBC analysis (filtering/rerank/injection runs)
- generate segments/vetoes
- data discovery/access for data products (e.g. how to get all triggers from run below some FAR threshold)
- write gstreamer pipelines
- plotting
- We want to nurture a culture of contribution.
- Developer documentation
- should have lower level tutorials that can help with development
- How to setup an effective and successful development lifestyle
- How to debug? (should gather e.g., gstreamer debug stuff)
- Add logging support throughout the code
- Developer documentation