Skip to content

Commit

Permalink
Add doc for alerting comments (#7360)
Browse files Browse the repository at this point in the history
* alerting comments first documentation rough draft

Signed-off-by: Dennis Toepker <[email protected]>

* formatting and styling changes

Signed-off-by: Dennis Toepker <[email protected]>

* more formatting changes

Signed-off-by: Dennis Toepker <[email protected]>

* more spacing changes

Signed-off-by: Dennis Toepker <[email protected]>

* added not about rbac and added some links

Signed-off-by: Dennis Toepker <[email protected]>

* removing comments history enabled setting

Signed-off-by: Dennis Toepker <[email protected]>

* Update comments.md

Signed-off-by: Melissa Vagi <[email protected]>

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/alerting/api.md

Update Update comment API description

Co-authored-by: Melissa Vagi <[email protected]>
Signed-off-by: toepkerd <[email protected]>

* Update _observing-your-data/alerting/api.md

Update Delete comment API description

Co-authored-by: Melissa Vagi <[email protected]>
Signed-off-by: toepkerd <[email protected]>

* Update _observing-your-data/alerting/settings.md

Updated comments_enabled setting description

Co-authored-by: Melissa Vagi <[email protected]>
Signed-off-by: toepkerd <[email protected]>

* Update _observing-your-data/alerting/settings.md

Updated comments_history_max_age setting description

Co-authored-by: Melissa Vagi <[email protected]>
Signed-off-by: toepkerd <[email protected]>

* Update _observing-your-data/alerting/settings.md

Update comments_history_rollover_period setting description

Co-authored-by: Melissa Vagi <[email protected]>
Signed-off-by: toepkerd <[email protected]>

* Update _observing-your-data/alerting/settings.md

Update comments_history_retention_period setting description

Co-authored-by: Melissa Vagi <[email protected]>
Signed-off-by: toepkerd <[email protected]>

* minor edits and dead link fix attempt

Signed-off-by: Dennis Toepker <[email protected]>

* misc edits

Signed-off-by: Dennis Toepker <[email protected]>

* minor edit

Signed-off-by: Dennis Toepker <[email protected]>

* Update api.md

Signed-off-by: Melissa Vagi <[email protected]>

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/alerting/comments.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update api.md

Signed-off-by: Melissa Vagi <[email protected]>

Signed-off-by: Melissa Vagi <[email protected]>

* Update comments.md

Signed-off-by: Melissa Vagi <[email protected]>

Signed-off-by: Melissa Vagi <[email protected]>

* Update api.md

format request and response examples to expand

Signed-off-by: Melissa Vagi <[email protected]>

* Update api.md

Signed-off-by: Melissa Vagi <[email protected]>

Signed-off-by: Melissa Vagi <[email protected]>

* Update api.md

Signed-off-by: Melissa Vagi <[email protected]>

Signed-off-by: Melissa Vagi <[email protected]>

* Update api.md

Signed-off-by: Melissa Vagi <[email protected]>

Signed-off-by: Melissa Vagi <[email protected]>

* Update api.md

Signed-off-by: Melissa Vagi <[email protected]>

Signed-off-by: Melissa Vagi <[email protected]>

* Update api.md

Signed-off-by: Melissa Vagi <[email protected]>

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/alerting/api.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/alerting/api.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/alerting/api.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/alerting/api.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/alerting/api.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/alerting/settings.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/alerting/settings.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/alerting/settings.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/alerting/comments.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/alerting/settings.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/alerting/comments.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/alerting/comments.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/alerting/comments.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Update api.md

Signed-off-by: Melissa Vagi <[email protected]>

Signed-off-by: Melissa Vagi <[email protected]>

* Update settings.md

Signed-off-by: Melissa Vagi <[email protected]>

Signed-off-by: Melissa Vagi <[email protected]>

* Update api.md

Signed-off-by: Melissa Vagi <[email protected]> 

Added text to address stacked headings issue

Signed-off-by: Melissa Vagi <[email protected]>

* Update api.md

Signed-off-by: Melissa Vagi <[email protected]>

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/alerting/api.md

Signed-off-by: Melissa Vagi <[email protected]>

* Update api.md

Signed-off-by: Melissa Vagi <[email protected]>

Signed-off-by: Melissa Vagi <[email protected]>

* Update _observing-your-data/alerting/api.md

Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

* Fix broken link

Signed-off-by: Melissa Vagi <[email protected]>

* Fix broken link

Signed-off-by: Melissa Vagi <[email protected]>

---------

Signed-off-by: Dennis Toepker <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: toepkerd <[email protected]>
Co-authored-by: Dennis Toepker <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
  • Loading branch information
4 people authored Jun 19, 2024
1 parent 621372c commit 6e597bb
Show file tree
Hide file tree
Showing 4 changed files with 580 additions and 98 deletions.
Loading

0 comments on commit 6e597bb

Please sign in to comment.