Skip to content

fix(docs): add version to style guide redirects#453

Merged
jahn-junior merged 4 commits into
mainfrom
work/fix-redirects
Oct 31, 2025
Merged

fix(docs): add version to style guide redirects#453
jahn-junior merged 4 commits into
mainfrom
work/fix-redirects

Conversation

@jahn-junior

@jahn-junior jahn-junior commented Oct 14, 2025 •
edited
Loading

Copy link
Copy Markdown
Collaborator
  • Have you updated CHANGELOG.md with relevant non-documentation file changes?
  • Have you updated the documentation for this change?

The current docs redirects specify an absolute path with no version, resulting in a 404 (example).

medubelko
medubelko requested changes Oct 14, 2025
View reviewed changes
Comment thread CHANGELOG.md Outdated
Comment thread docs/conf.py Outdated
@jahn-junior jahn-junior marked this pull request as draft October 14, 2025 19:54
minaelee
minaelee suggested changes Oct 15, 2025
View reviewed changes

@minaelee minaelee left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Try it this way.

Comment thread docs/conf.py Outdated
@jahn-junior
docs: use relative redirects
859b441 
Co-authored-by: Minae Lee <minae.lee@canonical.com>
@jahn-junior

jahn-junior commented Oct 31, 2025 •
edited
Loading

Copy link
Copy Markdown
Collaborator Author

I'd like to explore switching to rediraffe in the future, as it does a better job of separating Sphinx and RTD concerns. Opening this up for review as a band-aid fix in the meantime.

@jahn-junior jahn-junior marked this pull request as ready for review October 31, 2025 23:08
medubelko
medubelko approved these changes Oct 31, 2025
View reviewed changes

@medubelko medubelko left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM and works in testing.

minaelee
minaelee approved these changes Oct 31, 2025
View reviewed changes

@minaelee minaelee left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks JJ!

