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

Gracefully handle Git revision dates in technotes

    XMLWordPrintable

    Details

      Description

      The technote platform uses a metadata.yaml file to provide authoritative single-sourcing of document metadata (https://sqr-000.lsst.io/#metadata-standard). One of those is the last_revised date. The problem with using this by default is that the revision date quickly gets out of sync with the Git history while a documented is being actively drafted. Solution:

      1. Make it so that last_revised: none causes documenteer to obtain the date from Git history instead. When a document is being ‘released’/‘archived' (or being initially ported from another format) the last_revised field can be set to a date.
      2. Potentially make the Git-based date smart so that revisions to ancillary files don’t affect the last_revised date of the content.

        Attachments

          Issue Links

            Activity

            jsick Jonathan Sick created issue -
            jsick Jonathan Sick made changes -
            Field Original Value New Value
            Epic Link DM-5644 [ 23494 ]
            jsick Jonathan Sick made changes -
            Resolution Done [ 10000 ]
            Status To Do [ 10001 ] Invalid [ 11005 ]
            jsick Jonathan Sick made changes -
            Link This issue is duplicated by DM-6916 [ DM-6916 ]

              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:

                  CI Builds

                  No builds found.