influxdata / influxdata/docs-v2

Rename "Checks" to "Alerts"?

Open
#4,543 1 comment 0 reactions 0 assignees View on GitHub
alerts product:v2
Dominant language
JavaScript
Stars
82
Forks
326
Avg merge
1d 1h
Merged PRs (30d)
82

Description

Docs mostly use the term "Checks" in page titles and headings in the Monitoring and Alerts section.
In the UI nav, the feature is "Alerts".
For the UI, Docs "Checks" guides describe how to use the "Alerts" in the UI., e.g. https://docs.influxdata.com/influxdb/v2.4/monitor-alert/checks/create/.
Search for "alerts" does a poor job of returning Checks pages.

##### Relevant URLs
- https://docs.influxdata.com/influxdb/v2.4/monitor-alert/checks/create/

Contributor guide

No contributing guide indexed for this repository

Research direction

Review the linked Checks guide and search the documentation for page titles, headings, and references to “Checks” and “Alerts.” First determine whether the terminology should be changed and which pages are in scope; done means the agreed terminology is applied consistently and the relevant pages are discoverable through an Alerts search.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.