Technotes for Stand-Alone Technical Documentation¶
Technotes are a way for Data Management team members to write standalone documents that are native to the web, can be cited in literature, and are easy to write, publish, and update. You can write with either our reStructuredText or LaTeX templates. All technotes are developed on GitHub and published with LSST the Docs.
When to write technotes¶
Some of the possible applications for technotes are:
- Report the results of a project, such as a data processing or software development experiment.
- Announce a new technology, serving as a high-level overview complementing user documentation.
- Propose an architecture, possibly becoming the subject of a request for comment (RFC).
For further background, see SQR-000: The LSST DM Technical Note Publishing Platform.
Technotes are not always the right platform for your information. Consider these alternatives:
- Change-controlled documentation (
LDMdocuments, for example). See LPM-19 for guidelines on what kinds of information are change-controlled.
- User documentation (https://pipelines.lsst.io, for example). Descriptions of how to use software, services, or data should be written as user documentation. Technotes complement user documentation by being point-in-time discussions of software, like a technical blog post.
- Data Management Technical Notes (DMTN). This is the general purpose technote series for the DM team. DMTN technotes are hosted in the https://github.com/lsst-dm organization. Find DMTN technotes.
- SQuaRE Technical Notes (SQR). This series is for technotes about SQuaRE products and services. SQR technotes are hosted in the https://github.com/lsst-sqre organization. Find SQR technotes.
- Simulations Technical Notes (SMTN) This series is for technotes by the LSST Simulations team. SMTN technotes are hosted in the https://github.com/lsst-sims organization. Find SMTN technotes.
Create a technote¶
Follow these steps to create a new technote:
Identify the next-available technote handle in the series you are creating a technote for. You can do this by searching the series’s GitHub organization.
For example, to identify the next-available DMTN repository, search the lsst-dm organization:
For discussion, the highest-numbered repository in the search result might be
https://github.com/lsst-dm/dmtn-100. Try to go to the next repository,
- If the page is a 404 (Not Found), that URL corresponds to the next-available repository.
- If the page exists, keep incrementing the serial number in the URL until you find a page that is unavailable (try visiting
https://github.com/lsst-dm/dmtn-103, and so on).
Create a GitHub repository in the GitHub organization corresponding to the handle you identified in the previous step.
On your local computer, create an empty Git repository:
mkdir <technote handle> cd <technote handle> git init .
Seed the local Git repository with a template. Which template you use depends on the technote’s format:
- If you are creating a reStructuredText-based technote that is built with Sphinx into HTML, follow the instructions in lsst-technote-bootstrap.
- If you are creating a LaTeX-formatted technote that is built into a PDF, follow the lsst-texmf documentation
Be sure to commit and push the new technote to GitHub. GitHub provides instructions on how to push to GitHub when you create a new GitHub repository.
Message the #dm-docs Slack channel so that the Travis integration for your technote can be activated.
Don’t wait to configure your document’s deployment. By configuring your technote’s deployment early on, it’s easier for collaborators to view your content.
Using bibliographies in reStructuredText technotes¶
The lsst-texmf project includes shared BibTeX bibliographic databases. You can also use these bibliographies from reStructuredText technotes.
First, add or uncomment the
bibliography directive at the bottom of your technote’s
.. bibliography:: local.bib lsstbib/books.bib lsstbib/lsst.bib lsstbib/lsst-dm.bib lsstbib/refs.bib lsstbib/refs_ads.bib :style: lsst_aa
Only include the
local.bib file if your technote’s repository has one.
local.bib to temporarily store bib items before you permanently transfer them to the lsst-texmf project.
The bibliographies in the
lsstbib directory are copies from the https://github.com/lsst/lsst-texmf repository.
Refresh the copies maintained in your technote’s repository by running this command:
To make citations in the technote’s text, use the
In-text citations are numbered, not author-year style.
Editing metadata in reStructuredText technotes¶
ReStructuredText-format technotes use a
metadata.yaml in their repositories to describe attributes like the document’s title, author list, and abstract.
To change the technote’s title or author list, for example, commit a change to the
See the comments in
metadata.yaml for a description of these fields.