Project Documentation Future State Report

SITCOMTN-014

This document is a report on the recommended future state and organization of Rubin Construction Documentation. This will constitute the planned technical documentation package delivered from the Construction Project to Operation as part of the criteria for construction completeness.

Links

• Live drafts: https://sitcomtn-014.lsst.io
• GitHub: https://github.com/lsst-sitcom/sitcomtn-014

Build

This repository includes lsst-texmf as a Git submodule. Clone this repository:

git clone --recurse-submodules https://github.com/lsst-sitcom/sitcomtn-014

Compile the PDF:

make

Clean built files:

make clean

Updating acronyms

A table of the technote's acronyms and their definitions are maintained in the acronyms.tex file, which is committed as part of this repository. To update the acronyms table in acronyms.tex:

make acronyms.tex

Note: this command requires that this repository was cloned as a submodule.

The acronyms discovery code scans the LaTeX source for probable acronyms. You can ensure that certain strings aren't treated as acronyms by adding them to the skipacronyms.txt file.

The lsst-texmf repository centrally maintains definitions for LSST acronyms. You can also add new acronym definitions, or override the definitions of acronyms, by editing the myacronyms.txt file.

Updating lsst-texmf

lsst-texmf includes BibTeX files, the lsstdoc class file, and acronym definitions, among other essential tooling for LSST's LaTeX documentation projects. To update to a newer version of lsst-texmf, you can update the submodule in this repository:

git submodule update --init --recursive

Commit, then push, the updated submodule.