Uploaded image for project: 'Data Management'
  1. Data Management
  2. DM-8582

Replan DM Developer Guide Top-Level Organization

    XMLWordPrintable

    Details

      Description

      Now that we have experience with https://developer.lsst.io, we can improve the usability of the top-level topic organization.

      The current organization is:

      1. Getting Started
      2. Processes
      3. Coding Guides
      4. Writing Docs
      5. Build, Test, Release
      6. Developer Services

      Proposed new top-level organization: (work in progress)

      1. Getting started
        1. Account onboarding checklist
        2. Where to find LSST/DM information
      2. Team
        1. Team Culture and Conduct Standards
        2. DM Organization (maybe not normative, but at least something useful)
      3. Communicating
        1. Request for Comments (RFC)
        2. Changing controlled documents with the TCT
        3. Request for Discussion (RFD)
        4. Meeting notes in confluence
        5. Using the Community forum
        6. Presenting at conferences.
          • slide templates
          • link to information policy
          • link to pub board procedure
          • Zenodo deposition
          • community.lsst.org conference report
      4. Workflow
        1. Overview of the DM workflow
        2. Using JIRA
        3. GitHub organizations
        4. Git branching and merging
        5. Code reviews
      5. Development guides
        1. Overview
        2. Python
          1. Python style guide
          2. Python unit testing
          3. Using Astropy
          4. Logging (or move to Pipelines documentation site)
        3. C++
          1. C++ style guide
          2. C++ unit testing / Unit testing Private C++ functions
          3. Using C++ templates
          4. Using Boost
          5. Using Eigen
        4. EUPS packaging and Git repositories
          1. EUPS tutorial
          2. How to make a Stack repository
          3. Adding Git LFS to a repository
          4. Managing copyright and license info in repositories
          5. Renaming an LSST Git repository
          6. Moving code between packages
      6. Build and continuous integration infrastructure
        1. Using Jenkins stack-os-matrix
        2. other Jenkins jobs
        3. lsstsw and lsst-build
      7. Development infrastructure
        1. Using the lsst-dev server
        2. Using the Verification Cluster
        3. Using the NCSA bulk transfer server
        4. NCSA Nebula OpenStack user guide
      8. Developer tools
        1. Required Git configuration
        2. Configuring the Git LFS client
        3. Git practices
        4. Atom configuration
        5. Emacs configuration
        6. Vim configuration
      9. Documentation style guide

        Attachments

          Issue Links

            Activity

            Hide
            jsick Jonathan Sick added a comment -

            Comment from Xiuqin Wu:

            Jonathan Sick Developer workflow was very helpful for us. One little suggestion: Make a short set-by-step cheat sheet for developers to reference. Sometimes a reminder is enough without reading through all the detailed documents.

            +1 Absolutely

            Show
            jsick Jonathan Sick added a comment - Comment from Xiuqin Wu : Jonathan Sick Developer workflow was very helpful for us. One little suggestion: Make a short set-by-step cheat sheet for developers to reference. Sometimes a reminder is enough without reading through all the detailed documents. +1 Absolutely
            Hide
            jsick Jonathan Sick added a comment -

            I've presented the reorganization as RFC-453.

            Show
            jsick Jonathan Sick added a comment - I've presented the reorganization as RFC-453 .

              People

              Assignee:
              jsick Jonathan Sick
              Reporter:
              jsick Jonathan Sick
              Watchers:
              Jonathan Sick
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.