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

Support change controlled docs and test reports with templates and templatebot

    XMLWordPrintable

    Details

    • Type: Story
    • Status: Done
    • Resolution: Done
    • Fix Version/s: None
    • Component/s: None
    • Labels:
      None

      Description

      Technotes are already built with templatebot (the service backing sqrbot-jr create project). We should further extend the service for change controlled documents and test reports which are principally maintained in DocuShare, but also have drafts available from LSST the Docs (the PDFs from LTD are often used populating DocuShare). The key difference is that these documents have pre-assigned handles from DocuShare.

      • For regular change controlled documents, we can use the templates established in lsst/lsst-texmf.
      • For test reports DMTR, I think the request is to have a minimal template with the build infrastructure since the bulk of the DMTR content generation is done with a tool called docsteady.

        Attachments

          Issue Links

          relates to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-25439 Clean title, other inputs, from sqrbot-jr project create

          • Done

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-25657 Revise lsst doc LaTeX template: name and README

          • Done

            Activity

            Ascending order - Click to sort in descending order
            Hide
            Permalink
            gcomoretto Gabriele Comoretto [X] (Inactive) added a comment -

            As per conversation over chat, I list here what I think sqrbot-jr could do for helping automating DMTRs:

            • enable publication to lsst the docs
            • create the following files:
              • empty local.bib
              • Makefile (see DMTR-241)
              • empty myacronyms.txt
              • empty skipacronyms.txt
              • a template for history_and_info.tex (see DMTR-241)
              • a template for appendix.tex (see DMTR-241)
              • a template for .docugen (see DMTR-241)

            The main DMTR tex file and appendix are generated by docsteady.

             

            Show
            gcomoretto Gabriele Comoretto [X] (Inactive) added a comment - As per conversation over chat, I list here what I think sqrbot-jr could do for helping automating DMTRs: enable publication to lsst the docs create the following files: empty local.bib Makefile (see DMTR-241) empty myacronyms.txt empty skipacronyms.txt a template for history_and_info.tex (see DMTR-241) a template for appendix.tex (see DMTR-241) a template for .docugen (see DMTR-241) The main DMTR tex file and appendix are generated by docsteady.  
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            Hi Gabriele, let me know if this template works for you:

            https://github.com/lsst/templates/tree/tickets/DM-25331/project_templates/test_report

            Note that one issue with the template is it won't build immediately because the Makefile is set up to always run bibtex (as opposed to using latexmk's smart bibtex driver) and there aren't any initial citations. However, it should work once you've populated the document with docsteady.

            Show
            jsick Jonathan Sick added a comment - Hi Gabriele, let me know if this template works for you: https://github.com/lsst/templates/tree/tickets/DM-25331/project_templates/test_report Note that one issue with the template is it won't build immediately because the Makefile is set up to always run bibtex (as opposed to using latexmk's smart bibtex driver) and there aren't any initial citations. However, it should work once you've populated the document with docsteady.
            Hide
            Permalink
            gcomoretto Gabriele Comoretto [X] (Inactive) added a comment -

            Thank you Jonathan.

            I think it is OK that the build will not work until docsteady is not executed the first time.

            I can't say much about all the file changes in the PRs.

            Show
            gcomoretto Gabriele Comoretto [X] (Inactive) added a comment - Thank you Jonathan. I think it is OK that the build will not work until docsteady is not executed the first time. I can't say much about all the file changes in the PRs.

              People

              Assignee:
              jsick Jonathan Sick
              Reporter:
              jsick Jonathan Sick
              Reviewers:
              Gabriele Comoretto [X] (Inactive)
              Watchers:
              Gabriele Comoretto [X] (Inactive), Jonathan Sick
              Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.