From 0b413ca1292b17ef1e5b9a95c2f130ee4b87285c Mon Sep 17 00:00:00 2001 From: Jonathan Sick Date: Wed, 28 Feb 2018 23:57:40 -0700 Subject: [PATCH] Re-org the Team section These are pages mostly about the DM subsystem itself, of an intro nature: - Onboarding - Code of Conduct - DRP team page Add team/index.rst to cover the /team/ URL. Also update links from other pages. --- build-ci/jenkins.rst | 2 +- index.rst | 38 +++++++++++++------ services/lsst-db.rst | 2 +- services/lsst-dev.rst | 2 +- services/verification.rst | 2 +- .../code-of-conduct.rst | 0 {teams => team}/drp.rst | 0 team/index.rst | 15 ++++++++ {getting-started => team}/onboarding.rst | 0 9 files changed, 46 insertions(+), 15 deletions(-) rename processes/code_of_conduct.rst => team/code-of-conduct.rst (100%) rename {teams => team}/drp.rst (100%) create mode 100644 team/index.rst rename {getting-started => team}/onboarding.rst (100%) diff --git a/build-ci/jenkins.rst b/build-ci/jenkins.rst index 5657f33c..621c6d40 100644 --- a/build-ci/jenkins.rst +++ b/build-ci/jenkins.rst @@ -11,7 +11,7 @@ Logging in Log into Jenkins by visiting https://ci.lsst.codes and authenticate with your GitHub credentials. Any member of the `lsst`_, `lsst-dm`_, or `lsst-sqre`_ GitHub organizations is authorized to use https://ci.lsst.codes. -See the :doc:`../getting-started/onboarding` for more information. +See the :doc:`/team/onboarding` for more information. Using the Jenkins dashboard =========================== diff --git a/index.rst b/index.rst index aa2bbe97..1c5a75ad 100644 --- a/index.rst +++ b/index.rst @@ -15,19 +15,42 @@ This Guide will help you in contributing to the DM development effort. DM Developers can make this guide better by contributing to the https://github.com/lsst-dm/dm_dev_guide repo. The `README `__ will get you started. +.. TEAM SECTION ============================================================== + +.. Hidden toctree to manage the sidebar navigation. Match the contents list below. + .. toctree:: :maxdepth: 1 - :caption: Getting Started - :name: part-getting-started + :caption: Team + :hidden: + + team/onboarding.rst + team/code-of-conduct.rst + team/drp.rst + +.. Table of contents published on the homepage. +.. Mirror changes here to team/index.rst (temporary workflow) + +.. _part-team: + +Team +==== + +Basic information about the LSST Data Management Subsystem and teams. +Learn about the Data Management Subsystem in :ldm:`294`. - getting-started/onboarding.rst +- :doc:`team/onboarding` +- :doc:`team/code-of-conduct` + +Team-specific pages: + +- :doc:`team/drp` .. toctree:: :maxdepth: 1 :caption: Processes :name: part-processes - processes/code_of_conduct.rst processes/workflow.rst processes/decision_process.rst processes/transferring_code.rst @@ -116,10 +139,3 @@ The `README `__ w services/ncsa_bulk_transfer.rst services/nebula/index.rst services/orchestration/index.rst - -.. toctree:: - :maxdepth: 1 - :caption: Team Specific Information - :name: part-teams - - teams/drp.rst diff --git a/services/lsst-db.rst b/services/lsst-db.rst index dc5a4b29..d899413e 100644 --- a/services/lsst-db.rst +++ b/services/lsst-db.rst @@ -5,7 +5,7 @@ Using the lsst-dev-db Server ``lsst-dev-db`` is the development MySQL database server run by NCSA for LSST DM development work. The CNAMEs ``lsst-db.ncsa.illinois.edu`` and ``lsst10.ncsa.illinois.edu`` direct to ``lsst-dev-db.ncsa.illinois.edu`` to support historical usage of those hostnames. -To get an account, see the :doc:`Onboarding Checklist `. +To get an account, see the :doc:`Onboarding Checklist `. This page is designed to assist developers in their work with ``lsst-dev-db``: diff --git a/services/lsst-dev.rst b/services/lsst-dev.rst index 8e3e60a4..02f2c91c 100644 --- a/services/lsst-dev.rst +++ b/services/lsst-dev.rst @@ -5,7 +5,7 @@ Using the lsst-dev Server ``lsst-dev`` is the development server/cluster of servers run by NCSA for LSST DM development work. The cname ``lsst-dev.ncsa.illinois.edu`` directs to ``lsst-dev01.ncsa.illinois.edu`` and this system serves as the primary development server for the team. -To get an account, see the :doc:`Onboarding Checklist `. +To get an account, see the :doc:`Onboarding Checklist `. This page is designed to assist developers in their work on ``lsst-dev01``: diff --git a/services/verification.rst b/services/verification.rst index 91e75be8..b0d43d4d 100644 --- a/services/verification.rst +++ b/services/verification.rst @@ -4,7 +4,7 @@ Using the Verification Cluster The ``Verification Cluster`` is a cluster of servers run by NCSA for LSST DM development work. -To get an account, see the :doc:`Onboarding Checklist `. +To get an account, see the :doc:`Onboarding Checklist `. This page is designed help you get started on the ``Verification Cluster``: diff --git a/processes/code_of_conduct.rst b/team/code-of-conduct.rst similarity index 100% rename from processes/code_of_conduct.rst rename to team/code-of-conduct.rst diff --git a/teams/drp.rst b/team/drp.rst similarity index 100% rename from teams/drp.rst rename to team/drp.rst diff --git a/team/index.rst b/team/index.rst new file mode 100644 index 00000000..92a544d6 --- /dev/null +++ b/team/index.rst @@ -0,0 +1,15 @@ +:orphan: + +#### +Team +#### + +Basic information about the LSST Data Management Subsystem and teams. +Learn about the Data Management Subsystem in :ldm:`294`. + +- :doc:`onboarding` +- :doc:`code-of-conduct` + +Team-specific pages: + +- :doc:`drp` diff --git a/getting-started/onboarding.rst b/team/onboarding.rst similarity index 100% rename from getting-started/onboarding.rst rename to team/onboarding.rst