@jahn-junior jahn-junior merged commit fece8a7 into main Oct 31, 2025
7 checks passed
@jahn-junior jahn-junior deleted the work/fix-redirects branch October 31, 2025 23:33
SecondSkoll added a commit that referenced this pull request Nov 13, 2025
@SecondSkoll @waveform80
@dwilding @erinecon @rkratky @medubelko @tarek-y-ismail @lengau @k-dimple @AnneCYH @akcano @jahn-junior @AshleyCliff @msuchane @MggMuggins @network-charles
feat: Update stable branch with 1.3.0 release (#465)
e2d12d7 
* fix: CLA check to run on PRs only

* refactor: Replace build_metrics.sh with something nicer (#373)

* Replace build_metrics.sh with something nicer

* docs: update changelog

* docs: fix info about setting RTD key as GitHub deploy key (#423)

* fix: spelling mistake in update script (#425)

* fix spelling mistake in update script

* add change to CHANGELOG.md

* Add warning to set-up-automated-testing.rst (#427)

* feat: exclude generated pages from sitemap by default, document wildcards (#429)

* add info about wildcard excludes

* add placeholder sitemap_excludes in conf.py

* adjust wording of comment

* enable typical sitemap_excludes by default

* use consistent wording and formatting

* Use long parameter for 'fail on warning' (#430)

* docs: add troubleshooting how-to (#432)

Add tag desync as the first issue.

* Fix stale references to `custom_conf.py` (#433)

* fix(ci): make check-removed-urls work with private forks (#437)

* fix(ci): make check-removed-urls work with private forks

Fixes #436

* docs: update changelog

* chore: add `CODEOWNERS` (#439)

* chore: add `CODEOWNERS`

Enumerate individual reviewers for now.

Later, we can add a Sphinx development team, once we've established one.

* docs: add #438 to changelog

* chore: missing hyphen

Co-authored-by: Michael Park <michael.park@canonical.com>

* chore: revert changelog entry

Co-authored-by: Michael Park <michael.park@canonical.com>

---------

Co-authored-by: Michael Park <michael.park@canonical.com>

* Update Open Graph image URL in conf.py (#441)

The preview image being used was an old one, and the design team has suggested the use of this one instead.

* Update workflow action versions (#445)

* update workflow action versions

* update changelog

* Update CHANGELOG.md

Co-authored-by: Dave Wilding <david.wilding@canonical.com>

---------

Co-authored-by: Dave Wilding <david.wilding@canonical.com>

* Fix whitespace and executable flag of scripts (#448)

* make scripts executable

* remove whitespace from vale script

* update CHANGELOG.md

* docs: add how-to guide for Mermaid diagramming tool (#442)

Signed-off-by: annecyh <anne.chew@canonical.com>

* Move from canonical-sphinx-exensions to individual packages (#449)

* Move from canonical-sphinx-exensions to individual packages

* Update CHANGELOG.md

* build(deps): bump sphinx-terminal to v0.1.1 (#454)

* docs: add how-to guide for sphinx autodoc extension (#450)

* docs: update how to index.rst add autodocs

* docs: create autodocs.md

* fix: conf file formatting in autodocs.md

* fix: fix conf.py formatting in autodocs.md

* fix: pr comment updates

* fix: requested pr changes

Signed-off-by: Ashley Cliff <ashley.cliff@canonical.com>

* fix: autodoc table formatting

Signed-off-by: Ashley Cliff <ashley.cliff@canonical.com>

* docs: update changelog for autodoc

Signed-off-by: Ashley Cliff <ashley.cliff@canonical.com>

* fix: autodoc spell fix

Signed-off-by: Ashley Cliff <ashley.cliff@canonical.com>

* fix: autodoc formatting

Signed-off-by: Ashley Cliff <ashley.cliff@canonical.com>

---------

Signed-off-by: Ashley Cliff <ashley.cliff@canonical.com>

* build: move Vale dependencies to requirements.txt (#456)

* move Vale dependencies to requirements.txt

* add PR link to CHANGELOG.md

* Add OpenAPI how-to guide (#446)

* Add OpenAPI how-to guide

* Include RTD steps in OpenAPI how-to guide

* docs: add guidelines for using custom base templates (#455)

* docs: add guidelines for using custom base templates

Signed-off-by: annecyh <anne.chew@canonical.com>

* docs: add a how-to guide for data tables (#451)

* add first draft of data tables guide

* add data tables guide to index

* add details about Sphinx DataTables

* adjust wording

* update landing page per suggestion

* adjust wording

* mention new doc in CHANGELOG

* remove full stop

* put links in alphabetical order

* use reST formatting

* explain purpose of links and remove duplicated links

* improve wording per review

* docs: consolidate custom template information (#459)

Signed-off-by: annecyh <anne.chew@canonical.com>

* Details about sphinx-terminal (#447)

* Details about sphinx-terminal

* Describe the terminal copy button

Co-authored-by: JJ Coldiron <jj.coldiron@canonical.com>

* fix(build): remove em dash from fallback target (#461)

 #388 introduced an emdash in the makefile that was almost certainly not
intended; this causes the fallthrough case to infinitely recurse.

---------

Signed-off-by: Wesley Hershberger <wesley.hershberger@gmail.com>
Co-authored-by: Michael DuBelko <michael.dubelko@gmail.com>

* feat!: incorporate redesigned terminal (#460)

* fix(docs): update style guide redirects (#453)

* docs: add step to remove CODEOWNERS in the tutorial (#458)

Reorganise the first two sections so copying and pruning files are
discrete actions.

* Ensure update_sp.py is executable from any directory not just docs/ (#424)

* ensure this file is executable from any directory not just docs/

* Add a new line

* update requirements.txt path

* update NEWFILES.txt path

* chore: refactor makefile (#426)

Co-authored-by: Michael Park <michael.park@canonical.com>

* chore: Remove `ALLFILES` from makefile (#434)

* Remove `ALLFILES` from Makefile

* Update changelog

---------

Co-authored-by: Michael Park <michael.park@canonical.com>

* feat: better canonical URL support (#462)

* fix: config for canonical URL

* docs: update html_baseurl context in conf file

* Update CHANGELOG.md

* Update CHANGELOG.md

* chore: reword changelog entry

* chore: bump version

* fix: CHANGELOG

* fix: spelling issues

---------

Signed-off-by: annecyh <anne.chew@canonical.com>
Signed-off-by: Ashley Cliff <ashley.cliff@canonical.com>
Signed-off-by: Wesley Hershberger <wesley.hershberger@gmail.com>
Co-authored-by: Dave Jones <dave@waveform.org.uk>
Co-authored-by: Dave Wilding <david.wilding@canonical.com>
Co-authored-by: Erin Conley <erin.conley@canonical.com>
Co-authored-by: Robert Krátký <robert.kratky@canonical.com>
Co-authored-by: Michael DuBelko <michael.dubelko@canonical.com>
Co-authored-by: tarek-y-ismail <tarek.ismail@canonical.com>
Co-authored-by: Alex Lowe <alex.lowe@canonical.com>
Co-authored-by: Dimple Kuriakose <123362247+k-dimple@users.noreply.github.com>
Co-authored-by: AnneCYH <anne.chew@canonical.com>
Co-authored-by: Artem Konev <141050460+akcano@users.noreply.github.com>
Co-authored-by: JJ Coldiron <jj.coldiron@canonical.com>
Co-authored-by: Ashley Cliff <ashley.cliff@canonical.com>
Co-authored-by: Marek Suchánek <marek.suchanek@canonical.com>
Co-authored-by: Wesley Hershberger <wesley.hershberger@canonical.com>
Co-authored-by: Michael DuBelko <michael.dubelko@gmail.com>
Co-authored-by: Charles Uneze <charlesniklaus@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@medubelko medubelko medubelko approved these changes
@akcano akcano Awaiting requested review from akcano akcano is a code owner
@dwilding dwilding Awaiting requested review from dwilding dwilding is a code owner
@rkratky rkratky Awaiting requested review from rkratky rkratky is a code owner
@SecondSkoll SecondSkoll Awaiting requested review from SecondSkoll SecondSkoll is a code owner
@tang-mm tang-mm Awaiting requested review from tang-mm tang-mm is a code owner
+1 more reviewer
@minaelee minaelee minaelee approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@jahn-junior @minaelee @medubelko @SecondSkoll @akcano