doc: renew tutorial, suggest passive client, restructure heartbeat interval #1543
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bruno-at-bareos
force-pushed
the
dev/bruno/master/doc-suggest-passive-mode
branch
from
65ec057
to
788a17b
Compare
bruno-at-bareos
changed the title
bruno-at-bareos
force-pushed
the
dev/bruno/master/doc-suggest-passive-mode
branch
from
788a17b
to
cfd78a2
Compare
pstorz
requested changes
Sep 21, 2023
bruno-at-bareos
commented
Sep 21, 2023
pstorz
requested changes
Sep 25, 2023
bruno-at-bareos
commented
Sep 25, 2023
- cleanup description from volume interleave data. - fix syntax Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
- add description and since version - fix issue#924 Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
- fix issue#909 by adding a warning into documentation, that in case of director's crash the running and waiting jobs will not get rescheduled Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
bruno-at-bareos
force-pushed
the
dev/bruno/master/doc-suggest-passive-mode
branch
from
e65aae5
to
2158ce5
Compare
- Tutorial refresh
+ reformat long lines
+ adjust indexes for command console
+ redo all samples with recent code and new timestamp format
+ improve systemd example
+ fix typos
- NetworkSetup rename PassiveClient to section-PassiveClient
+ add indexes & keywords
+ add references to the section-PassiveClient
+ set passive client at first.
- Heartbeat Interval:
+ add new section to Network chapter explaining one time the concept
+ add several index, especially missing firewall term
+ add reference to this section in
manually_added_config_directive_descriptions/*heartbeat*.rst.inc
Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
Co-authored-by: Philipp Storz <philipp.storz@bareos.com>
bruno-at-bareos
force-pushed
the
dev/bruno/master/doc-suggest-passive-mode
branch
from
2158ce5
to
9be9d16
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR aims add several references to point people to passive mode for client
The passive mode has many advantages when backing up behind NAT Device or Firewalls, also in other subnets:
Thus, we should emphasize this both in the "add new client" chapter and in the troubleshooting chapter to try passive mode in case the backups do not work. There's already an existing chapter describing TasksAndConcepts/NetworkSetup.html#passive-clients, so we add links to it from several other location.
OP#5505
The second part of the PR is renewing the
HeartbeatIntervalparameter and the associated description.A common section is added to the Network Chapter with indexes and keyword for a better search, (including when searching firewall ). All manually_added_config_directive_descriptions/*HeartbeatInterval.rst.inc have been cleaned up and reference the common section.
OP#5384
The third part is fixing the config-Dir_Director_MaximumConcurrentJobs informations
OP#5547
Please check
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-toolto have some simple automated checks run and a proper changelog record added.General
Source code quality