This technote explores how JSON-LD (Linked Data) can be used to describe a variety of LSST project artifacts, including source code and documents. We provide specific examples using standard vocabularies (http://schema.org and CodeMeta) and explore whether custom terms are needed to support LSST use cases.
Links:
- Publication URL: https://sqr-020.lsst.io
- Alternative editions: https://sqr-020.lsst.io/v
- GitHub repository: https://github.com/lsst-sqre/sqr-020
- Build system: https://travis-ci.org/lsst-sqre/sqr-020
You can clone this repository and build the technote locally with Sphinx:
git clone https://github.com/lsst-sqre/sqr-020
cd sqr-020
pip install -r requirements.txt
make htmlNote
In a Conda environment, pip install -r requirements.txt doesn't work as expected.
Instead, pip install the packages listed in requirements.txt individually.
The built technote is located at _build/html/index.html.
You can edit the index.rst file, which is a reStructuredText document.
The DM reStructuredText Style Guide is a good resource for how we write reStructuredText.
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-020.lsst.io will be automatically rebuilt whenever you push your changes to the master branch on GitHub.
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.
The bibliography files in lsstbib/ are copies from lsst-texmf.
You can update them to the current lsst-texmf versions with:
make refresh-bib
Add new bibliography items to the local.bib file in the root directory (and later add them to lsst-texmf).
Copyright 2018 AURA/LSST
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/.