Merge pull request #5 from lsst/draft

Rewrite LDM-148 for construction and operations

.gitignore

@@ -1 +1,10 @@
 _build
+*.aux
+*.bbl
+*.blg
+*.fdb_latexmk
+*.fls
+*.log
+*.out
+*.toc
+LDM-152.pdf

.gitmodules

@@ -0,0 +1,6 @@
+[submodule "lsst-texmf"]
+	path = lsst-texmf
+	url = https://github.com/lsst/lsst-texmf
+[submodule "images"]
+	path = images
+	url = https://github.com/lsst-dm/images

.travis.yml

@@ -1,19 +1,21 @@
-sudo: false
+sudo: true
+dist: trusty
+services:
+  - docker
 language: python
-matrix:
-  include:
-    - python: "3.5"
-      env: LTD_MASON_BUILD=true
-install:
-  - pip install -r requirements.txt
-  - pip install "ltd-mason>=0.2,<0.3"
+python:
+  - '3.5'
+before_install:
+  - "pip install 'lander>=0.1.0,<0.2'"
 script:
-  - sphinx-build -b html -a -n -d _build/doctree . _build/html
+  # Compile PDF using containerized lsst-texmf
+  - "docker run --rm -v `pwd`:/workspace -w /workspace lsstsqre/lsst-texmf:latest sh -c 'make'"
 after_success:
-  - ltd-mason-travis --html-dir _build/html
+  # Deploy website. See https://github.com/lsst-sqre/lander for CLI options
+  - "lander --pdf LDM-152.pdf --upload --lsstdoc LDM-152.tex --env=travis --ltd-product $PRODUCT"
 env:
   global:
-    - LTD_MASON_BUILD=false  # disable builds in regular text matrix
-    - LTD_MASON_PRODUCT="ldm-152"
-    - secure: "HM17Vsx8UNejQdK0p2KXccGAJdCKwzmyraFHxscQeXgA2zbVkiwJ9BS+1txSjCGmHcU7uajLLMEoyz7Ucv3pmSlB5f8WuFDPODaRKWm/4Loig1zeAvT+CTpXVe1Jc+IA/i0zgW9kwtXl31N61XcM+aYGDaN6ZWFmLzy9lFFv5PfZlT6I2UIw3vXu+ttBvNQCywfx7G61WwvIRsdYUcFVonN3j/kRICRc+5mw/Z6JLkfxXBVvCS2vr7zrgxV7MMrbUAghutagEUYGjotJKDj6enbJM2mRpccZJPRt8hT0rrKCT9WCQInygSLQxXbzWdSggN6V0eschYQWjsBcqpnyc3DUarCdzkIHDwyBScOWyEpikIhtlnYy9rYCqttzK59mkjAxmUQkM5V3dwJjI+X/CND3QsZDC8LWysPryULo8Xw2V6EPQWToZ4rAHykHJGpe6BMzxitkuP/4xc5kOTQxkOIv0a3cuDLWBIuBJTpjInIJlW1qjYyTJMDg4ilZy/xC78oQkb06pH3y5hFnMlIFb8cafe1M2r2I1xdxs2+mQCSDTIellvwpmHKeDnUY7HDvCEIfITS0VvIucLf9Ous8VqSOhrf21dk4lszO9uoPi7LNItQPYGkyHYZMaf9gi5C6t84Sskggxf1rePFiJJXoTdMV9+i/yxZTTeqLaJgirT4="
-    - secure: "RYFnqzihl+oWhzWEKrdJ3CJBPz5nZVFZXMUgY5tKWltN62rAmZTQS9qhm9c3D/H3y72v0xMvySH31v08ihif8LUuQ8EkSJIrxnrh6BKcrV8tzy+O0ms5vuWsr3EoQuikVRc+jI8gjTc8dAKtSazzk5AVJ3A4+b9F2nC0RguwstCazv5iVQ6ax35uDb2Z2BHIo2BFZJ8Ic1s+iVkLIf2CkwIvMNSSr2PV/KYPZX440JQKDYUwtzkgnuO9AMbcLRl1yG2rFf9cRJDwuNn51yukaT5FAZgrOVCr6+qDGoXz+pMXeBa/CxUyyNdKFc1B+x+4v26s90jfpHe+7W4C2tGy6Dcf8gJswY4KJcvvBC4ByBGSP7y7sRaJDp1kiqdy/UlGQI0n4LsdXT/DYlBxVCZV6Nu1zI/Q+YWzl0x546rWisp91FmIy5NrLOdfnFGhRugHUaDQhtWMTH9+tLuhSqoR0ncQwmj2fd5/2vhqOb8pCDOTBbKbrCeQCFTaHkLFzPIQz6VJrEVkpPq51ml2HN/d8hfWpDvS5F2ailchYJvJeUjNWKhnaOKozYGVC4rtgX/pLoCEbPeblzzF2adETCRlBmDWiJ55xdbfTMhCXwdJwSSrqMRoiZ26WtZNIf/fnT7Kt3oKI6ivRtulWJ/EfuJ9NJH4pbJ2p7LA1Qr2nA5w3q8="
+    - PRODUCT="ldm-152"
+    # Add LSST the Docs credentials
+    - secure: "IaGDBgWixI+UZWlqyVeLUZseZJAnWSEzQT0Zyg/Dfzx5qljOL4hAOZ7E0qGcRGarZGe6SSDVODc2nqSN8Nv1OSkDuwDvDkbPzfxElPyQdOHyDg8OlfVMvb4dAm/+306+v8qLzqtTAOo1G7IrqYZrlO2tyxFOiBf3VIXZeXjl3JKOVylcuqs3yEV0w8Rw6pspbCLvwYp1RxQHDqO/loD2j4a4SUf47mm7J22fwSHapENtMXp3ZsDZFBnnKzgvn4Tbd/XphvEIf7S4EFXGaBdZm5Q/meFtFBqF7X16pLSvNcSSubd91/PyWs/dgJ6/IPH5ZjS/dZ0/4/+3ZOn+7iVvtyFkXoDJqf0g9af8zvWsXi+UWDyH1aXTDL+llzmtVyCYNIe9prUuUKKPfQ2pXo7wmLO7+6dq9ODiV3woXw68Oi1/jyJoCt0/R/DSm+FF+zAaMKW1Btz4cYDP7fiUU4FX/cTAbWDbeXTFLiBwso1bByk7BnSqrOJwkhdnz3AvphYcWdBZemxoUqETAwUiYPBNEefSrC0QYTQi5l8p8FqwUU4Uwd+fOMFv+cv4Gos/cu/q++OwxV6mVbVhKxgQcO4I3zgY2BQLj+ZH/BH8ECNaAUWXEoC0eiFllUf5ue99+neLUt2sTSKUBOwaXNgyU6ISRy+qvJQpFDpZf2h7Axr7CdE="
+    - secure: "B+CafvZAqjdGh3pgofRBCg0rUTEZiXwQL2ATU6mGFtBkSlZ3TkNPjPeYsiUpMaV8TYuf40bwpipj+z7MnFHGiDoI1dVKkQRxRF1thxfX49N5ZqhSKAXhsr6eSYd5F6bZGaQH5Qc0hS65X3SILFEQ6o3Y7yL8o0JY7Vkaqq72D20UCaVtAmThRS+yy2eM8N3QjmErpTnXza9MlVwJ6esvSyIwiElsbT0dLJiGvFstLZP2NBh9vQIdtXVHlAfO9tY0t+cAK4Kb2piXoX13bRRsDuys842EL6ja/3qb+kxeFpmDgpfZrnnB741LnxwVFYQ5BDli3CM7iJbkExAqJfrewRot6idwU4VTgIN0E0hnRecg64yk5aFeP0T6fHjpMePUA4KUqRd35jastzWfJcNGRShv6o2sRXe7Aw+210bAS6Hdxc/96kFjtLd6WByg93IX7oS4Xzp85Bnlr7Pd1mm3vgYkC6ehQnaP4Zqz9Lt6tzSQ18v8r/ku+oownfJmyMNdrqxNaGnIFiN8azgqNYFFEr5PzwUYO1NP1EwtXfegDQm5v+gAnraTc3YWgSBf2Qt0PWobNvvLv5S/Ln93TJ6V5Kuhz7887xtycCxG/wCZ9eAsgLLY6gjcaSYN3uuJBoI8X9fmaw5PCyaJd7W3CQkjlT0ivhwHEafse1Lg7Ll8Szw="

