About the technical documentation portal
Purpose
The goal of this documentation portal is to help you access and discover the Rubin Observatory’s public technical documentation. This portal is available to everyone: the observatory team, the astronomy community, and the general public.
Although there may be some public technical documentation that is not yet available through this search portal, we index all our technote document series, and are adding new sources all the time. See the content coverage table, below for details.
Documentation that isn’t public is beyond the scope of this portal. Observatory team members should log into individual platforms to find non-public information, such as DocuShare, Jira, Confluence, or the Project homepage.
Content coverage
Content types are added systematically as we develop our content indexer, Ook. The following table summarizes the types of content that are currently available through the portal, along with content types that we anticipate adding in the future.
| Content type | Search [1] | Browse [2] | |
|---|---|---|---|
| Documents | Technical notes on lsst.io — LaTeX | Yes | Yes |
| Technical notes on lsst.io — rst format | Yes | Yes | |
| DMTR — lsst.io | Yes | Yes | |
| DMTR — DocuShare (public) | |||
| LDM — lsst.io | Yes | Yes | |
| LDM — DocuShare (public) | |||
| LPM — lsst.io | Yes | Yes | |
| LPM — DocuShare (public) | |||
| LSE — lsst.io | Yes | Yes | |
| LSE — DocuShare (public) | |||
| Zenodo — lsst-dm community | |||
| Guides | Sphinx-based guides — lsst.io | Yes | |
| Discussions | Community forum (public) | ||
| DM RFC (public) | |||
| Software | GitHub repositories | ||
| Misc. | Glossary terms | ||
| [1] “Search” means the full text content is searchable from the Advanced search page. | |||
| [2] “Browse” means the entity is linked from a page on this portal. | |||