docs: Set up RTD documentation project#448
Draft
erinecon wants to merge 7 commits into
Draft
Conversation
- Copy Sphinx starter pack files - Create docs_rtd.yaml workflow for RTD checks - Add CLA check workflow - Configure conf.py with project settings - Add Mermaid extension and fix diagram fences - Pin all dependencies in requirements.txt Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Add SEO metadata and toctrees to index files - Create explanation/index.md landing page - Add reference targets to all documentation files - Set up cookie banner and URL-rewrite script - Convert blockquote admonitions to MyST syntax - Update internal links to use ref targets Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
- Create contribute.rst page from template - Update Juju links to use intersphinx refs - Add Documentation section to README - Update repository files (.licenserc.yaml, docs.yaml, pyproject.toml) - Fix heading levels and markdown formatting - Add pymarkdown config for linting Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
Author
|
Moving to a draft so I can inspect the output and iterate on the skill that put this PR together. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
This PR sets up a Read the Docs (RTD) documentation project for the Discourse charm, migrating from Charmhub-hosted documentation to a Sphinx/RTD-based setup using the Canonical starter pack.
Changes
Phase 1: Project setup
.readthedocs.yaml, conf.py, Makefile, etc.)docs_rtd.yamlworkflow for RTD CI checksconf.pywith project-specific settingsrequirements.txtPhase 2: Content structure
explanation/index.mdlanding pagePhase 3: Finalization
contribute.rstpage from templateREADME.mdFor reviewers
High priority — verify correctness
docs/conf.pydocs/_static/js/overwrite_links.jsnewDomainis set tocanonical.com/juju/docs/discourse-k8s-charm;oldDomainis<<RtDURL>>placeholderdocs/index.mddocs/how-to/contribute.rstdocs/explanation/index.mddocs/how-to/index.md,docs/reference/index.mdREADME.mdMedium priority — structural and CI changes
.github/workflows/docs_rtd.yaml.github/workflows/docs.yamlvale-filesscoping addeddocs/requirements.txt.licenserc.yamlpaths-ignorefor docspyproject.toml.github/pull_request_template.mdLow priority — copied verbatim from the starter pack (click to expand)
.readthedocs.yamldocs/.gitignoredocs/Makefiledocs/_templates/*.github/workflows/cla-check.ymldocs/redirects.txtdocs/.custom_wordlist.txtdocs/_dev/.pymarkdown.jsonItems requiring human action
Set up the RTD project in Read the Docs
docs/rtd-setupinitially, switch tomainafter mergeUpdate
oldDomainindocs/_static/js/overwrite_links.jsonce the RTD URL is knownUpdate
docs/how-to/contribute.rst— review TODO commentsUpdate
charmcraft.yamlormetadata.yaml— updatedocumentationkey once the RTD URL is knownRun quality checks before merge:
Post-merge: Update RTD backend to use
mainas default branch; set version to PublicPre-existing issues
Some markdown lint errors remain from the source documentation (blank lines around code fences, etc.). These are pre-existing and should be addressed in a follow-up PR if needed.