[DM-37471] Documentation infrastructure v.3 and related work - Jira

XML

Word

Printable

Details

Type: Epic
Status: In Progress
Resolution: Unresolved
Fix Version/s: None
Component/s: None
Labels:
None

Epic Name:
sqre-s23-doc-1-ops
Story Points:
60
WBS:
CS002.1.P1.OM.03.06.01.01
Team:
SQuaRE
Cycle:
Spring 2023

Description

The main focus of this epic is exploring the refactoring of the documentation service infrastructure to bring it up to the current services design (eg sqr-072.lsst.io) . This will also resolve a number of performance issues with the current infrastructure that result in occasional indexing errors.

Other work related to deployed documentation services for S23A (Dec-Feb 23) will also be tracked in this epic .

Attachments

Issue Links

is cloned by

DM-37781 Documentation infrastructure v.3 and related work

In Progress

Stories in Epic (Custom Issue Matrix)

Key	Summary	Story Points	Assignee	Status
DM-35297	Noteburst Times Square: Investigate behaviour with notebooks that fail		Jonathan Sick	To Do
DM-33205	Squareone: add a page linking to Swagger UI doc sites of infrastructure services		Jonathan Sick	To Do
DM-33570	Documentation Working Group: Create prototype portal web application	1.8	Jonathan Sick	To Do
DM-35502	Create Kubernetes resource limits for Squareone, Semaphore, Times Square and Noteburst		Jonathan Sick	To Do
DM-35021	Times Square Squareone: Automatically size the page iframe to its content		Jonathan Sick	To Do
DM-34774	www.lsst.io: Add new T&S documentation sites		Jonathan Sick	To Do
DM-34044	Documenteer: Look into compatibility with JupyterLab reStructuredText export		Jonathan Sick	To Do
DM-33972	Documenteer: Modify Sphinx theme for Data Products documentation sites		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-39268	Kafkit: Make MockSchemaRegistry feature complete		Jonathan Sick	To Do
DM-29974	UI design for Gafaelfawr tokens page		Jonathan Sick	To Do
DM-29928	Parallelize ltd upload command		Jonathan Sick	To Do
DM-29879	ltd-conveyor upload problem	1.4	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-28766	Lander 1.0 bug parsing title command in DMTN-180 (aastex) document		Jonathan Sick	To Do
DM-31342	Math roles and directives in numpydoc docstrings aren't being rendered		Jonathan Sick	To Do
DM-27890	Developer Guide: Clear issues in 2020-12-07 weekly test		Jonathan Sick	To Do
DM-38390	Documenteer: resolve automodapi not picking up extension class methods		Jonathan Sick	To Do
DM-37194	documenteer: add sqlalchemy to intersphinx configuration for Pipelines documentation		Jonathan Sick	To Do
DM-38548	rsp.lsst.io: Document Firefox privacy protection issues for JupyterLab		Jonathan Sick	To Do
DM-36866	Phalanx: create Sphinx syntax for structured troubleshooting documentation		Jonathan Sick	To Do
DM-36832	documenteer: Support lists with paragraph level spacing		Jonathan Sick	To Do
DM-22206	Document attribute docstrings using Python type annotations		Jonathan Sick	To Do
DM-24608	www.lsst.io: smooth expand/collapse of card details		Jonathan Sick	To Do
DM-24440	Forwarding from CLO to dm-staff not working		Jonathan Sick	To Do
DM-23929	Please redirect https://vro.org/ to https://www.vro.org/	0.4	Jonathan Sick	To Do
DM-23761	Add safir.events module to help Roundtable apps use SQuaRE Events	1.2	Jonathan Sick	To Do
DM-16900	Cannot generate Sphinx docs for lsst.afw.display.BLACK	0.4	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-25622	Set rel=canonical HTTP header on LSST the Docs		Jonathan Sick	To Do
DM-25616	Migrate to Fastly's built-in configuration features		Jonathan Sick	To Do
DM-24953	Author search from main bar		Jonathan Sick	To Do
DM-23886	Update Sphinx themes to use the new Rubin Observatory / LSST branding		Jonathan Sick	To Do
DM-23851	Kafkit: Support for testing Kafka apps with Docker		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-18435	Support doctests under pytest in CI for pipelines.lsst.io		Jonathan Sick	To Do
DM-15905	Integrate Documenteer's Sphinx building commands with sconsUtils		John Parejko	To Do
DM-21228	Provide places for code design and development documentation	0.8	Jonathan Sick	To Do
DM-21293	Use external-dns for managing Roundtable's DNS entries		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-20804	Create Sphinx extension for labelling script reference pages	1.2	Jonathan Sick	To Do
DM-17064	Support PEP 484 type annotations for populating API reference		Jonathan Sick	To Do
DM-17075	Issue making API reference links to Enum (lsst.afw.math.Interpolate.Style)		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-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-12936	Clarify formatting for parameters		Jonathan Sick	To Do
DM-12926	Clarify return value documentation for Python		Jonathan Sick	To Do
DM-13132	Delete "draft" editions from DM change-controlled document LTD sites	0.2	Jonathan Sick	To Do
DM-10446	Add codekit feature to update Github repository defaults.		Jonathan Sick	To Do
DM-5842	Clearly state what Git commit message and organization workflows are requirements/recommendations		Jonathan Sick	To Do
DM-9037	Document best practices to report an issue with DM system in Developer 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-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-32705	Migrate community.lsst.org to a new DigitalOcean droplet	1.4	Jonathan Sick	In Progress
DM-38718	Semaphore: Post broadcast messages to Slack		Kai Koehler	In Progress
DM-38388	Documenteer: Add exclude path configuration to documenteer.toml		Jonathan Sick	In Progress
DM-25405	Write ops guide (technote) for the community.lsst.org Discourse forum	0.8	Jonathan Sick	In Progress
~~DM-35490~~	GitHub Actions: Create a composite action for building and publishing a Docker image for a Python app	0.7	Jonathan Sick	Done
~~DM-39107~~	Roundtable: Deploy Strimzi kafka-access-operator	1.2	Jonathan Sick	Done
~~DM-39050~~	Update lsst-sqre GitHub actions to work with monorepos	0.5	Jonathan Sick	Done
~~DM-39043~~	Squarebot: Add Kafka producer and client-server monorepo	9.2	Jonathan Sick	Done
~~DM-39014~~	Roundtable: Deploy Strimzi Kafka on Phalanx-based Roundtable	3.9	Jonathan Sick	Done
~~DM-38650~~	Times Square: adopt safir.github and safir.redis	6.3	Jonathan Sick	Done
~~DM-38629~~	noteburst: solve worker auto-shutdown	2.6	Jonathan Sick	Done
~~DM-37746~~	lsstvaultutils: Add requirements to the PyPI packaging	1	Jonathan Sick	Done
~~DM-37921~~	Server and client monorepo for SQuaRE apps: research and development	8.1	Jonathan Sick	Done
~~DM-37524~~	templates: Drop use of setup.cfg in SQuaRE FastAPI template	0.5	Jonathan Sick	Done
~~DM-37522~~	Squarebot: Convert app to FastAPI	12	Jonathan Sick	Done
~~DM-37493~~	Kafkit: Add httpx support for Registry API	2.8	Jonathan Sick	Done
~~DM-37481~~	Documenteer: Resolve emergent GitHub Actions issues	1.4	Jonathan Sick	Done
~~DM-38201~~	Add status pages for COmanage enrollment flow to squareone	8.3	Jonathan Sick	Done
~~DM-37331~~	ook: add command line tool for manually adding a search record	1.4	Jonathan Sick	Done
~~DM-38087~~	rsp.lsst.io: Support accounts documentation for CILogon account set up	0.7	Jonathan Sick	Done
~~DM-38053~~	rsp_lsst_io: Add a environment-switching dropdown	2.1	Jonathan Sick	Done
~~DM-37235~~	rsp.lsst.io: Set up Sphinx documentation site for the Rubin Science Platform	12.6	Jonathan Sick	Done
~~DM-37872~~	Kafkit: Design a Pydantic-based system for Avro message encoding	3.5	Jonathan Sick	Done
~~DM-37857~~	noteburst: switch cachemachine integration to JupyterLab Controller	7	Jonathan Sick	Done
~~DM-37848~~	lsst-texmf: Disable git safe directory checks	0.5	Jonathan Sick	Done
~~DM-37659~~	Phalanx: Add environments for Roundtable	7.7	Jonathan Sick	Done
~~DM-38445~~	noteburst: Update image API models	1.4	Jonathan Sick	Done
~~DM-37164~~	roundtable: set up development instance for Rubin TV	1.4	Jonathan Sick	Done
~~DM-37159~~	rubin-style-dictionary: fully-cropped logo variants	1.4	Jonathan Sick	Done
~~DM-38525~~	Semaphore: make the first line of a notification also the summary		Kai Koehler	Done
~~DM-38168~~	Documenteer: Update guide configuration for compatibility with PyData Sphinx Theme 0.13	0.5	Jonathan Sick	Done
~~DM-38166~~	Squareone: Add links in user dropdown to COmanage Registry	2.3	Jonathan Sick	Done
~~DM-38757~~	safir template errors	0.2	Jonathan Sick	Done
~~DM-38735~~	Noteburst: Fix 500 error when getting a notebook that failed to compute	1.6	Jonathan Sick	Done
~~DM-38801~~	Kafkit: Develop a PydanticSchemaManager	2.8	Jonathan Sick	Done
~~DM-38491~~	Safir: Add Redis storage class	5.4	Jonathan Sick	Done
~~DM-38490~~	Safir: Port GitHub app services and models into Safir	3.7	Jonathan Sick	Done
~~DM-38488~~	semaphore: Fix vault secrets path	0.2	Jonathan Sick	Done
~~DM-38773~~	Safir: Release 4.0.0	0.2	Jonathan Sick	Done
~~DM-37007~~	technote: Iterate on HTML/CSS design and theming structure	13.6	Jonathan Sick	Done
~~DM-37270~~	Set up an lsst.io deployment for sdm_schemas		Jonathan Sick	Won't Fix
~~DM-16948~~	Create an MVP SQuaRE Events app		Jonathan Sick	Won't Fix
~~DM-34776~~	Documenteer: Run technote builds in tox / GitHub Actions		Jonathan Sick	Invalid

Activity

There are no comments yet on this issue.

People

Assignee:: Jonathan Sick

Reporter:: Frossie Economou

Watchers:: Frossie Economou

Votes:: 0 Vote for this issue

Watchers:: 1 Start watching this issue

Dates

Created:: 04/Jan/23 5:58 PM

Updated:: 21/Jun/23 7:10 PM

Jenkins

No builds found.

Data Management