ROB-2395: docs for secrets sinks config

[nherment]

• More prominent docs for key sinks
• Basic link to secret management for all other sinks

[coderabbitai[bot]]

Walkthrough

Adds guidance and example snippets across sink documentation showing how to load secrets into environment variables (Kubernetes Secrets -> runner.additional_env_vars) and reference them in sink configs via {{ env.VAR_NAME }}; plus a general tip in the sinks index.

Changes

Cohort / File(s)	Summary
Sink docs — add secret/env guidance docs/configuration/sinks/DataDog.rst, docs/configuration/sinks/Opsgenie.rst, docs/configuration/sinks/PagerDuty.rst, docs/configuration/sinks/ms-teams.rst, docs/configuration/sinks/RobustaUI.rst, docs/configuration/sinks/ServiceNow.rst, docs/configuration/sinks/VictorOps.rst, docs/configuration/sinks/YandexMessenger.rst, docs/configuration/sinks/discord.rst, docs/configuration/sinks/google_chat.rst, docs/configuration/sinks/jira.rst, docs/configuration/sinks/kafka.rst, docs/configuration/sinks/mail.rst, docs/configuration/sinks/mattermost.rst, docs/configuration/sinks/pushover.rst, docs/configuration/sinks/rocketchat.rst, docs/configuration/sinks/telegram.rst, docs/configuration/sinks/webex.rst, docs/configuration/sinks/webhook.rst, docs/configuration/sinks/zulip.rst	Inserted notes/admonitions and example YAML snippets demonstrating securing API keys, tokens, webhook URLs, and credentials via Kubernetes Secrets -> runner.additional_env_vars and using {{ env.VARIABLE_NAME }} in sink configurations. Changes are documentation-only and additive.
Slack docs — directive + example docs/configuration/sinks/slack.rst	Replaced a warning with a tip and added an example showing loading SLACK_API_KEY from a Kubernetes Secret into runner.additional_env_vars and referencing it in the Slack sink. Documentation-only change.
Sinks index — global tip docs/configuration/sinks/index.rst	Added a tip advising use of Kubernetes Secrets with {{ env.VARIABLE_NAME }} syntax to secure API keys/tokens across sink configs.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Mostly homogeneous, additive documentation updates across many sink files.
• Review focus:
  • Consistency of {{ env.VAR_NAME }} examples and variable names.
  • Correct references/links to "Managing Secrets".
  • Slack directive replacement for tone/accuracy.

Suggested reviewers

• arikalon1
• aantn

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	❓ Inconclusive	No description was provided by the author, making it impossible to assess whether a description relates to the changeset.	Add a pull request description explaining the purpose of the documentation updates and how they help users secure their sink configurations.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change: documentation updates for secrets management in sink configurations across multiple files.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• [ ] Create PR with unit tests
• [ ] Post copyable unit tests in a comment
• [ ] Commit unit tests in branch rob-2395_improved_secret_docs_for_sinks

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}