PBM-1662 Added pbm-agent configuration options documentation #327
Conversation
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
modified: docs/manage/logpath.md
modified: docs/manage/start-agent-with-config.md
new file: docs/reference/pbm-agent-config-options.md
modified: mkdocs-base.yml
nastena1606
requested review from
boris-ilijic,
Copilot,
jcechace and
sandraromanchenko
There was a problem hiding this comment.
Pull request overview
This PR adds comprehensive documentation for pbm-agent configuration file options. The documentation includes a new reference page detailing all available configuration options (MongoDB URI, backup settings, and logging options) and updates existing documentation to link to this new reference.
Key Changes:
- New reference documentation describing pbm-agent configuration file options with detailed descriptions, types, defaults, and requirements
- Updated navigation to include the new reference page
- Added cross-references between related documentation pages
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/reference/pbm-agent-config-options.md | New reference documentation detailing all pbm-agent configuration options including mongodb-uri, backup.dump-parallel-collections, and logging settings |
| mkdocs-base.yml | Added new reference page to navigation structure |
| docs/manage/start-agent-with-config.md | Added link to new configuration options reference |
| docs/manage/logpath.md | Added hyperlink to start-agent-with-config.md for configuration file documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
modified: docs/manage/logpath.md
modified: docs/manage/start-agent-with-config.md
new file: docs/reference/pbm-agent-config-options.md
modified: mkdocs-base.yml