Incomplete list of component statuses in generated Statuspage docs

Jesse David Peterson May 5, 2021

In the components section of a Statuspage's generated documentation, the description of Components enumerates possible component statuses as:

"Each component is listed along with its status - one of operational, degraded_performance, partial_outage, or major_outage."

The component status "under_maintenance" has been omitted from this description, which is confusing. As an engineer, when I read the phrasing "- one of ..." my expectation is that a complete list follows, not a partial list.


Suggestions on how to improve this might be:
- add the "under_maintenance" value to complete the cited description, or
- remove the incomplete description, and just link to the relevant API docs instead, or
- change the wording from "one of" to "for example"

0 comments

Comment

Log in or Sign up to comment
TAGS
AUG Leaders

Atlassian Community Events