rancher / rancher/stackstate-product-docs

Document silencing

Open
#416 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

kind/enhancement squad/marvin
Dominant language
Shell
Stars
2
Forks
24
Avg merge
4d 3h
Merged PRs (30d)
16

Description

Acceptance criteria *)

Make sure to add the doc links as shown in the figma design: https://www.figma.com/design/WfVHOuDw95BTqtrMuhfWRb/Monitors?node-id=0-1&p=f&t=5SgKjZHmiUWp1U7k-0

Documentation:

Under usage / monitors we add a 'silencing' section explaining the concept

Under usage / notifications /configure notifications we add explanation for silencing and what it does to notifications, aswell as explain The silencing rules change notify when* option and updated screenshots

Under Data Ingestion & Integrations / External health we add the new 'muted' option that can be carried with external health states

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the usage / monitors, usage / notifications / configure notifications, and Data Ingestion & Integrations / External health sections, using the linked Figma design as the reference. Update the silencing explanations, notify when option, screenshots, and external health muted option; done means all listed documentation sections and design links are updated.

Written by the indexing model from the issue text.

Assessment

Tech stack
figma
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
72/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.