doc improve datatype subsection#968
Closed
bruno-at-bareos wants to merge 15 commits intobareos:masterfrom
bruno-at-bareos:dev/bruno-at-bareos/doc_improve-datatype-addresses
Closed
doc improve datatype subsection#968bruno-at-bareos wants to merge 15 commits intobareos:masterfrom bruno-at-bareos:dev/bruno-at-bareos/doc_improve-datatype-addresses
bruno-at-bareos wants to merge 15 commits intobareos:masterfrom
bruno-at-bareos:dev/bruno-at-bareos/doc_improve-datatype-addresses
Conversation
- Rename datatype ADDRESS ADDRESSES to address and addresses - Add more examples - Fix typos Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
arogge
reviewed
Nov 9, 2021
arogge
approved these changes
Nov 9, 2021
Member
arogge
left a comment
There was a problem hiding this comment.
Definitely a huge improvement of that section.
arogge
requested changes
Nov 9, 2021
Member
arogge
left a comment
There was a problem hiding this comment.
- the CHANGELOG.md record should have its own Commit
- there's a typo "complete remork" in one of the commits
docs/manuals/source/Configuration/CustomizingTheConfiguration.rst
Outdated
Show resolved
Hide resolved
Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
arogge
approved these changes
Nov 9, 2021
arogge
requested changes
Nov 9, 2021
docs/manuals/source/Configuration/CustomizingTheConfiguration.rst
Outdated
Show resolved
Hide resolved
docs/manuals/source/Configuration/CustomizingTheConfiguration.rst
Outdated
Show resolved
Hide resolved
arogge
approved these changes
Nov 10, 2021
Member
arogge
left a comment
There was a problem hiding this comment.
nothing left to complain about :)
Contributor
Author
|
I've done a final round of check and modification following @joergsteffens recommendations. |
- Update all data-type to uppercase - Update all index to match data-type - Update index syntax - Sort alphabetically all data-type - Make indentation (3) uniform everywhere - Add description to each data-type and link to other part - Upgrade subsubsection to subsection (visible in toc) - Use crosslink to config:option when necessary Signed-off-by: Bruno Friedmann <bruno.friedmann@bareos.com>
The Bareos configuration directives are expected to be written in CamelCase. It turned out, that this is not always the case, resulting in mismatch of documentation files and broken internal links. This changes renames some configuration directives into proper CamelCase. It also tries to convert directives into proper CamelCase, adds link targets also for :config:option: with 2 components and produces warnings on dangling links,
Fix broken :config:option: links.
Add Sphinx directives for datatypes: .. config:datatype:: DATATYPE and references to it: :config:datatype:`DATATYPE`
Use :config:datatype: in generated config directives table and descriptions.
The script generate-bareos-package-info.py is used to generate parts of the documentation. When it exits with error, the build process is stopped.
If Bareos config directices are not in CamelCase, the script raises an error.
joergsteffens
approved these changes
Nov 24, 2021
Contributor
Author
|
@joergsteffens @arogge can one of you push the merge button ? |
arogge
approved these changes
Nov 29, 2021
12 tasks
Member
|
Replaced by PR #1008 |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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 is an improvement of data-types subsubsection of the documentation.
Thank you for contributing to the Bareos Project!
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)
General
Source code quality
bareos-check-sources --since-mergedoes not report any problemsgit statusshould not report modifications in the source tree after building and testing