Skip to content

Update docs on documentation check workflow - #35

Open
elijahgreenstein wants to merge 1 commit into
canonical:mainfrom
elijahgreenstein:doc-update-workflows
Open

elijahgreenstein wants to merge 1 commit into
canonical:mainfrom
elijahgreenstein:doc-update-workflows

Conversation

@elijahgreenstein

Copy link
Copy Markdown

This PR depends on a pending update to the GitHub workflow for documentation checks. The update incorporates the workflow into the Sphinx Stack (rather than using the callable workflow from the documentation-workflows repo).

This PR:

  • Adds a new how-to guide, with instructions for how to make common modifications to the workflow
  • Updates the GitHub workflows reference page

@erinecon erinecon left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

LGTM, thanks!

@jahn-junior jahn-junior 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.

Thanks! This looks really good. Just a few suggestions regarding the new page's location and examples.

Comment thread docs/how-to/index.rst Outdated
Comment thread docs/how-to/modify-documentation-check-workflow.rst Outdated
Comment thread docs/how-to/modify-documentation-check-workflow.rst Outdated
Comment thread docs/how-to/modify-documentation-check-workflow.rst Outdated
Comment thread docs/how-to/modify-documentation-check-workflow.rst Outdated
Comment thread docs/how-to/modify-documentation-check-workflow.rst Outdated
This commit updates the documentation for the GitHub workflow that
runs the spelling, link, and inclusive language checks.

- Adds a new how-to guide, with instructions for how to make common
  modifications to the workflow
- Updates the GitHub workflows reference page

This is based on an update to the Sphinx Stack that incorporates the
workflow directly into the Sphinx Stack repo, rather than using callable
workflows from the `documentation-workflows` repository.

Signed-off-by: Elijah Greenstein <elijah.greenstein@canonical.com>
Comment thread docs/reference/github-workflows.rst
@jahn-junior
jahn-junior self-requested a review September 14, 2026 18:06

@jahn-junior jahn-junior 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.

Waiting to merge until the Sphinx Stack 3.0 release

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants