@@ -38,6 +38,28 @@ Issues are created in the [request-for-help](https://gitlab.com/gitlab-com/reque
If a request for help highlights a bug or feature request, create an issue in the public tracker, link to it in the request for help issue, and close the latter.
##### Creating Runbooks from Request for Help Patterns
When resolving request for help issues, identify analyzer configuration patterns worth documenting as runbooks. This prevents customers from escalating the same problems repeatedly.
**Criteria for runbook-worthy patterns:**
- Analyzer configuration problems requiring multi-step diagnosis with specific commands or checks
- Solutions involving non-obvious analyzer configuration combinations discovered through troubleshooting
- Workarounds for known analyzer limitations that may not be obvious from existing documentation
**Creating a runbook entry:**
1. Add the runbook to the [Static Analysis Runbooks page](runbooks/)
2. Structure the runbook with:
- Symptoms indicating the problem (alerts, error messages, user reports)
- Diagnostic steps to confirm the root cause (commands, queries, log analysis)
- Resolution procedure with specific analyzer configuration changes
- Link related request for help issues
3. Use the runbook structure from existing entries on the page
Document specific analyzer configuration solutions, not general troubleshooting advice.
#### Slack Questions
Check the [Static Analysis Slack Channel](https://gitlab.enterprise.slack.com/archives/CLA54H7PY) and respond to any questions asked or delegate/ping a person that may know the answer. As with [Requests for Help](#requests-for-help), if the question concerns a bug or feature request, create an issue.
