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

Make package and module documentation directories exclusive

    Details

    • Templates:
    • Story Points:
      2.1
    • Team:
      SQuaRE

      Description

      We have decided to change how module and package documentation directories are used. The original design was to have module and package documentation directories for all packages (unless the package did not provide Python modules). The new design is to have one type of directory, but not both. This de-emphasizes the role of EUPS and packaging in our user documentation, and is future proof-for a possible mono-repo refactoring of the LSST Science Pipelines.

      This means that module documentation directories now need to provide information about the project (Git repository, Jira component).

      This ticket is to update the stack_package template (https://github.com/lsst/templates) and DMTN-030 technote (https://github.com/lsst-dm/dmtn-030) with this new design.

      Changes to the Developer Guide documentation will be handled in DM-14852 and changes to https://github.com/lsst-dm/pipelines_lsst_io will be handled in DM-11216.

        Attachments

          Container Issues

            Issue Links

              Activity

                People

                • Assignee:
                  jsick Jonathan Sick
                  Reporter:
                  jsick Jonathan Sick
                  Reviewers:
                  Simon Krughoff
                  Watchers:
                  Jonathan Sick, Simon Krughoff
                • Votes:
                  0 Vote for this issue
                  Watchers:
                  2 Start watching this issue

                  Dates

                  • Created:
                    Updated:
                    Resolved:

                    Summary Panel