Skip to content
Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
526 lines (363 sloc) 11.5 KB

LSST DM Developer Guide

This is an internal guide for LSST DM staff. It's also openly available so that others can understand how we're building the LSST's data management subsystem.

This guide includes a mix of normative requirements and helpful, descriptive, pages. When it's particularly important that you closely follow a standard, we include an annotation box at the top of the page.

Any member of DM can contribute to this guide. It's published from the https://github.com/lsst-dm/dm_dev_guide GitHub repo. Check out the README to get started.


Jump to: :ref:`Team <part-team>` · :ref:`Communications <part-communications>` · :ref:`Project documentation <part-project-docs>` · :ref:`Work management <part-work>`

Development guides: :ref:`Overview <part-guides>` · :ref:`C++ <part-cpp>` · :ref:`Python <part-python>` · :ref:`Pybind11 <part-pybind11>` · :ref:`JavaScript <part-javascript>` · :ref:`ReStructuredText <part-rst>` · :ref:`DM Stack <part-dm-stack>` · :ref:`Git <part-git>` · :ref:`Editors <part-editors>` · :ref:`Legal <part-legal>` · :ref:`User documentation style <part-user-doc-style-guide>`

Services: :ref:`Overview <part-services>` · :ref:`Jenkins <part-jenkins>` · :ref:`LSST Data Facility <part-ldf>`


.. toctree::
   :maxdepth: 1
   :caption: Team
   :hidden:

   team/onboarding
   team/code-of-conduct
   team/empowerment
   team/drp

Team

Basic information about the LSST Data Management Subsystem and our culture. Learn more about the Data Management Subsystem in :ldm:`294`.

Team-specific pages:

.. toctree::
   :maxdepth: 1
   :caption: Communications
   :hidden:

   communications/slack-github-username.rst
   communications/rfc.rst
   communications/rfd.rst
   communications/wiki.rst
   communications/presenting-at-conferences.rst
   communications/calendars.rst

Communications

How to use DM's communication channels.

.. toctree::
   :maxdepth: 1
   :caption: Project docs
   :hidden:

   project-docs/change-controlled-docs.rst
   project-docs/publication-policy.rst
   project-docs/technotes.rst

Project documentation

Controlled documentation and publications.

Technical notes.

.. toctree::
   :maxdepth: 1
   :caption: Work
   :hidden:

   work/flow.rst
   work/project-planning.rst
   work/jira-agile.rst
   work/jira-tips.rst

Work management

How DM coordinates work and gets things done.

Development guides

.. toctree::
   :maxdepth: 1
   :caption: Code Style Guides
   :hidden:

   coding/intro.rst
   coding/unit-test-policy.rst

Overview of Code Style Guides & Policies

.. toctree::
   :maxdepth: 1
   :caption: C++
   :hidden:

   cpp/style
   cpp/api-docs
   cpp/clang-format
   cpp/testing-private-functions
   cpp/templates
   cpp/boost
   cpp/eigen
   cpp/profiling

C++

.. toctree::
   :maxdepth: 1
   :caption: Python
   :hidden:

   python/style
   python/testing
   python/numpydoc
   python/astropy
   python/profiling

Python

.. toctree::
   :maxdepth: 1
   :caption: Pybind11
   :hidden:

   pybind11/style
   pybind11/how-to

Pybind11

.. toctree::
   :maxdepth: 1
   :caption: JavaScript
   :hidden:

   javascript/jsdoc

JavaScript

.. toctree::
   :maxdepth: 1
   :caption: ReStructuredText
   :hidden:

   restructuredtext/style

ReStructuredText

.. toctree::
   :maxdepth: 1
   :caption: DM Stack
   :hidden:

   stack/platforms
   stack/transferring-code
   stack/deprecating-interfaces
   stack/logging
   stack/debug
   stack/documentation-system-overview
   stack/layout-of-doc-directory
   stack/package-documentation-topic-types
   stack/add-a-package-to-pipelines-lsst-io
   stack/building-single-package-docs
   stack/building-pipelines-lsst-io-locally
   stack/building-pipelines-lsst-io-with-documenteer-job
   stack/jenkins-stack-os-matrix
   stack/unit-test-coverage.rst
   stack/eups-tutorial
   stack/lsstsw
   stack/adding-a-new-package
   stack/license-and-copyright
   stack/packaging-third-party-eups-dependencies
   stack/renaming-a-package

DM Stack

General policies and procedures.

Development.

Documentation.

Testing.

Packaging.

.. toctree::
   :maxdepth: 1
   :caption: Git
   :hidden:

   git/setup
   git/git-lfs

Git

.. toctree::
   :maxdepth: 1
   :caption: Editors
   :hidden:

   editors/emacs
   editors/sublime
   editors/vim

Editors

Crowd-sourced recommendations for configuring editors for LSST development (listed alphabetically)

.. toctree::
   :maxdepth: 1
   :caption: Legal
   :hidden:

   legal/licensing-overview
   legal/copyright-overview

Legal

.. toctree::
   :maxdepth: 1
   :caption: User docs
   :hidden:

   user-docs/index

User documentation style

Service guides

.. toctree::
   :maxdepth: 1
   :caption: IT Overview
   :hidden:

   it/itsc

IT overview

.. toctree::
   :maxdepth: 1
   :caption: Jenkins
   :hidden:

   jenkins/getting-started

Jenkins CI

.. toctree::
   :maxdepth: 1
   :caption: LDF Services
   :hidden:

   services/lsst-dev
   services/lsst-db
   services/verification
   services/datasets
   services/data_protection
   services/ncsa_bulk_transfer
   services/nebula/index
   services/orchestration/index
   services/ldf-tickets
   services/ldf-resources
   services/storage
   services/monitoring_applications

LSST Data Facility services

You can’t perform that action at this time.