docs: list 'cla-check.yaml' as optional in tutorial#469
Merged
medubelko merged 1 commit intocanonical:devfrom Dec 5, 2025
Merged
docs: list 'cla-check.yaml' as optional in tutorial#469medubelko merged 1 commit intocanonical:devfrom
medubelko merged 1 commit intocanonical:devfrom
Conversation
medubelko
requested review from
SecondSkoll,
akcano,
dwilding,
minaelee,
rkratky and
tang-mm
as code owners
akcano
approved these changes
Nov 18, 2025
|
|
||
| - :file:`sphinx-python-dependency-build-checks.yml` verifies Python dependencies for the documentation system. If your project has its own dependency checks, it won't need this workflow. | ||
| - :file:`markdown-style-checks.yml` runs the built-in Markdown linter. If your project already validates its Markdown files, it won't need this workflow. | ||
| - :file:`cla-check.yml` verifies whether contributors have signed the `Canonical License Agreement <https://canonical.com/legal/contributors>`_. All Canonical projects require this check, so if you're adding docs to an existing Canonical project that already has it, remove this workflow. |
Contributor
There was a problem hiding this comment.
Suggested change
| - :file:`cla-check.yml` verifies whether contributors have signed the `Canonical License Agreement <https://canonical.com/legal/contributors>`_. All Canonical projects require this check, so if you're adding docs to an existing Canonical project that already has it, remove this workflow. | |
| - :file:`cla-check.yml` verifies whether contributors have signed the `Canonical License Agreement <https://canonical.com/legal/contributors>`_. All Canonical projects require this check, so if you're adding docs to an existing Canonical project that already implements it, remove this workflow. |
SecondSkoll
added a commit
that referenced
this pull request
Dec 10, 2025
* fix: doc slugs and additional initialised Makefile variables (#468) - Switch doc links to `stable` slug. - In Makefile, don't init `SOURCEDIR` and `VENVDIR` variables if they already exist at run time. This lets projects override these dirs in parent build scripts. * ci: make workflows callable by other workflows * chore: add entries from #468 to changelog * docs: remove contributing guide template from index (#471) * fix(build): replace U+2011 chars with hyphens (#472) * docs: list 'cla-check.yaml' as optional in tutorial (#469) * fix: sitemap config (#477) * fix: remove redundancy in sitemap_url_scheme PR #462 introduced fetching the canonical URL from a RTD environment variable. In versioned docs, this URL includes the version, which means that the previous logic to set the sitemap_url_scheme is no longer necessary and duplicates the version (e.g., "../latest/latest/.."). This fix removes the duplication. Since the html_baseurl value falls back to "/", there is also no need to set a separate sitemap_url_scheme for local builds. * doc: update sitemaps how-to guide and changelog Updates sitemaps how-to guide to reflect changes to how html_baseurl is generated and sitemap_url_scheme is set. Updates changelog to reflect removal of duplicate version strings in sitemaps. Signed-off-by: Minae Lee <minae.lee@canonical.com> * chore: 1.3.1 release prep --------- Signed-off-by: Minae Lee <minae.lee@canonical.com> Co-authored-by: Artem Konev <141050460+akcano@users.noreply.github.com> Co-authored-by: Arturo Seijas <arturo.seijas@canonical.com> Co-authored-by: Michael DuBelko <michael.dubelko@canonical.com> Co-authored-by: JJ Coldiron <jj.coldiron@canonical.com> Co-authored-by: Minae Lee <minae.lee@canonical.com>
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
2 participants
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.
- [ ] Have you updatedCHANGELOG.mdwith relevant non-documentation file changes?- [ ] Have you updated the documentation for this change?