Skip to content

backport documentation improvements#1246

Merged
joergsteffens merged 10 commits intobareos:bareos-21from
bruno-at-bareos:dev/bruno/bareos-21/docs-backport-improvements
Sep 1, 2022
Merged

backport documentation improvements#1246
joergsteffens merged 10 commits intobareos:bareos-21from
bruno-at-bareos:dev/bruno/bareos-21/docs-backport-improvements

Conversation

@bruno-at-bareos
Copy link
Contributor

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

This PR is documentation backport of #1227 #1228 #1229 #1230 #1231 #1233 #1235 to bareos-21

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
  • If backport: add original PR number and target branch at top of this file: Backport of PR#000 to bareos-2x
Source code quality
  • Source code changes are understandable
  • Variable and function names are meaningful
  • Code comments are correct (logically and spelling)
  • Required documentation changes are present and part of the PR
  • bareos-check-sources --since-merge does not report any problems
  • git status should not report modifications in the source tree after building and testing

@bruno-at-bareos bruno-at-bareos added is a backport to 21 documentation This PR changes only documentation labels Aug 31, 2022
@bruno-at-bareos bruno-at-bareos force-pushed the dev/bruno/bareos-21/docs-backport-improvements branch from 974168c to 498ddc2 Compare August 31, 2022 12:02
Copy link
Member

@joergsteffens joergsteffens left a comment

Choose a reason for hiding this comment

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

Almost done. However, you add some CHANGELOG entries in the second last commit and remove them by the last commit. Is this done intentionally?

@bruno-at-bareos bruno-at-bareos force-pushed the dev/bruno/bareos-21/docs-backport-improvements branch from bf604b8 to 728c812 Compare September 1, 2022 11:55
bruno-at-bareos and others added 10 commits September 1, 2022 16:10
Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
- add a link to each section to FileSet Examples where the usage is explained.
- add :bcommand:`estimate job=job-name listing` when estimate is shown
- fix typos, and spacing.

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
Co-authored-by: Jörg Steffens <joergsteffens@users.noreply.github.com>
- show query example for `Selection Pattern` when `Selection Type` is Sql Query.

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
Co-authored-by: Jörg Steffens <joergsteffens@users.noreply.github.com>
- add description to describe SHA256 and SHA512.
- add reference to SHA2 (256,512) to WhatIsBareos.
- add description about MD5 validity for checksumming.

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
Co-authored-by: Philipp Storz <philipp.storz@bareos.com>
- fix paragraph with new numbers and formulas close [BUG bareos#1477]

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
Co-authored-by: Philipp Storz <philipp.storz@bareos.com>
- convert indexes and codeblock to Sphinx rest syntax.
- remove obsolete content (tcpwrapper,media volwrite integer).
- refresh examples.

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
Co-authored-by: Jörg Steffens <joergsteffens@users.noreply.github.com>
- add section for debuging core file
- add section how to install dbg, debuginfo packages
- review and adapt index to Sphinx

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
Co-authored-by: Philipp Storz <philipp.storz@bareos.com>
Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
- add a warning needed full or diff after a pitr.

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
Co-authored-by: Philipp Storz <philipp.storz@bareos.com>
Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
@bruno-at-bareos bruno-at-bareos force-pushed the dev/bruno/bareos-21/docs-backport-improvements branch from 728c812 to 66d00d0 Compare September 1, 2022 14:10
@joergsteffens joergsteffens merged commit cdd871d into bareos:bareos-21 Sep 1, 2022
@bruno-at-bareos bruno-at-bareos deleted the dev/bruno/bareos-21/docs-backport-improvements branch September 5, 2022 07:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation This PR changes only documentation is a backport to 21

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants