-
Epic
-
Resolution: Done
-
Undefined
-
None
-
None
-
None
-
Monitoring Doc improvements
-
False
-
None
-
False
-
Not Selected
-
NEW
-
To Do
-
NEW
-
0% To Do, 0% In Progress, 100% Done
-
XL
Epic Goal
- Improve documentation for core developers on how to use the in-cluster stack
- Create a single starting point for developer focused material
- Improve user facing documentation for recurring issues and questions.
Why is this important?
- The in-cluster stack provides infrastructure to monitor, alert and report telemetry
- Our users are OpenShift developers that want to make use of said infrastructure.
- We have most things documented, they are just spread out.
- Reduce friction in getting core components onboarded
- We have recurring user requests of even bugs that are caused by unclear expectations
Scenarios
- A developer of a core OpenShift operator wants to expose metrics and send them to telemetry. Where do we send that developer to find all the information they need.
- A user wants to develop an expectation how many resources their prometheus will consume.
Acceptance Criteria
- ...
Dependencies (internal and external)
- ...
Previous Work (Optional):
Open questions::
- …
- is documented by
-
RHDEVDOCS-4339 User documentation on resource reqs
- Closed