Skip to content

Add Instruction for release to check external documentation links#1218

Merged
pstorz merged 2 commits intobareos:masterfrom
bruno-at-bareos:dev/bruno/master/t5188-doc-sphinx-link-checker-release
Aug 11, 2022
Merged

Add Instruction for release to check external documentation links#1218
pstorz merged 2 commits intobareos:masterfrom
bruno-at-bareos:dev/bruno/master/t5188-doc-sphinx-link-checker-release

Conversation

@bruno-at-bareos
Copy link
Contributor

@bruno-at-bareos bruno-at-bareos commented Aug 10, 2022

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

  • Short description and the purpose of this PR is present above this paragraph
  • Your name is present in the AUTHORS file (optional)

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
  • PR name is meaningful
  • Purpose of the PR is understood
  • Separate commit for this PR in the CHANGELOG.md, PR number referenced is same
  • Commit descriptions are understandable and well formatted

@bruno-at-bareos bruno-at-bareos force-pushed the dev/bruno/master/t5188-doc-sphinx-link-checker-release branch from d7a1893 to cacc730 Compare August 11, 2022 13:03
bruno-at-bareos and others added 2 commits August 11, 2022 15:31
- 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 bruno-at-bareos force-pushed the dev/bruno/master/t5188-doc-sphinx-link-checker-release branch from 5800d55 to 76acbf0 Compare August 11, 2022 13:32
Copy link
Member

@pstorz pstorz left a comment

Choose a reason for hiding this comment

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

Good work!

@pstorz pstorz merged commit 989c498 into bareos:master Aug 11, 2022
@bruno-at-bareos bruno-at-bareos deleted the dev/bruno/master/t5188-doc-sphinx-link-checker-release branch August 23, 2022 08:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants