Uploaded image for project: 'Request For Comments'
  1. Request For Comments
  2. RFC-401

Revised DM change-controlled document release workflow

    Details

    • Type: RFC
    • Status: Implemented
    • Resolution: Done
    • Component/s: DM
    • Labels:
      None

      Description

      I propose a new workflow for DM's Git-based change-controlled documents. This applies to DM's internal change-controlled documents (LDM and DMTR) and how we contribute to project-level documents (such as LPM and LSE).

      For context, our current workflow has relied upon the master branch representing the baselined document. Writing and review has been done on a draft branch. Because this workflow is distinct from how we develop code, it presents unnecessary friction for those writing change-controlled documents.

      This proposal designates the master branch as the integration branch, like it is for our software development. Releases happen on release branches named after the associated RFC or LCR. I have written the proposed workflow in detail in this draft document: https://developer.lsst.io/v/DM-11952/docs/change-controlled-docs.html

      Implementing this RFC will involve:

      • Merging the DM-11952 branch in the Developer Guide.
      • Updating LSST the Docs so that it recognizes document version tags and displays the most recent baselined version as the document's <handle>.lsst.io landing page.
      • Re-arranging any document Git repositories that have active draft branches.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                jsick Jonathan Sick
                Reporter:
                jsick Jonathan Sick
                Watchers:
                Donald Petravick, Frossie Economou, John Swinbank, Jonathan Sick, Kian-Tat Lim, Tim Jenness, Wil O'Mullane, Xiuqin Wu [X] (Inactive)
              • Votes:
                0 Vote for this issue
                Watchers:
                8 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved:
                  Planned End:

                  Summary Panel