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

Create landing page generator for PDF documents on LSST the Docs.

    XMLWordPrintable

    Details

      Description

      This ticket sees the creation of a new generator for landing pages of PDF (and LaTeX) documents on the web. The specs are:

      • PDF is shown and linked from the landing page.
      • Metadata about the document are also shown on the landing page to aid search engines.
      • Landing pages are expected to be deployed on LSST the Docs and integrate with that platform's versioning system.
      • Runnable from a CI environment, like Travis.
      • The generator itself should be written in Python for maintainability by the LSST and Data Management organizations.

        Attachments

          Activity

          Hide
          jsick Jonathan Sick added a comment -

          Active repos:

          Show
          jsick Jonathan Sick added a comment - Active repos: https://github.com/lsst-sqre/lander (main project) https://github.com/lsst-sqre/squared (centralized CSS library)
          Hide
          jsick Jonathan Sick added a comment - - edited

          This is the much anticipated first release of the landing page project. More needs to be done (see Lander PR), but I think it's a good idea to put this into review now that it's a minimum viable product.

          PRs are:

          Example: https://dmtn-044.lsst.io/v/DM-10503/index.html

          Show
          jsick Jonathan Sick added a comment - - edited This is the much anticipated first release of the landing page project. More needs to be done (see Lander PR), but I think it's a good idea to put this into review now that it's a minimum viable product. PRs are: https://github.com/lsst-sqre/lander/pull/1 (primary) https://github.com/lsst-sqre/metasrc/pull/1 https://github.com/lsst-sqre/squared/pull/1 Example: https://dmtn-044.lsst.io/v/DM-10503/index.html
          Hide
          jsick Jonathan Sick added a comment -
          Show
          jsick Jonathan Sick added a comment - Example screenshot https://dmtn-044.lsst.io/v/DM-10503/index.html
          Hide
          tjenness Tim Jenness added a comment -

          I haven't had a chance to look at all the code in lander but I really like the end result.

          Show
          tjenness Tim Jenness added a comment - I haven't had a chance to look at all the code in lander but I really like the end result.
          Hide
          jsick Jonathan Sick added a comment -

          Thanks Tim Jenness. The package is available as pip install lander==0.1.0 and I'll begin incremental improvements. I think I can start adding lander to projects, allowing versions to float between 0.1.0 and <0.2.0 so that documents receive design improvements but are assured to have CLI compatibility.

          Show
          jsick Jonathan Sick added a comment - Thanks Tim Jenness . The package is available as pip install lander==0.1.0 and I'll begin incremental improvements. I think I can start adding lander to projects, allowing versions to float between 0.1.0 and <0.2.0 so that documents receive design improvements but are assured to have CLI compatibility.
          Hide
          swinbank John Swinbank added a comment -

          Hey Jonathan Sick, Tim Jenness — I see there's still an open tickets/DM-105030 PR in DMTN-044 (https://github.com/lsst-dm/dmtn-044/pull/2) but it also seems to have a nice PDF landing page at https://dmtn-044.lsst.io. Is that PR still relevant? Should we merge it or close it?

          Show
          swinbank John Swinbank added a comment - Hey Jonathan Sick , Tim Jenness — I see there's still an open tickets/DM-105030 PR in DMTN-044 ( https://github.com/lsst-dm/dmtn-044/pull/2 ) but it also seems to have a nice PDF landing page at https://dmtn-044.lsst.io . Is that PR still relevant? Should we merge it or close it?
          Hide
          jsick Jonathan Sick added a comment -

          Right, I was prototyping on your document. I'll update and merge it.

          Show
          jsick Jonathan Sick added a comment - Right, I was prototyping on your document. I'll update and merge it.

            People

            Assignee:
            jsick Jonathan Sick
            Reporter:
            jsick Jonathan Sick
            Reviewers:
            Tim Jenness
            Watchers:
            John Swinbank, Jonathan Sick, Tim Jenness
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Dates

              Created:
              Updated:
              Resolved:

                CI Builds

                No builds found.