Commit 7b12b93
committed
docs: Add comprehensive documentation and examples
This commit significantly improves project documentation with comprehensive
guides, examples, and references to help users and contributors.
New Documentation Files:
1. CONTRIBUTING.md (280 lines)
- Development setup instructions
- Coding standards and style guidelines
- Testing requirements
- Commit message conventions
- Pull request process
- Debugging and profiling tips
2. ARCHITECTURE.md (450 lines)
- System architecture overview with diagrams
- Component descriptions (Manager, Protocol, TLS/DTLS, Network)
- Data flow diagrams (journal to network)
- Connection state machine
- Protocol format specifications (RFC 5424/3339/5425)
- Security model and privilege dropping
- Performance considerations
- Future enhancement ideas
3. TESTING.md (550 lines)
- Unit test guide with cmocka
- Integration testing with local syslog servers
- TLS/DTLS testing with certificate generation
- Manual testing scenarios
- Protocol compliance validation
- Security testing procedures
- Performance testing methodology
- CI pipeline documentation
4. FAQ.md (400 lines)
- General questions about the project
- Installation and setup help
- Configuration examples and explanations
- Network protocol selection guide
- Log format differences
- Troubleshooting common issues
- Security best practices
- Performance optimization tips
- Cloud service integration
Examples Directory (10 configuration files):
- examples/README.md - Overview and usage instructions
- examples/basic-udp.conf - Simple UDP multicast
- examples/basic-tcp.conf - Reliable TCP delivery
- examples/tls-secure.conf - Encrypted TLS with certificates
- examples/dtls-encrypted.conf - DTLS encrypted datagrams
- examples/cloud-papertrail.conf - Papertrail integration
- examples/cloud-loggly.conf - Loggly integration
- examples/filtering.conf - Sensitive log filtering
- examples/structured-data.conf - RFC 5424 structured data
- examples/high-performance.conf - High-volume optimization
- examples/development.conf - Development/testing setup
README.md Improvements:
- Added Documentation section with links to all guides
- Added Configuration Examples section linking to examples/
- Improved Getting Help section with resource links
- Better navigation to specialized documentation
Documentation Statistics:
- Total new documentation: ~1,700 lines
- Example configurations: 10 files
- Comprehensive coverage: Architecture, Testing, Contributing, FAQ
- Ready-to-use examples for common scenarios
Benefits:
- Lower barrier to entry for new contributors
- Better understanding of internal architecture
- Easier troubleshooting with FAQ
- Production-ready configuration examples
- Comprehensive testing guidance1 parent c3218ec commit 7b12b93
16 files changed
Lines changed: 2580 additions & 6 deletions
Large diffs are not rendered by default.
Large diffs are not rendered by default.
Large diffs are not rendered by default.
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
245 | 245 | | |
246 | 246 | | |
247 | 247 | | |
248 | | - | |
| 248 | + | |
| 249 | + | |
| 250 | + | |
| 251 | + | |
| 252 | + | |
| 253 | + | |
249 | 254 | | |
250 | | - | |
251 | | - | |
| 255 | + | |
| 256 | + | |
| 257 | + | |
| 258 | + | |
| 259 | + | |
| 260 | + | |
| 261 | + | |
| 262 | + | |
| 263 | + | |
| 264 | + | |
| 265 | + | |
| 266 | + | |
| 267 | + | |
| 268 | + | |
| 269 | + | |
| 270 | + | |
| 271 | + | |
252 | 272 | | |
253 | | - | |
| 273 | + | |
| 274 | + | |
| 275 | + | |
| 276 | + | |
| 277 | + | |
| 278 | + | |
| 279 | + | |
| 280 | + | |
| 281 | + | |
| 282 | + | |
| 283 | + | |
| 284 | + | |
| 285 | + | |
| 286 | + | |
| 287 | + | |
| 288 | + | |
254 | 289 | | |
255 | 290 | | |
256 | 291 | | |
| |||
261 | 296 | | |
262 | 297 | | |
263 | 298 | | |
264 | | - | |
265 | | - | |
| 299 | + | |
| 300 | + | |
| 301 | + | |
| 302 | + | |
| 303 | + | |
| 304 | + | |
| 305 | + | |
| 306 | + | |
0 commit comments