mirror of
https://github.com/rsyslog/rsyslog.git
synced 2026-06-19 11:42:55 +02:00
b8d8faa68c
Improve AI-facing documentation to speed up contributor onboarding after the gpt5-codex agent update. The guides clarify bootstrap, testing, and where to find module ownership so agents can work predictably and avoid expensive CI-only paths. Impact: documentation-only; no runtime changes. Clarifies when to use direct test scripts vs. the autotools harness. This introduces repository-wide AGENTS guides (root, plugins/, contrib/, tools/, doc/) plus module-focused guides for omelasticsearch, imkafka, omkafka, and omruleset. It adds metadata templates for core and contrib modules, initial MODULE_METADATA.yaml files for the Kafka and ES modules, and a tools/MODULE_METADATA.json for built-ins. The top-level guide now includes quick links, “priming a fresh AI session,” and explicit autotools bootstrap instructions (run ./autogen.sh when autotools inputs change). Testing guidance asks agents to prefer invoking ./tests/*.sh directly, reserving `make check` for CI reproductions. The doc subtree gains its own AGENTS.md and an AI doc-builder base prompt to keep edits consistent. doc/ai/module_map.yaml was annotated to reference per-module metadata. Before: scattered or missing agent guidance; unclear when to bootstrap autotools or run the full harness. After: structured, discoverable docs, templates, and metadata that align contributor workflow across modules.
77 lines
2.5 KiB
JSON
77 lines
2.5 KiB
JSON
[
|
|
{
|
|
"module": "omdiscard",
|
|
"support_status": "core-supported",
|
|
"maturity_level": "mature",
|
|
"primary_contact": "GitHub Discussions & Issues <https://github.com/rsyslog/rsyslog/discussions>",
|
|
"last_reviewed": "2025-09-26",
|
|
"documentation": [],
|
|
"notes": [
|
|
"No standalone tests; verify behavior via configuration-based discard scenarios."
|
|
]
|
|
},
|
|
{
|
|
"module": "omfile",
|
|
"support_status": "core-supported",
|
|
"maturity_level": "fully-mature",
|
|
"primary_contact": "GitHub Discussions & Issues <https://github.com/rsyslog/rsyslog/discussions>",
|
|
"last_reviewed": "2025-09-26",
|
|
"documentation": [
|
|
"doc/source/configuration/modules/omfile.rst"
|
|
],
|
|
"notes": [
|
|
"High-traffic path; update doc/ai/module_map.yaml when locking changes."
|
|
]
|
|
},
|
|
{
|
|
"module": "omfwd",
|
|
"support_status": "core-supported",
|
|
"maturity_level": "fully-mature",
|
|
"primary_contact": "GitHub Discussions & Issues <https://github.com/rsyslog/rsyslog/discussions>",
|
|
"last_reviewed": "2025-09-26",
|
|
"documentation": [
|
|
"doc/source/configuration/modules/omfwd.rst"
|
|
],
|
|
"notes": [
|
|
"Shares code with network stack; coordinate with imtcp/omtcp owners when changing defaults."
|
|
]
|
|
},
|
|
{
|
|
"module": "ompipe",
|
|
"support_status": "core-supported",
|
|
"maturity_level": "mature",
|
|
"primary_contact": "GitHub Discussions & Issues <https://github.com/rsyslog/rsyslog/discussions>",
|
|
"last_reviewed": "2025-09-26",
|
|
"documentation": [
|
|
"doc/source/configuration/modules/ompipe.rst"
|
|
],
|
|
"notes": [
|
|
"Ensure platform-specific pipe handling stays in sync with runtime/.*pipe helpers."
|
|
]
|
|
},
|
|
{
|
|
"module": "omshell",
|
|
"support_status": "core-supported",
|
|
"maturity_level": "mature",
|
|
"primary_contact": "GitHub Discussions & Issues <https://github.com/rsyslog/rsyslog/discussions>",
|
|
"last_reviewed": "2025-09-26",
|
|
"documentation": [],
|
|
"notes": [
|
|
"Primarily used for legacy shell pipelines; document security implications when changing behavior."
|
|
]
|
|
},
|
|
{
|
|
"module": "omusrmsg",
|
|
"support_status": "core-supported",
|
|
"maturity_level": "mature",
|
|
"primary_contact": "GitHub Discussions & Issues <https://github.com/rsyslog/rsyslog/discussions>",
|
|
"last_reviewed": "2025-09-26",
|
|
"documentation": [
|
|
"doc/source/configuration/modules/omusrmsg.rst"
|
|
],
|
|
"notes": [
|
|
"Interacts with user accounting facilities; exercise sudo/write permissions when testing."
|
|
]
|
|
}
|
|
]
|