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

Technote Platform Development Backlog Epic

    XMLWordPrintable

    Details

    • Epic Name:
      sqre-backlog-technote-platform
    • Team:
      SQuaRE
    • Cycle:
      None

      Description

      Backlog epic to collect unscheduled stories for SQuaRE technote and document platform development.

      Do not mark stories in this epic as done. Move the story to a scheduled epic first.

      Topics:

      • Sphinx document themes, templates, extensions, and build systems.
      • LaTeX document themes, templates, and build systems.
      • Jupyter notebooks as a document format.
      • Chatops automations to create technotes with Slack.
      • Integrations with DocuShare.
      • Integrations with Zenodo (or any DOI provider) and ADS.

      The backlog for LSST the Docs infrastructure is DM-6187.

        Attachments

          Issue Links

          Stories in Epic (Custom Issue Matrix)

          Key Summary Story Points Assignee Status
          DM-17987

          "Edit on GitHub" link is broken for technotes from notebooks

          Jonathan Sick To Do
          DM-16094

          Reduce print font size in Sphinx technotes

          Jonathan Sick To Do
          DM-20840

          Determine why the git-based date for https://dmtn-111.lsst.io/v/u-ktl-clarify-nb/ didn't update

          Jonathan Sick To Do
          DM-11416

          Enhanced BibTeX reStructuredText/Sphinx citation roles - research and planning

          Jonathan Sick To Do
          DM-11358

          Fix pybtex URL parsing

          Jonathan Sick To Do
          DM-6088

          Support MathJax/LaTeX math macros in Sphinx project

          Jonathan Sick To Do
          DM-5971

          Make technote-bootstrap conda-friendly

          0.2 Jonathan Sick To Do
          DM-5731

          Support Jupyter notebooks in technotes

          Jonathan Sick To Do
          DM-5354

          Think about how to deal with comments to Technotes

          Jonathan Sick To Do
          DM-4725

          Implement zenodio.upload

          Jonathan Sick To Do
          DM-4715

          Use wkhtmltopdf to include a PDF preview of technotes for archival in Zenodo

          Jonathan Sick To Do
          DM-4452

          HTML5 Sphinx theme for technotes

          2 Jonathan Sick To Do
          DM-10644

          Docushare - Slack integration

          Unassigned To Do
          DM-9844

          Engineer and document a technote deprecation process

          0.2 Jonathan Sick In Progress
           
          DM-9763

          Port uservice-ccutter to uwsgi

          1 Adam Thornton Done
           
          DM-9723

          Use Chatbot to create -000 technotes for series that lack them

          Adam Thornton Done
           
          DM-5215

          Provision ls.st short links for Technotes

          Jonathan Sick Done
           
          DM-16081

          error when trying to create a python package

          0 Jonathan Sick Won't Fix
           
          DM-4380

          Technote Platform Wishlist

          Jonathan Sick Won't Fix
           
          DM-4726

          Implement a techno init command to create new technotes

          Jonathan Sick Won't Fix
           
          DM-10960

          Publish LSE-319 LaTeX document to LSST the Docs

          0 Jonathan Sick Invalid
           
          DM-11194

          Implement lsst-texmf as a submodule in LaTeX document cookiecutter templates

          Jonathan Sick Invalid
           
          DM-6267

          Gracefully handle Git revision dates in technotes

          Jonathan Sick Invalid
           
          DM-4602

          Support LaTeX/PDF documents with technote infrastructure

          Jonathan Sick Invalid
           
          DM-13113

          Wireframe www.lsst.io IA/UX

          Jonathan Sick Invalid

            Activity

            No builds found.
            jsick Jonathan Sick created issue -
            jsick Jonathan Sick made changes -
            Field Original Value New Value
            Epic Child DM-4380 [ 21509 ]
            jsick Jonathan Sick made changes -
            Epic Name technote-platform sqre-technote-platform
            jsick Jonathan Sick made changes -
            Epic Child DM-4452 [ 21598 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-5354 [ 23151 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-5215 [ 22932 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-4726 [ 21974 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-4725 [ 21973 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-4715 [ 21963 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-4602 [ 21830 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-5731 [ 23741 ]
            frossie Frossie Economou made changes -
            Link This issue blocks DLP-337 [ DLP-337 ]
            frossie Frossie Economou made changes -
            Link This issue blocks DLP-337 [ DLP-337 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-5971 [ 24187 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-6033 [ 24342 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-6088 [ 24433 ]
            frossie Frossie Economou made changes -
            Epic Child DM-6120 [ 24614 ]
            frossie Frossie Economou made changes -
            Epic Name sqre-technote-platform sqre-backlog-technote-platform
            frossie Frossie Economou made changes -
            Labels technote-platform backlog technote-platform
            frossie Frossie Economou made changes -
            Cycle Fall 2016 [ 10803 ] None [ 10812 ]
            frossie Frossie Economou made changes -
            Epic Child DM-4452 [ 21598 ]
            frossie Frossie Economou made changes -
            Epic Child DM-6033 [ 24342 ]
            frossie Frossie Economou made changes -
            Epic Child DM-5971 [ 24187 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-6267 [ 24785 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-4452 [ 21598 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-5971 [ 24187 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-6033 [ 24342 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-8817 [ 29029 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-6120 [ 24614 ]
            athornton Adam Thornton made changes -
            Epic Child DM-9723 [ 30968 ]
            athornton Adam Thornton made changes -
            Epic Child DM-9763 [ 31105 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-9844 [ 31227 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-11358 [ 33589 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-6033 [ 24342 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-10923 [ 32975 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-10928 [ 32985 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-11194 [ 33338 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-11416 [ 33662 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-8817 [ 29029 ]
            jsick Jonathan Sick made changes -
            Description This technote supports the development of Sphinx-based platforms for technical notes and design documents written in reStructuredText. Note that some of the Sphinx extension development here may benefit software documentation projects. This Epic also relates to LSST the Docs support as they related to technote/design doc automation.

            *Provisional goals:*

            - Automated provisioning of new technical notes on GitHub and LSST the Docs.
            - Improved web design that can effectively support printed PDF depositions for Zenodo/DocuShare.
            - Automated workflow for uploading technotes to Zenodo (or other DOI provider) and ADS
            - Sphinx extension support for Jupyter notebook content
            - Sphinx extension support for bibliographies that integrate with BibTex (using [sphinxcontrib.bibtex|https://github.com/mcmtroffaes/sphinxcontrib-bibtex]) with custom extensions to support getting bibliographic data dynamically/automatically from ADS.
            Backlog epic to collect unscheduled stories for SQuaRE technote and document platform development.

            *Do not mark stories in this epic as done. Move the story to a scheduled epic first.*

            *Topics:*

            - Sphinx document themes, templates, extensions, and build systems.
            - LaTeX document themes, templates, and build systems.
            - Jupyter notebooks as a document format.
            - Chatops automations to create technotes with Slack.
            - Integrations with DocuShare.
            - Integrations with Zenodo (or any DOI provider) and ADS.

            The backlog for LSST the Docs infrastructure is DM-6187.
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-6187 [ DM-6187 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-10960 [ 33027 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-11821 [ 34315 ]
            jsick Jonathan Sick made changes -
            Link This issue relates to DM-11854 [ DM-11854 ]
            jsick Jonathan Sick made changes -
            Summary Technote Platform Development Technote Platform Development Backlog Epic
            jsick Jonathan Sick made changes -
            Epic Child DM-11821 [ 34315 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-10928 [ 32985 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-10923 [ 32975 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-13113 [ 37090 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-10644 [ 32593 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-14360 [ 71143 ]
            jsick Jonathan Sick made changes -
            Epic Name sqre-backlog-technote-platform DM-15819
            jsick Jonathan Sick made changes -
            Epic Name DM-15819 sqre-backlog-technotes
            jsick Jonathan Sick made changes -
            Epic Name sqre-backlog-technotes sqre-backlog-technote-platform
            jsick Jonathan Sick made changes -
            Epic Child DM-14360 [ 71143 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-16081 [ 224850 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-16094 [ 225021 ]
            krughoff Simon Krughoff made changes -
            Epic Child DM-17987 [ 240517 ]
            jsick Jonathan Sick made changes -
            Epic Child DM-20840 [ 375569 ]

              People

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

                Dates

                Created:
                Updated:

                  Summary Panel

                    CI Builds

                    No builds found.