Details
-
Type:
Story
-
Status: Done
-
Resolution: Done
-
Fix Version/s: None
-
Component/s: Design Documents
-
Labels:None
-
Story Points:4.8
-
Epic Link:
-
Team:SQuaRE
Description
Wil, Frossie, Tim, and I have discussed a new change-controlled document Git repository workflow to replace the current policy (release on master, work on draft).
The basic features of the new workflow are:
- Development on master in ticket branches. In general, document development should mirror code development workflows.
- Release branches (named after the corresponding RFC or LCR) that are never merged back to master.
- The release manager backports commits on the release branches (amendments requested by a CCB) to the master branch.
- Tags for docushare upload number and document version.
- A moving tag for the docushare preferred version.
These tags are an API for LSST the Docs (lsst.io) and for future DocuShare automation.
Attachments
Issue Links
Activity
Field | Original Value | New Value |
---|---|---|
Epic Link |
|
Watchers | Frossie Economou, Jonathan Sick, Tim Jenness, Wil O'Mullane [ Frossie Economou, Jonathan Sick, Tim Jenness, Wil O'Mullane ] | Frossie Economou, John Swinbank, Jonathan Sick, Tim Jenness, Wil O'Mullane [ Frossie Economou, John Swinbank, Jonathan Sick, Tim Jenness, Wil O'Mullane ] |
Attachment | doc-release-sketch.png [ 29947 ] |
Attachment | document_workflow.pdf [ 29964 ] |
Status | To Do [ 10001 ] | In Progress [ 3 ] |
Story Points | 2.5 |
Story Points | 2.5 | 4.8 |
Reviewers | Tim Jenness [ tjenness ] | |
Status | In Progress [ 3 ] | In Review [ 10004 ] |
Status | In Review [ 10004 ] | Reviewed [ 10101 ] |
Resolution | Done [ 10000 ] | |
Status | Reviewed [ 10101 ] | Done [ 10002 ] |