Makefile

@@ -1,192 +1,4 @@
-# Makefile for Sphinx documentation
-#
+export TEXMFHOME = lsst-texmf/texmf
 
-# You can set these variables from the command line.
-SPHINXOPTS    =
-SPHINXBUILD   = sphinx-build
-PAPER         =
-BUILDDIR      = _build
-
-# User-friendly check for sphinx-build
-ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
-$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
-endif
-
-# Internal variables.
-PAPEROPT_a4     = -D latex_paper_size=a4
-PAPEROPT_letter = -D latex_paper_size=letter
-ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
-# the i18n builder cannot share the environment and doctrees with the others
-I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
-
-.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
-
-help:
-	@echo "Please use \`make <target>' where <target> is one of"
-	@echo "  html       to make standalone HTML files"
-	@echo "  dirhtml    to make HTML files named index.html in directories"
-	@echo "  singlehtml to make a single large HTML file"
-	@echo "  pickle     to make pickle files"
-	@echo "  json       to make JSON files"
-	@echo "  htmlhelp   to make HTML files and a HTML help project"
-	@echo "  qthelp     to make HTML files and a qthelp project"
-	@echo "  applehelp  to make an Apple Help Book"
-	@echo "  devhelp    to make HTML files and a Devhelp project"
-	@echo "  epub       to make an epub"
-	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
-	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
-	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
-	@echo "  text       to make text files"
-	@echo "  man        to make manual pages"
-	@echo "  texinfo    to make Texinfo files"
-	@echo "  info       to make Texinfo files and run them through makeinfo"
-	@echo "  gettext    to make PO message catalogs"
-	@echo "  changes    to make an overview of all changed/added/deprecated items"
-	@echo "  xml        to make Docutils-native XML files"
-	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
-	@echo "  linkcheck  to check all external links for integrity"
-	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
-	@echo "  coverage   to run coverage check of the documentation (if enabled)"
-
-clean:
-	rm -rf $(BUILDDIR)/*
-
-html:
-	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
-	@echo
-	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
-
-dirhtml:
-	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
-	@echo
-	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
-
-singlehtml:
-	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
-	@echo
-	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
-
-pickle:
-	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
-	@echo
-	@echo "Build finished; now you can process the pickle files."
-
-json:
-	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
-	@echo
-	@echo "Build finished; now you can process the JSON files."
-
-htmlhelp:
-	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
-	@echo
-	@echo "Build finished; now you can run HTML Help Workshop with the" \
-	      ".hhp project file in $(BUILDDIR)/htmlhelp."
-
-qthelp:
-	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
-	@echo
-	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
-	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
-	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/LDM-152DataManagementMiddlewareDesign.qhcp"
-	@echo "To view the help file:"
-	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/LDM-152DataManagementMiddlewareDesign.qhc"
-
-applehelp:
-	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
-	@echo
-	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
-	@echo "N.B. You won't be able to view it unless you put it in" \
-	      "~/Library/Documentation/Help or install it in your application" \
-	      "bundle."
-
-devhelp:
-	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
-	@echo
-	@echo "Build finished."
-	@echo "To view the help file:"
-	@echo "# mkdir -p $$HOME/.local/share/devhelp/LDM-152DataManagementMiddlewareDesign"
-	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/LDM-152DataManagementMiddlewareDesign"
-	@echo "# devhelp"
-
-epub:
-	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
-	@echo
-	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
-
-latex:
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
-	@echo
-	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
-	@echo "Run \`make' in that directory to run these through (pdf)latex" \
-	      "(use \`make latexpdf' here to do that automatically)."
-
-latexpdf:
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
-	@echo "Running LaTeX files through pdflatex..."
-	$(MAKE) -C $(BUILDDIR)/latex all-pdf
-	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
-
-latexpdfja:
-	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
-	@echo "Running LaTeX files through platex and dvipdfmx..."
-	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
-	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
-
-text:
-	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
-	@echo
-	@echo "Build finished. The text files are in $(BUILDDIR)/text."
-
-man:
-	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
-	@echo
-	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
-
-texinfo:
-	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
-	@echo
-	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
-	@echo "Run \`make' in that directory to run these through makeinfo" \
-	      "(use \`make info' here to do that automatically)."
-
-info:
-	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
-	@echo "Running Texinfo files through makeinfo..."
-	make -C $(BUILDDIR)/texinfo info
-	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
-
-gettext:
-	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
-	@echo
-	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
-
-changes:
-	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
-	@echo
-	@echo "The overview file is in $(BUILDDIR)/changes."
-
-linkcheck:
-	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
-	@echo
-	@echo "Link check complete; look for any errors in the above output " \
-	      "or in $(BUILDDIR)/linkcheck/output.txt."
-
-doctest:
-	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
-	@echo "Testing of doctests in the sources finished, look at the " \
-	      "results in $(BUILDDIR)/doctest/output.txt."
-
-coverage:
-	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
-	@echo "Testing of coverage in the sources finished, look at the " \
-	      "results in $(BUILDDIR)/coverage/python.txt."
-
-xml:
-	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
-	@echo
-	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
-
-pseudoxml:
-	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
-	@echo
-	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
+LDM-152.pdf: *.tex local.bib
+	latexmk -bibtex -pdf -f LDM-152.tex

README.rst

@@ -1,35 +1,34 @@
+.. image:: https://img.shields.io/badge/ldm--152-lsst.io-brightgreen.svg
+   :target: https://ldm-152.lsst.io
+.. image:: https://travis-ci.org/lsst/LDM-152.svg
+   :target: https://travis-ci.org/lsst/LDM-152
+
 #######
 LDM-152
 #######
 
-=====================================
-Data Management and Middleware Design
-=====================================
-
-This is a working repository for *LDM-152: Data Management and
-Middleware Design*.
-
-* Read the living document on the web: http://ldm-152.readthedocs.org
-* Read the officially-approved document: https://docushare.lsstcorp.org/docushare/dsweb/ServicesLib/LDM-152/History
-
-Working with this document
---------------------------
+=================================
+Data Management Middleware Design
+=================================
 
-.. code::
+This is a working repository for *LDM-152: Data Management Middleware Design*.
 
-   git clone git@github.com:lsst/LDM-152.git
-   cd LDM-152
-   pip install -r requirements.txt
-   make html
+Links
+=====
 
-The built site can be viewed by opening ``_build/html/index.html`` in
-your web browser.
+* Live drafts: http://ldm-152.lsst.io/v
+* GitHub: https://github.com/lsst/LDM-152
+* DocuShare: https://ls.st/LDM-152*
 
-Whenever you push to ``master``, readthedocs.org will build and host the
-document at http://ldm-152.readthedocs.org
+Building the PDF locally
+========================
 
-Editing metadata
-----------------
+The document is built using LaTeX, and relies upon the `lsst-texmf <https://lsst-texmf.lsst.io/>`_ and `images <https://github.com/lsst-dm/images>`_ repositories.
+It includes the necessary versions of these as git submodules.
+To build from scratch::
 
-Metadata, such as document version, title, date of last edit, and
-authors, are maintained in the ``metadata.yaml`` file
+  git clone https://github.com/lsst/LDM-152
+  cd LDM-152
+  git submodule init
+  git submodule update
+  make