Skip to content
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Update the troubleshooting section
  • Loading branch information
alaudazzi committed Aug 13, 2025
commit 99d9c3eed7bd720580429a91566cf6efdbd63ae5
21 changes: 1 addition & 20 deletions docs/extend/documentation-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,26 +78,7 @@ When possible, use links to point to third-party documentation for configuring n

### Troubleshooting [idg-docs-troubleshooting]

The troubleshooting section is optional. It should contain information about special cases and exceptions that aren’t necessary for getting started or won’t be applicable to all users.


#### Template [_template_5]

There is no standard format for the troubleshooting section.


#### Example [_example_5]

```text
>Note that certain data streams may access `/proc` to gather process information,
>and the resulting `ptrace_may_access()` call by the kernel to check for
>permissions can be blocked by
>[AppArmor and other LSM software](https://gitlab.com/apparmor/apparmor/wikis/TechnicalDoc_Proc_and_ptrace), even though the System module doesn't use `ptrace` directly.
>
>In addition, when running inside a container the proc filesystem directory of the host
>should be set using `system.hostfs` setting to `/hostfs`.
```

The troubleshooting section should include details specific to each input type, along with general guidance for resolving common issues encountered when deploying this integration. Whenever possible, link to the troubleshooting documentation provided by the third-party software.

### Reference [idg-docs-guidelines-reference]

Expand Down
Loading