Guidelines for gated updates for SQuaRE services (including Science Platform)

SQR-056

The aim of this document is to expose the heuristics by which we consider what the appropriate process is for various types of service updates. We also describe our extant processes around Science Platform and Science Platform adjacent services, as these are likely to be of most interest to developers outside our team.

Links:

• Publication URL: https://sqr-056.lsst.io/
• Alternative editions: https://sqr-056.lsst.io/v
• GitHub repository: https://github.com/lsst-sqre/sqr-056
• Build system: https://github.com/lsst-sqre/sqr-056/actions/

Build this technical note

You can clone this repository and build the technote locally if your system has Python 3.11 or later:

git clone https://github.com/lsst-sqre/sqr-056
cd sqr-056
make init
make html

Repeat the make html command to rebuild the technote after making changes. If you need to delete any intermediate files for a clean build, run make clean.

The built technote is located at _build/html/index.html.

Publishing changes to the web

This technote is published to https://sqr-056.lsst.io/ whenever you push changes to the main branch on GitHub. When you push changes to a another branch, a preview of the technote is published to https://sqr-056.lsst.io/v.

Editing this technical note

The main content of this technote is in index.rst (a reStructuredText file). Metadata and configuration is in the technote.toml file. For guidance on creating content and information about specifying metadata and configuration, see the Documenteer documentation: https://documenteer.lsst.io/technotes.