Add Instruction for release to check external documentation links #1218
Conversation
This file contains 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
bruno-at-bareos
force-pushed
the
dev/bruno/master/t5188-doc-sphinx-link-checker-release
branch
from
d7a1893
to
cacc730
Compare
- add sphinx-build -M linkcheck docs/manuals/source out -j2 - or make docs-check-urls Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com> Co-authored-by: Jörg Steffens <joergsteffens@users.noreply.github.com>
Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
bruno-at-bareos
force-pushed
the
dev/bruno/master/t5188-doc-sphinx-link-checker-release
branch
from
5800d55
to
76acbf0
Compare
bruno-at-bareos
deleted the
dev/bruno/master/t5188-doc-sphinx-link-checker-release
branch
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.
Beside our wiki page how to release this PR add a comment about running manually the documentation sphinx linkcheck.
Thank you for contributing to the Bareos Project!
Please check
If you have any questions or problems, please give a comment in the PR.
Helpful documentation and best practices
Checklist for the reviewer of the PR (will be processed by the Bareos team)
General