Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: improvements for droplet, jobdefs #1581

Conversation

bruno-at-bareos
Copy link
Contributor

@bruno-at-bareos bruno-at-bareos commented Oct 30, 2023

This Pr aims to improve part of the documentation:

  • fix droplet profile example by removing non supported comment issue #1534
  • add limitation section about chunks 9999 limit
  • Explain that parameter like runscript in jobdefs will be added instead of replaced.
  • Update Maximum Concurrent Jobs to 10 for default restore job, add comment in migration/copy section
  • Include files for ktls

OP#5484
OP#5227
OP#5610

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
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 draft documentation This PR changes only documentation labels Oct 30, 2023
@bruno-at-bareos bruno-at-bareos marked this pull request as draft October 30, 2023 16:27
@bruno-at-bareos bruno-at-bareos force-pushed the dev/bruno/master/doc-fix-droplet-comments branch from cca1320 to 1a1ac00 Compare November 6, 2023 09:53
@bruno-at-bareos bruno-at-bareos marked this pull request as ready for review November 7, 2023 13:58
@bruno-at-bareos bruno-at-bareos force-pushed the dev/bruno/master/doc-fix-droplet-comments branch 3 times, most recently from 7fc5a52 to a90f5c3 Compare November 7, 2023 16:37
@bruno-at-bareos bruno-at-bareos assigned sduehr and unassigned arogge Nov 9, 2023
@bruno-at-bareos bruno-at-bareos requested review from sduehr and removed request for arogge November 9, 2023 11:23
- remove comment from .profile example
- add limitation section about comments in profile
- add limitation section about the 9999 limit of chunks

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
- Ease life of user, by allowing several restores to run concurrently.

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
@bruno-at-bareos bruno-at-bareos force-pushed the dev/bruno/master/doc-fix-droplet-comments branch from 441065a to 61d95cd Compare November 28, 2023 15:56
- inform users about the need to override default 1 if they want
  concurrent migrate/copy jobs

Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
Copy link
Member

@sduehr sduehr left a comment

Choose a reason for hiding this comment

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

Thanks, looks good so far, just suggested some small changes.
Also noticed that MaximumWorkersPerJob was added but without description.
And TlsCipherSuites is not mentioned in TransportEncryption.rst. If these two are not yet already covered in other PRs, we may want to add Tasks for that.

docs/manuals/source/TasksAndConcepts/StorageBackends.rst Outdated Show resolved Hide resolved
docs/manuals/source/TasksAndConcepts/StorageBackends.rst Outdated Show resolved Hide resolved
docs/manuals/source/TasksAndConcepts/StorageBackends.rst Outdated Show resolved Hide resolved
docs/manuals/source/TasksAndConcepts/StorageBackends.rst Outdated Show resolved Hide resolved
docs/manuals/source/TasksAndConcepts/StorageBackends.rst Outdated Show resolved Hide resolved
docs/manuals/source/TasksAndConcepts/StorageBackends.rst Outdated Show resolved Hide resolved
docs/manuals/source/TasksAndConcepts/StorageBackends.rst Outdated Show resolved Hide resolved
docs/manuals/source/TasksAndConcepts/StorageBackends.rst Outdated Show resolved Hide resolved
Co-authored-by: sduehr <stephan.duehr@bareos.com>
@sduehr
Copy link
Member

sduehr commented Dec 4, 2023

Thanks, looks good now, ready for approval, the only thing missing is the backport to 23.

Copy link
Member

@sduehr sduehr left a comment

Choose a reason for hiding this comment

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

Thanks a lot, looks good now.

bruno-at-bareos and others added 2 commits December 4, 2023 14:46
Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
@BareosBot BareosBot merged commit 1e7d73e into bareos:master Dec 4, 2023
@bruno-at-bareos bruno-at-bareos deleted the dev/bruno/master/doc-fix-droplet-comments branch January 15, 2024 13:46
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 requires backport to 23
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants