Skip to content

docs: large improvement on several chapters#2507

Merged
BareosBot merged 28 commits intobareos:bareos-25from
bruno-at-bareos:backport/bareos-25/docs-fix-volumemanagement-broken-links
Jan 20, 2026
Merged

docs: large improvement on several chapters#2507
BareosBot merged 28 commits intobareos:bareos-25from
bruno-at-bareos:backport/bareos-25/docs-fix-volumemanagement-broken-links

Conversation

@bruno-at-bareos
Copy link
Contributor

@bruno-at-bareos bruno-at-bareos commented Jan 15, 2026

Backport of PR #2460 to bareos-25

Checklist for the reviewer of the PR (will be processed by the Bareos team)

Make sure you check/merge the PR using devtools/pr-tool to have some simple automated checks run and a proper changelog record added.

General
  • Correct milestone is set
Source code quality (if there were changes to the original PR)
  • 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

Backport quality

@bruno-at-bareos bruno-at-bareos added documentation This PR changes only documentation bug This addresses a bug is a backport to 25 This is a backport from master to bareos-25 labels Jan 15, 2026
@bruno-at-bareos bruno-at-bareos added this to the 25.0.2 milestone Jan 15, 2026
@bruno-at-bareos bruno-at-bareos self-assigned this Jan 15, 2026
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!

bruno-at-bareos and others added 22 commits January 20, 2026 15:34
- fix redondant paragraph in VolumeManagement
  The same paragraph was revisited two time during development
  in #a4b65ccbb3 and #2b5109cbc
- Unify volume status rendering by using double backticks
- apply Style Guide for db fields, volume name, volume status
- split long lines
- fix hostname examples
- fix comment lenght in code block

Fix bareos/internal#146

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
Co-authored-by: Philipp Storz <philipp.storz@bareos.com>
(cherry picked from commit be341fe)
- add rule about Volume Status to be enclosed with backticks,
  was previously star enclosed.

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
(cherry picked from commit 7a6d68d)
Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
(cherry picked from commit 07a0e2f)
- apply line length formatting
- remove ``Append`` as possible volstatus for prune/purge operations

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
(cherry picked from commit ae1dbd2)
- long line formatting
- replace `/dev/sg0` by more conventional autochanger device
  `/dev/sch0`
- standardize bareos client name to `bareos-fd`

(cherry picked from commit d5d750d)
- long line formatting
- apply new index formatting
- standardize bareos client name to `bareos-fd`

(cherry picked from commit 8946456)
- long line formatting
- apply new index formatting
- standardize bareos client name to `bareos-fd`

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
(cherry picked from commit 1c5858e)
- long line formatting
- apply new index formatting
- standardize bareos daemon name to `bareos-(fd,sd,dir)`
- use example.com as domain for fqdn

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
(cherry picked from commit 3bb7548)
- long line formatting
- standardize bareos client name to `bareos-`
- migrate oldies (DLT) to more recent device like LTO

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
(cherry picked from commit 251b6be)
- replace old dir version with recent header
- replace old media type with recent standard

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
(cherry picked from commit 38e4855)
- long line formatting
- standardize bareos client name to `bareos-`
- migrate oldies (DLT) to more recent device like LTO
- add notice about the usage of `1` in verify command

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
(cherry picked from commit 4c4a47d)
- standardize bareos client name to `bareos-`
- use coherent bareos version signature

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
(cherry picked from commit 07e7e9e)
- moved from BareosConsole Add Volumes to a Pool section

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
(cherry picked from commit 7e7b023)
- long line formatting
- standardize bareos client name to `bareos-`
- apply Guidelines to bcommand and config:option formating
- revisit some bareos version headers
- moved section Add Volumes to a Pool to VolumeManagement chapter

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
(cherry picked from commit f91b9ef)
- long line formatting
- use generic client name client1,2,3
- refresh some example
- add formating to command
- add note about Maximum Concurrent Jobs in default RestoreFiles job

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
(cherry picked from commit bbcd99f)
- refresh packages list with 25.0.0 latest changes
- introduce remark about availability of feature in subscription
   binaries only
- split long line (100)
- adapt index to new syntax

Fix bareos/internal#542

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
(cherry picked from commit ac786e6)
- added information about anonymized report in console
- added link to webui in console
- added howto get report from webui

Fix bareos/internal#535
Fix bareos/internal#530

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
(cherry picked from commit a027f87)
Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
(cherry picked from commit fb73746)
(cherry picked from commit 9c70ac5)
- Update configuration chapter making 1 the default for all,
  deprecate 5
- Update Verifing chapter with new default value pins1

Fix bareos#2490

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
(cherry picked from commit 7100071)
Co-authored-by: Philipp Storz <philipp.storz@bareos.com>
(cherry picked from commit b74b3c5)
bruno-at-bareos and others added 6 commits January 20, 2026 15:34
(cherry picked from commit ef4a251)
Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
(cherry picked from commit c7e31e4)
Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
(cherry picked from commit 3b0552b)
@BareosBot BareosBot force-pushed the backport/bareos-25/docs-fix-volumemanagement-broken-links branch from f33687a to d520887 Compare January 20, 2026 15:34
@BareosBot BareosBot merged commit 1896fda into bareos:bareos-25 Jan 20, 2026
@bruno-at-bareos bruno-at-bareos deleted the backport/bareos-25/docs-fix-volumemanagement-broken-links branch March 4, 2026 10:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug This addresses a bug documentation This PR changes only documentation is a backport to 25 This is a backport from master to bareos-25

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants