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

Document how to write and build the integrated pipelines.lsst.io

    XMLWordPrintable

    Details

      Description

      This ticket is to write documentation that enables developers to successful contribute to documentation for the LSST Science Pipelines:

      • How to write documentation in the system.
      • How to build LSST Science Pipelines (pipelines.lsst.io and single package) documentation locally
      • How to build pipelines.lsst.io from Jenkins.

        Attachments

          Issue Links

          is blocked by

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-14813 Move LICENSE/COPYRIGHT docs out of "package docs" documentation

          • Done
          is triggering

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-15211 Improve data package documentation guidelines

          • To Do
          relates to

          Story - Created by Jira Software - do not edit or delete. Issue type for a user story. DM-15024 Make package and module documentation directories exclusive

          • Done

            Activity

            Ascending order - Click to sort in descending order
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            Preview of documenteer documentation: https://documenteer.lsst.io/v/DM-14852 (covers the build tooling)

            Show
            jsick Jonathan Sick added a comment - Preview of documenteer documentation: https://documenteer.lsst.io/v/DM-14852 (covers the build tooling)
            Hide
            Permalink
            jsick Jonathan Sick added a comment - - edited

            The attached "Pipelines Documentation Contribution docs" is an outline of content that will be written for developer.lsst.io and pipelines.lsst.io surrounding pipelines.lsst.io documentation contribution.

            Show
            jsick Jonathan Sick added a comment - - edited The attached "Pipelines Documentation Contribution docs" is an outline of content that will be written for developer.lsst.io and pipelines.lsst.io surrounding pipelines.lsst.io documentation contribution.
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            Hi David Staker [X], could you provide a review of https://github.com/lsst-dm/dm_dev_guide/pull/237 ?

            This is documentation on how to contribute to the new Stack documentation system and how to build Stack documentation such as pipelines.lsst.io.

            Main link: https://developer.lsst.io/v/DM-14852/index.html#part-dm-stack (see "Documentation.").

            New pages:

            Show
            jsick Jonathan Sick added a comment - Hi David Staker [X] , could you provide a review of https://github.com/lsst-dm/dm_dev_guide/pull/237  ? This is documentation on how to contribute to the new Stack documentation system and how to build Stack documentation such as pipelines.lsst.io. Main link: https://developer.lsst.io/v/DM-14852/index.html#part-dm-stack (see "Documentation."). New pages: https://developer.lsst.io/v/DM-14852/stack/documentation-system-overview.html https://developer.lsst.io/v/DM-14852/stack/layout-of-doc-directory.html https://developer.lsst.io/v/DM-14852/stack/package-documentation-topic-types.html https://developer.lsst.io/v/DM-14852/stack/package-homepage-topic-type.html https://developer.lsst.io/v/DM-14852/stack/module-homepage-topic-type.html https://developer.lsst.io/v/DM-14852/stack/task-topic-type.html https://developer.lsst.io/v/DM-14852/stack/generic-guide-topic-type.html https://developer.lsst.io/v/DM-14852/stack/add-a-package-to-pipelines-lsst-io.html https://developer.lsst.io/v/DM-14852/stack/building-single-package-docs.html https://developer.lsst.io/v/DM-14852/stack/building-pipelines-lsst-io-locally.html https://developer.lsst.io/v/DM-14852/stack/building-pipelines-lsst-io-with-documenteer-job.html
            Hide
            Permalink
            jsick Jonathan Sick added a comment -

            Thanks David Staker [X] and Kian-Tat Lim for the comments!

            Show
            jsick Jonathan Sick added a comment - Thanks David Staker [X] and Kian-Tat Lim for the comments!

              People

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

                Dates

                Created:
                Updated:
                Resolved:

                  Jenkins

                  No builds found.