Skip to content

docs: large improvement on several chapters#2460

Merged
BareosBot merged 27 commits intobareos:masterfrom
bruno-at-bareos:docs-fix-volumemanagement-broken-links
Jan 20, 2026
Merged

docs: large improvement on several chapters#2460
BareosBot merged 27 commits intobareos:masterfrom
bruno-at-bareos:docs-fix-volumemanagement-broken-links

Conversation

@bruno-at-bareos
Copy link
Contributor

@bruno-at-bareos bruno-at-bareos commented Nov 27, 2025 •
edited by pstorz
Loading

Large improvements in several chapters

  • VolumeManagement
  • TroubleShooting
  • Appendix/BareosProgams
  • Configuration/Console
  • FileDaemon
  • Monitor
  • Migration/Copy
  • Autochanger
  • Verify
  • "TheWindowsVersion**
  • BareosConsole
  • TheRestoreCommand
  • WhatIsBareos

changes can be resume to:

  • Style Guide Specific Formating Volume Status
    • add rule about Volume Status to be enclosed with backticks,
      was previously star enclosed.
  • uniformise usage of back quote around volume status
  • long line formatting (100)
  • replace /dev/sg0 by more conventional autochanger device /dev/sch0
  • standardize Bareos client name to bareos-fd or unnamed clientX
  • fix broken links
  • Introduce binaries/features differences in subscription repository

Fix bareos/internal#146
Fix bareos/internal#542

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)

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
  • Is the PR title usable as CHANGELOG entry?
  • Purpose of the PR is understood
  • Commit descriptions are understandable and well formatted
  • Required backport PRs have been created
  • Correct milestone is set
  • Servicedesk page is pointing to documentation
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

@bruno-at-bareos bruno-at-bareos added this to the 25.0.0 milestone Nov 27, 2025
@bruno-at-bareos bruno-at-bareos added documentation This PR changes only documentation bug This addresses a bug labels Nov 27, 2025
@bruno-at-bareos bruno-at-bareos self-assigned this Nov 27, 2025
pstorz
pstorz requested changes Nov 27, 2025
View reviewed changes
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.

Hello Bruno,

please see comments

bruno-at-bareos
bruno-at-bareos commented Dec 1, 2025
View reviewed changes
@bruno-at-bareos
Copy link
Contributor Author

bruno-at-bareos commented Dec 1, 2025

@pstorz while we are renewing that chapter, would it make sense to also adapt the Automatic Pruning section. We might want to let it like it is, and modify it only when we come with the new retention concept.

@arogge
Copy link
Member

arogge commented Dec 2, 2025

  • add a section for volume status to the documentation style guide that this should use backticks
  • fix the VolStatus/status/Volume status mess
  • make sure the configuration option values are part of the :config:option: so they are rendered correctly

@arogge arogge modified the milestones: 25.0.0, 25.0.1 Dec 2, 2025
joergsteffens
joergsteffens previously requested changes Dec 4, 2025
View reviewed changes
@bruno-at-bareos bruno-at-bareos force-pushed the docs-fix-volumemanagement-broken-links branch 2 times, most recently from 57e7afb to 753a036 Compare December 4, 2025 15:50
@bruno-at-bareos
Copy link
Contributor Author

bruno-at-bareos commented Dec 4, 2025

I've still a discussion open for recycling algo. and we may want to remove the Job, Files retention as this has been deprecated now.

@bruno-at-bareos bruno-at-bareos changed the title docs fix volumemanagement broken links docs: VolumeManagement chapter large improvement Dec 4, 2025
@arogge arogge modified the milestones: 25.0.1, 25.0.2 Dec 8, 2025
@bruno-at-bareos bruno-at-bareos changed the title docs: VolumeManagement chapter large improvement docs: large improvement on several chapters Dec 18, 2025
@bruno-at-bareos bruno-at-bareos force-pushed the docs-fix-volumemanagement-broken-links branch from 1445a3c to ac786e6 Compare December 18, 2025 13:35
@bruno-at-bareos
Copy link
Contributor Author

bruno-at-bareos commented Dec 18, 2025

@pstorz @joergsteffens I've done what I estimate the needed changes. Sorry seems to be more to reviewed than expected.
I've included the changes about binaries in subscription and refreshed the bareos package list.

I'm wondering, if you accept the challenge :-), if we should also include the changes we have in
bareos/internal#535 about subscription.

@bruno-at-bareos bruno-at-bareos linked an issue Jan 8, 2026 that may be closed by this pull request
Verify get rid of 1,5 and create a new Flag for Signature verification #2490
Closed
1 task
pstorz
pstorz requested changes Jan 14, 2026
View reviewed changes
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!
Please see the comments.

@bruno-at-bareos bruno-at-bareos mentioned this pull request Jan 15, 2026
Merged
7 tasks
@bruno-at-bareos
Copy link
Contributor Author

