-
Notifications
You must be signed in to change notification settings - Fork 478
docs: restructure and improve documentation #5152
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
base: main
Are you sure you want to change the base?
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR restructures the documentation hierarchy to improve navigation and consolidates configuration pages to reduce redundancy. The main changes flatten the Configuration section from 5 levels to 3 levels, reorganize content under more logical sections, and update flag reference documentation to reflect the current CLI interface.
Key Changes:
- Restructured navigation: moved Flag Reference under Installation and created a new Monitoring section
- Consolidated CLI configuration page into the overview, removing redundant content
- Updated flag reference documentation to use the new destinations format and correct field names
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| mkdocs.yml | Flattened navigation hierarchy, moved pages to more appropriate sections, removed non-existent capture.1.md reference |
| docs/man/output.1 | Updated to use new destinations format, improved documentation structure, added cross-references |
| docs/man/config.1 | Removed incorrect reserved flags list, added comprehensive examples with correct YAML field names |
| docs/docs/install/index.md | Updated navigation links to reflect new structure |
| docs/docs/install/container-engines.md | Enhanced with configuration examples and added automatic runtime detection section |
| docs/docs/install/config/index.md | Added configuration file usage instructions and improved formatting |
| docs/docs/install/config/cli.md | Removed redundant CLI configuration page |
| docs/docs/flags/output.1.md | Updated to use new destinations format with correct examples |
| docs/docs/flags/config.1.md | Removed incorrect reserved flags, added comprehensive YAML examples |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5152 +/- ##
==========================================
+ Coverage 33.51% 35.59% +2.07%
==========================================
Files 250 257 +7
Lines 28908 30324 +1416
==========================================
+ Hits 9688 10793 +1105
- Misses 18609 18819 +210
- Partials 611 712 +101
🚀 New features to boost your workflow:
|
0597f4c to
62e3602
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
Copilot reviewed 20 out of 21 changed files in this pull request and generated 2 comments.
Restructure documentation hierarchy: - Flatten Configuration section (5 to 3 levels deep) - Move Flag Reference under Configuration - Move Policies before Events in navigation - Rename "Outputs" to "Output" (singular) - Rename "Ordering Events" to "Sorting Events" Consolidate and improve content: - Merge prometheus.md and healthz.md into unified monitoring.md - Merge cli.md into config/index.md overview - Completely rewrite output-formats.md to focus on formats vs destinations - Enhance output-options.md with correct exec-hash modes and examples - Add "See Also" cross-references to key pages - Update container-engines.md with enrichment flag documentation Fix documentation issues: - Remove non-existent capture.1.md reference - Fix config.1.md: remove incorrect reserved flags section - Update output.1.md to use destinations format with proper examples - Fix YAML examples to use correct field names (logging:, destinations:) - Fix broken cross-references and relative paths - Update sorting events page terminology and structure - Fix typos and improve wording throughout
62e3602 to
717a3ae
Compare
Restructure documentation hierarchy:
- Flatten Configuration section (5 to 3 levels deep)
- Move Flag Reference under Configuration
- Move Policies before Events in navigation
- Rename "Outputs" to "Output" (singular)
- Rename "Ordering Events" to "Sorting Events"
Consolidate and improve content:
- Merge prometheus.md and healthz.md into unified monitoring.md
- Merge cli.md into config/index.md overview
- Completely rewrite output-formats.md to focus on formats vs destinations
- Enhance output-options.md with correct exec-hash modes and examples
- Add "See Also" cross-references to key pages
- Update container-engines.md with enrichment flag documentation
Fix documentation issues:
- Remove non-existent capture.1.md reference
- Fix config.1.md: remove incorrect reserved flags section
- Update output.1.md to use destinations format with proper examples
- Fix YAML examples to use correct field names (logging:, destinations:)
- Fix broken cross-references and relative paths
- Update sorting events page terminology and structure
- Fix typos and improve wording throughout