Skip to content

docs: Appendix/Bareos Programs improvements#1255

Merged
joergsteffens merged 2 commits intobareos:masterfrom
bruno-at-bareos:dev/bruno/master/s4989-doc-improve-tools-documentation
Sep 28, 2022
Merged

docs: Appendix/Bareos Programs improvements#1255
joergsteffens merged 2 commits intobareos:masterfrom
bruno-at-bareos:dev/bruno/master/s4989-doc-improve-tools-documentation

Conversation

@bruno-at-bareos
Copy link
Contributor

@bruno-at-bareos bruno-at-bareos commented Sep 9, 2022 •
edited by joergsteffens
Loading

This PR bring improvement to the documentation in Appendix/Bareos Program chapter

  • indexes are updated to Sphinx form
  • refreshed examples
  • tools calls implemented

OP #4989

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
  • Commit descriptions are understandable and well formatted
  • Check backport line
  • Is the PR title usable as CHANGELOG entry?
  • Separate commit for CHANGELOG.md ("update CHANGELOG.md"). The PR number is correct.
Source code quality
  • Required documentation changes are present and part of the PR
  • bareos-check-sources --since-merge does not report any problems

@bruno-at-bareos bruno-at-bareos added draft documentation This PR changes only documentation labels Sep 9, 2022
@bruno-at-bareos bruno-at-bareos self-assigned this Sep 9, 2022
@bruno-at-bareos bruno-at-bareos marked this pull request as draft September 9, 2022 09:52
@bruno-at-bareos bruno-at-bareos force-pushed the dev/bruno/master/s4989-doc-improve-tools-documentation branch 2 times, most recently from 47dd1d7 to b9af703 Compare September 15, 2022 13:24
@bruno-at-bareos bruno-at-bareos marked this pull request as ready for review September 15, 2022 13:26
@bruno-at-bareos bruno-at-bareos changed the title docs: improve tools documentation docs: Appendix/Bareos Programs improvements Sep 15, 2022
@bruno-at-bareos bruno-at-bareos removed their assignment Sep 27, 2022
@joergsteffens joergsteffens self-assigned this Sep 27, 2022
@joergsteffens joergsteffens self-requested a review September 27, 2022 12:25
joergsteffens
joergsteffens requested changes Sep 27, 2022
View reviewed changes
@bruno-at-bareos @joergsteffens
docs: Improving bareos tools section
2fa9b07 
- update sphinx indexes syntax
- unify usage to include tools .txt --help output
- add bsmtp to CMakelist for autogenerated usage
- bareos-dbcopy section Adjust section title level so bareos-dbcopy
  section goes into bareos-tools chapter
- bls renew example with actual data and signatures
  + add ref section for storage-media-output-format
- btape speed section refresh
  + Specify flags name in the example.
  + Add btape program call. [OP #4989]

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/s4989-doc-improve-tools-documentation branch from c2d24b6 to 2fa9b07 Compare September 28, 2022 07:26
@joergsteffens joergsteffens merged commit 69dfd77 into bareos:master Sep 28, 2022
@bruno-at-bareos bruno-at-bareos mentioned this pull request Sep 28, 2022
Merged
13 tasks
@bruno-at-bareos bruno-at-bareos deleted the dev/bruno/master/s4989-doc-improve-tools-documentation branch September 29, 2022 09:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@joergsteffens joergsteffens joergsteffens approved these changes

Assignees

@joergsteffens joergsteffens

Labels

documentation This PR changes only documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@bruno-at-bareos @joergsteffens