Details
-
Type:
Story
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: Stack Documentation and UX
-
Labels:
-
Story Points:1.5
-
Epic Link:
-
Team:SQuaRE
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:
- Getting Started
- Processes
- Coding Guides
- Writing Docs
- Build, Test, Release
- Developer Services
Proposed new top-level organization: (work in progress)
- Getting started
- Account onboarding checklist
- Where to find LSST/DM information
- Team
- Team Culture and Conduct Standards
- DM Organization (maybe not normative, but at least something useful)
- Communicating
- Request for Comments (RFC)
- Changing controlled documents with the TCT
- Request for Discussion (RFD)
- Meeting notes in confluence
- Using the Community forum
- Presenting at conferences.
- slide templates
- link to information policy
- link to pub board procedure
- Zenodo deposition
- community.lsst.org conference report
- Workflow
- Overview of the DM workflow
- Using JIRA
- GitHub organizations
- Git branching and merging
- Code reviews
- Development guides
- Overview
- Python
- Python style guide
- Python unit testing
- Using Astropy
- Logging (or move to Pipelines documentation site)
- C++
- C++ style guide
- C++ unit testing / Unit testing Private C++ functions
- Using C++ templates
- Using Boost
- Using Eigen
- EUPS packaging and Git repositories
- EUPS tutorial
- How to make a Stack repository
- Adding Git LFS to a repository
- Managing copyright and license info in repositories
- Renaming an LSST Git repository
- Moving code between packages
- Build and continuous integration infrastructure
- Using Jenkins stack-os-matrix
- other Jenkins jobs
- lsstsw and lsst-build
- Development infrastructure
- Using the lsst-dev server
- Using the Verification Cluster
- Using the NCSA bulk transfer server
- NCSA Nebula OpenStack user guide
- Developer tools
- Required Git configuration
- Configuring the Git LFS client
- Git practices
- Atom configuration
- Emacs configuration
- Vim configuration
- Documentation style guide
Attachments
Issue Links
- relates to
-
DM-9065 Improve documentation of DM's GitHub configuration
- To Do
-
DM-12055 Re-write the DM Developer Workflow guide using topic-based writing
- To Do
-
DM-9037 Document best practices to report an issue with DM system in Developer Guide
- To Do
-
RFC-453 Reorganization of the DM Developer Guide
- Implemented
Comment from Xiuqin Wu:
+1 Absolutely