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

Front-End and Documentation Engineering

    XMLWordPrintable

    Details

    • Type: Epic
    • Status: In Progress
    • Resolution: Unresolved
    • Fix Version/s: None
    • Component/s: Documentation
    • Labels:
      None
    • Epic Name:
      sqre-f22-doceng-2
    • Story Points:
      55
    • WBS:
      1.02C.10.02
    • Team:
      SQuaRE
    • Cycle:
      Fall 2022

      Attachments

        Issue Links

        Stories in Epic (Custom Issue Matrix)

        Key Summary Story Points Assignee Status
        DM-23851

        Kafkit: Support for testing Kafka apps with Docker

        Jonathan Sick To Do
        DM-23929

        Please redirect https://vro.org/ to https://www.vro.org/

        0.4 Jonathan Sick To Do
        DM-33570

        Documentation Working Group: Create prototype portal web application

        1.8 Jonathan Sick To Do
        DM-33205

        Squareone: add a page linking to Swagger UI doc sites of infrastructure services

        Jonathan Sick To Do
        DM-33972

        Documenteer: Modify Sphinx theme for Data Products documentation sites

        Jonathan Sick To Do
        DM-34044

        Documenteer: Look into compatibility with JupyterLab reStructuredText export

        Jonathan Sick To Do
        DM-23761

        Add safir.events module to help Roundtable apps use SQuaRE Events

        1.2 Jonathan Sick To Do
        DM-22206

        Document attribute docstrings using Python type annotations

        Jonathan Sick To Do
        DM-21228

        Provide places for code design and development documentation

        0.8 Jonathan Sick To Do
        DM-28766

        Lander 1.0 bug parsing title command in DMTN-180 (aastex) document

        Jonathan Sick To Do
        DM-29928

        Parallelize ltd upload command

        Jonathan Sick To Do
        DM-24608

        www.lsst.io: smooth expand/collapse of card details

        Jonathan Sick To Do
        DM-24953

        Author search from main bar

        Jonathan Sick To Do
        DM-21293

        Use external-dns for managing Roundtable's DNS entries

        Jonathan Sick To Do
        DM-25616

        Migrate to Fastly's built-in configuration features

        Jonathan Sick To Do
        DM-25622

        Set rel=canonical HTTP header on LSST the Docs

        Jonathan Sick To Do
        DM-25661

        Update LTD Dasher to use Rubin Observatory branding

        Jonathan Sick To Do
        DM-25660

        Update Lander with Rubin Observatory branding

        Jonathan Sick To Do
        DM-25337

        Add a "fail on warnings" mode to Documenteer package-docs build and stack-docs build command

        Jonathan Sick To Do
        DM-35021

        Times Square Squareone: Automatically size the page iframe to its content

        Jonathan Sick To Do
        DM-35297

        Noteburst Times Square: Investigate behaviour with notebooks that fail

        Jonathan Sick To Do
        DM-35202

        Times Square: Add notebook configuration to specify image stream

        Jonathan Sick To Do
        DM-35201

        Noteburst: Run multiple worker queues running the latest weekly and latest daily images in addition to the current recommended

        Jonathan Sick To Do
        DM-34774

        www.lsst.io: Add new T&S documentation sites

        Jonathan Sick To Do
        DM-30781

        Add RSP acceptable use policy to rubin-style-dictionary and Squareone

        Jonathan Sick To Do
        DM-30726

        Semaphore: MVP for a GraphQL API that provides broadcast messages for the RSP

        2.8 Jonathan Sick To Do
        DM-31342

        Math roles and directives in numpydoc docstrings aren't being rendered

        Jonathan Sick To Do
        DM-35490

        GitHub Actions: Create a composite action for building and publishing a Docker image for a Python app

        Jonathan Sick To Do
        DM-35502

        Create Kubernetes resource limits for Squareone, Semaphore, Times Square and Noteburst

        Jonathan Sick To Do
        DM-27890

        Developer Guide: Clear issues in 2020-12-07 weekly test

        Jonathan Sick To Do
        DM-29974

        UI design for Gafaelfawr tokens page

        Jonathan Sick To Do
        DM-29879

        ltd-conveyor upload problem

        1.4 Jonathan Sick To Do
        DM-24440

        Forwarding from CLO to dm-staff not working

        Jonathan Sick To Do
        DM-23996

        Create "kickdrum" app for Roundtable/SQuaRE Events

        Jonathan Sick To Do
        DM-23892

        Support lsst-texmf acronyms and glossaries in Documenteer (targeting technotes initially)

        Jonathan Sick To Do
        DM-23886

        Update Sphinx themes to use the new Rubin Observatory / LSST branding

        Jonathan Sick To Do
        DM-36832

        documenteer: Support lists with paragraph level spacing

        Jonathan Sick To Do
        DM-36866

        Phalanx: create Sphinx syntax for structured troubleshooting documentation

        Jonathan Sick To Do
        DM-20804

        Create Sphinx extension for labelling script reference pages

        1.2 Jonathan Sick To Do
        DM-18435

        Support doctests under pytest in CI for pipelines.lsst.io

        Jonathan Sick To Do
        DM-21119

        Deploy a Schema Registry UI for the Roundtable cluster

        Jonathan Sick To Do
        DM-19574

        Add doxygen C++ documentation to module homepages

        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-16948

        Create an MVP SQuaRE Events app

        Jonathan Sick To Do
        DM-16900

        Cannot generate Sphinx docs for lsst.afw.display.BLACK

        0.4 Jonathan Sick To Do
        DM-17075

        Issue making API reference links to Enum (lsst.afw.math.Interpolate.Style)

        Jonathan Sick To Do
        DM-17064

        Support PEP 484 type annotations for populating API reference

        Jonathan Sick To Do
        DM-15905

        Integrate Documenteer's Sphinx building commands with sconsUtils

        John Parejko To Do
        DM-12055

        Re-write the DM Developer Workflow guide using topic-based writing

        Jonathan Sick To Do
        DM-15107

        LTD Dasher is ignoring "master" branch editions that are different from the "main" edition

        Jonathan Sick To Do
        DM-9037

        Document best practices to report an issue with DM system in Developer Guide

        Jonathan Sick To Do
        DM-13132

        Delete "draft" editions from DM change-controlled document LTD sites

        0.2 Jonathan Sick To Do
        DM-12936

        Clarify formatting for parameters

        Jonathan Sick To Do
        DM-12926

        Clarify return value documentation for Python

        Jonathan Sick To Do
        DM-10446

        Add codekit feature to update Github repository defaults.

        Jonathan Sick To Do
        DM-5217

        Document process for reStructuredText-based Design Documents

        Jonathan Sick To Do
        DM-5216

        Clarify use of whitespace in reStructuredText Style Guide

        Jonathan Sick To Do
        DM-6268

        Clarify how content in a reST directive must be indented

        Jonathan Sick To Do
        DM-6655

        Webpage of flags produced by various stack products

        Jonathan Sick To Do
        DM-5842

        Clearly state what Git commit message and organization workflows are requirements/recommendations

        Jonathan Sick To Do
        DM-37194

        documenteer: add sqlalchemy to intersphinx configuration for Pipelines documentation

        Jonathan Sick To Do
        DM-25405

        Write ops guide (technote) for the community.lsst.org Discourse forum

        0.8 Jonathan Sick In Progress
        DM-32705

        Migrate community.lsst.org to a new DigitalOcean droplet

        1.4 Jonathan Sick In Progress
         
        DM-36698

        lsst-templatebot-aide: Add ADASS and SPIE technote templates

        2 Jonathan Sick Done
         
        DM-36683

        technote: Create an MVP sphinx theme for a single page document

        5.2 Jonathan Sick Done
         
        DM-36681

        templates: integrate new Documenteer user guide theme into square_pypi_package template

        1 Jonathan Sick Done
         
        DM-36680

        Technote: Create the Python package for the Sphinx technote framework

        0.4 Jonathan Sick Done
         
        DM-36665

        Documenteer: Adjust font size and tables in dark mode

        1.5 Jonathan Sick Done
         
        DM-36585

        Phalanx: create automations for documenting Phalanx environments

        9.8 Jonathan Sick Done
         
        DM-36085

        Documenteer: Add a configuration file for user guides

        3.5 Jonathan Sick Done
         
        DM-37134

        cilogon-theme: hide the "remember logon" button

        0.4 Jonathan Sick Done
         
        DM-36353

        Phalanx: Apply new user guide theme and content organization

        12 Jonathan Sick Done
         
        DM-36351

        Documenteer: Add support for opengraph metadata in user guide theme

        1 Jonathan Sick Done
         
        DM-37042

        Update dev guide and sqrbot-jr templates to remove gen2 items

        0.2 Jonathan Sick Done
         
        DM-36117

        Documenteer: Support reading the Sphinx rst_epilog configuration from a file

        0.7 Jonathan Sick Done
         
        DM-36137

        Documenteer: Support documenteer.toml configs for extensions, intersphinx, and nitpick ignore

        2.4 Jonathan Sick Done
         
        DM-36190

        Documenteer: Refine user guide configuration and documenteer.toml

        2 Jonathan Sick Done
         
        DM-36197

        templates: Fix the extra download path in test-report template

        0.1 Jonathan Sick Done
         
        DM-36213

        Documenteer: Improve docs for creating user guides

        3 Jonathan Sick Done
         
        DM-36156

        Safir: Update packaging and move documentation to new PyData-based theme

        2.2 Jonathan Sick Done
         
        DM-36955

        technote: Create a Sphinx abstract directive and handle title and abstract metadata

        2.8 Jonathan Sick Done
         
        DM-36883

        technote: Integrate technote.toml into Sphinx configuration and templating environment.

        4.9 Jonathan Sick Done
         
        DM-36805

        phalanx: Add links to Rubin documents

        0.7 Jonathan Sick Done
         
        DM-36803

        technote: Research and develop metadata/configuration file

        4.2 Jonathan Sick Done
         
        DM-36288

        Help with upgrade of SMTN-004

        0.5 Jonathan Sick Done
         
        DM-36286

        Lander: resolve pypandoc download of pandoc 1.19.1 or upgrade for pandoc 2 compatibility

        1.4 Jonathan Sick Done
         
        DM-36264

        Create a CSS theme for CILogon

        3 Jonathan Sick Done
         
        DM-36259

        Documenteer: Add Mermaid diagram support to the user guide configuration

        1.4 Jonathan Sick Done
         
        DM-35969

        Documenteer: Initial adoption of the pydata-sphinx-theme

        5.6 Jonathan Sick Done
         
        DM-14586

        Documentation for developing Science Pipelines packages is missing a step

        0.4 Jonathan Sick Done
         
        DM-37235

        rsp.lsst.io: Set up Sphinx documentation site for the Rubin Science Platform

        12.6 Jonathan Sick Done
         
        DM-37331

        ook: add command line tool for manually adding a search record

        1.4 Jonathan Sick Done
         
        DM-37007

        technote: Iterate on HTML/CSS design and theming structure

        13.6 Jonathan Sick Done
         
        DM-37159

        rubin-style-dictionary: fully-cropped logo variants

        1.4 Jonathan Sick Done
         
        DM-37164

        roundtable: set up development instance for Rubin TV

        1.4 Jonathan Sick Done
        DM-35567

        Developer Guide: Describe topic based writing and technical writing strategies

        2.1 Jonathan Sick Reviewed
         
        DM-16647

        Capture Bootcamp documentation on pipelines.lsst.io

        Jonathan Sick Won't Fix
         
        DM-6599

        Support wrapping in ReStructuredText "prompt" environnments

        Jonathan Sick Won't Fix
         
        DM-37270

        Set up an lsst.io deployment for sdm_schemas

        Jonathan Sick Won't Fix
         
        DM-17844

        Add support for documenting argparse-based CLIs to documenteer

        Jonathan Sick Invalid
         
        DM-20455

        Python module cross-reference links not working

        Jonathan Sick Invalid
         
        DM-17063

        Label asyncio coroutines in Sphinx Python API reference documentation

        Jonathan Sick Invalid
         
        DM-14207

        Convert Task docstrings to Numpydoc and migrate Task documentation to reStructuredText

        Jonathan Sick Invalid
         
        DM-5065

        Port ‘Getting started with stack development’ page from DM’s Confluence

        Jonathan Sick Invalid
         
        DM-5063

        Page with links to DM documents and code resources for Developer Guide

        0.3 Jonathan Sick Invalid
         
        DM-5062

        Write introduction to documentation writing

        Jonathan Sick Invalid
         
        DM-7375

        Update lsst-dev instructions to explain how to load {{ds9}} and give full host name in {{xpra}} example

        Jonathan Sick Invalid
         
        DM-34776

        Documenteer: Run technote builds in tox / GitHub Actions

        Jonathan Sick Invalid

          Activity

          There are no comments yet on this issue.

            People

            Assignee:
            jsick Jonathan Sick
            Reporter:
            frossie Frossie Economou
            Reviewers:
            Frossie Economou
            Watchers:
            Frossie Economou
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated:

                Jenkins

                No builds found.