bruno-at-bareos commented Jan 15, 2026

@pstorz all suggestions changes applied, I've added a few fixes to the bareos table component and also added the variable expansion removal for dir working directory as seen this morning.

I've also already created #2507 so we have all those changes in 25 documentation.
We're now ready for a merge ;-)

@arogge arogge removed this from the 25.0.2 milestone Jan 20, 2026
bruno-at-bareos and others added 27 commits January 20, 2026 15:26
@bruno-at-bareos @pstorz @BareosBot
docs: VolumeManagement chapter large improvement
e597389 
- 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>
@bruno-at-bareos @BareosBot
docs: Style Guide Specific Formating Volume Status
f5dacad 
- add rule about Volume Status to be enclosed with backticks,
  was previously star enclosed.

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
@bruno-at-bareos @BareosBot
docs: fix broken links
d94c111 
Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
@bruno-at-bareos @BareosBot
docs: VolumeManagement chapter
4d64b41 
- apply line length formatting
- remove ``Append`` as possible volstatus for prune/purge operations

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
@bruno-at-bareos @BareosBot
docs: Troubleshooting improvements
5a8d057 
- long line formatting
- replace `/dev/sg0` by more conventional autochanger device
  `/dev/sch0`
- standardize bareos client name to `bareos-fd`
@bruno-at-bareos @BareosBot
docs: standardize bareos client to bareos-fd
71a0a65
@bruno-at-bareos @BareosBot
docs: Console improvements
a3242a7 
- long line formatting
- apply new index formatting
- standardize bareos client name to `bareos-fd`
@bruno-at-bareos @BareosBot
docs: FileDaemon improvements
9f85f80 
- long line formatting
- apply new index formatting
- standardize bareos client name to `bareos-fd`

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
@bruno-at-bareos @BareosBot
docs: Monitor improvements
a8d780c 
- 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>
@bruno-at-bareos @BareosBot
docs: MigrationAndCopy improvements
52cc267 
- 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>
@bruno-at-bareos @BareosBot
docs: AutoChangerSupport improvements
f17ebb9 
- replace old dir version with recent header
- replace old media type with recent standard

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
@bruno-at-bareos @BareosBot
docs: Verify chapter improvements
642e247 
- 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>
@bruno-at-bareos @BareosBot
docs: TheWindowsVersion chapter improvements
f7b8557 
- standardize bareos client name to `bareos-`
- use coherent bareos version signature

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
@bruno-at-bareos @BareosBot
docs: VolumeManagement insert Add Volumes to a Pool section
0ea2cd9 
- moved from BareosConsole Add Volumes to a Pool section

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
@bruno-at-bareos @BareosBot
docs: BareosConsole
f27de04 
- 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>
@bruno-at-bareos @BareosBot
docs: TheRestoreCommand improvement
8fa8297 
- 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>
@bruno-at-bareos @BareosBot
docs: WhatIsBareos introduce subscription binaries only
45e4af1 
- 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>
@bruno-at-bareos @BareosBot
docs: Subscription improvement
9237c27 
- 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>
@bruno-at-bareos @BareosBot
fix wrong domain for next
4657b0a 
Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
@bruno-at-bareos @BareosBot
fix package name to install
dc0e98e
@bruno-at-bareos @BareosBot
docs: update Verify signature option
b40ddbe 
- 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>
@bruno-at-bareos @pstorz @BareosBot
Apply suggestions from code review
b14a0d2 
Co-authored-by: Philipp Storz <philipp.storz@bareos.com>
@bruno-at-bareos @BareosBot
docs: remove unused var expansion
4475dfc
@bruno-at-bareos @BareosBot
docs: add ref link to configuration example
2f283f2
@bruno-at-bareos @BareosBot
adjust component table items
ed1654c 
Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
@bruno-at-bareos @BareosBot
removal of duplicate line volume status
7462a60 
Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
@BareosBot
Update CHANGELOG.md
951cfe4
@BareosBot BareosBot force-pushed the docs-fix-volumemanagement-broken-links branch from 5c5efb4 to 951cfe4 Compare January 20, 2026 15:26
@BareosBot BareosBot merged commit 15944d8 into bareos:master Jan 20, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@pstorz pstorz pstorz approved these changes

@joergsteffens joergsteffens Awaiting requested review from joergsteffens

+1 more reviewer

@odoo-joergsteffens odoo-joergsteffens odoo-joergsteffens left review comments

Reviewers whose approvals may not affect merge requirements

Assignees

@bruno-at-bareos bruno-at-bareos

Labels

bug This addresses a bug documentation This PR changes only documentation requires backport to 25

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Verify get rid of 1,5 and create a new Flag for Signature verification

6 participants

@bruno-at-bareos @arogge @pstorz @joergsteffens @odoo-joergsteffens @BareosBot

Comments