lsst-sqre / sqr-013

LSST DocHub Design

SQR-013: LSST DocHub Design

Research and design of a JSON-LD-based metadata database and API for LSST code and documentation repositories.

View this technote at https://sqr-013.lsst.io.

Build this technical note

You can clone this repository and build the technote locally with Sphinx

git clone https://github.com/lsst-sqre/sqr-013
cd sqr-013
pip install -r requirements.txt
make html

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

Editing this technical note

You can edit the index.rst file, which is a reStructuredText document. A good primer on reStructuredText is available at http://docs.lsst.codes/en/latest/development/docs/rst_styleguide.html

Remember that images and other types of assets should be stored in the _static/ directory of this repository. See _static/README.rst for more information.

The published technote at https://sqr-013.lsst.io will be automatically rebuilt whenever you push your changes to the master branch on GitHub.

Updating metadata

This technote's metadata is maintained in metadata.yaml. In this metadata you can edit the technote's title, authors, publication date, etc.. metadata.yaml is self-documenting with inline comments.

---

Copyright 2016 Association of Universities for Research in Astronomy Inc.

This work is licensed under the Creative Commons Attribution 4.0 International License. To view a copy of this license, visit http://creativecommons.org/licenses/by/4.0/.