OBSDOCS-1489: Prepare the metrics sections for transition #85116

eromanova97 · 2024-11-19T14:13:09Z

Version(s) for cherry-picking: none

Link to docs preview:

QE review:

QE has approved this change.

Additional information:
This PR aims for the preparating of 3 assemblies to be ready for the next steps. These are the main changes:

Managing metrics: biggest changes, the assembly is separated into administrator vs non-administrator journey:
- This section will be moved to configuration section. [not changed]
- The Querying metrics introduction module was deleted and the content from the module was moved to the quering procedure modules.
- I also improved some content in those modules.
Reviewing monitoring dashboards: moved the introduction from assembly to its separate concept module.
Accessing monitoring APIs by using the CLI: In this assembly I fixed only small nits

openshift-ci-robot · 2024-11-19T14:13:14Z

@eromanova97: This pull request references OBSDOCS-1489 which is a valid jira issue.

In response to this:

Version(s) for cherry-picking: none

Issue: OBSDOCS-1489

Link to docs preview:

QE review:

QE has approved this change.

Additional information:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

ocpdocs-previewbot · 2024-11-19T14:33:47Z

🤖 Wed Dec 04 09:13:40 - Prow CI generated the docs preview:
https://85116--ocpdocs-pr.netlify.app
Complete list of updated preview URLs: artifacts/updated_preview_urls.txt

openshift-ci-robot · 2024-11-21T13:51:09Z

@eromanova97: This pull request references OBSDOCS-1489 which is a valid jira issue.

In response to this:

Version(s) for cherry-picking: none

Issue: OBSDOCS-1489

Link to docs preview:

Managing metrics

Reviewing monitoring dashboards

Accessing monitoring APIs by using the CLI

QE review:

QE has approved this change.

Additional information:
This PR aims for the preparating of 3 assemblies to be ready for the next steps. These are the main changes:

Managing metrics: biggest changes, the assembly is separated into administrator vs non-administrator journey:

This section will be moved to configuration section. [not changed]

The Querying metrics introduction module was deleted and the content from the module was moved to the quering procedure modules.

I also improved some content in those modules.

Reviewing monitoring dashboards: moved the introducting from assembly to its separate concept module.

Accessing monitoring APIs by using the CLI: In this assembly I fixed only small nits

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

openshift-ci-robot · 2024-11-21T13:51:25Z

@eromanova97: This pull request references OBSDOCS-1489 which is a valid jira issue.

In response to this:

Version(s) for cherry-picking: none

Issue: OBSDOCS-1489

Link to docs preview:

Managing metrics

Reviewing monitoring dashboards

Accessing monitoring APIs by using the CLI

QE review:

QE has approved this change.

Additional information:
This PR aims for the preparating of 3 assemblies to be ready for the next steps. These are the main changes:

Managing metrics: biggest changes, the assembly is separated into administrator vs non-administrator journey:

This section will be moved to configuration section. [not changed]

The Querying metrics introduction module was deleted and the content from the module was moved to the quering procedure modules.

I also improved some content in those modules.

Reviewing monitoring dashboards: moved the introduction from assembly to its separate concept module.

Accessing monitoring APIs by using the CLI: In this assembly I fixed only small nits

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

observability/monitoring/reviewing-monitoring-dashboards.adoc

eromanova97 · 2024-11-21T13:51:38Z

observability/monitoring/reviewing-monitoring-dashboards.adoc

+// About monitoring dashboards
+include::modules/monitoring-about-monitoring-dashboards.adoc[leveloffset=+1]


The introduction is now included here

Good call. Can you add a very short summary before the module so we don't get back-to-back headings?

I added a short sentence as you suggested, because this will not be the final assembly, I am just adding the same first sentence from "about mointoring dashboards" as a stand-in 😄

modules/monitoring-reviewing-monitoring-dashboards-developer.adoc

modules/monitoring-querying-metrics-for-all-projects-with-mon-dashboard.adoc

modules/monitoring-querying-metrics-for-user-defined-projects-with-mon-dashboard.adoc

juzhao · 2024-12-03T12:41:23Z

/lgtm

eromanova97 · 2024-12-03T12:57:33Z

/label peer-review-needed

jeana-redhat

This looks great! Just a few things to look at, pretty trivial considering the amount of work you've done here.

/remove-label peer-review-in-progress
/remove-label peer-review-needed
/label peer-review-done

observability/monitoring/managing-metrics.adoc

modules/monitoring-querying-metrics-for-all-projects-with-mon-dashboard.adoc

modules/monitoring-querying-metrics-for-user-defined-projects-with-mon-dashboard.adoc

jeana-redhat · 2024-12-03T18:17:32Z

observability/monitoring/reviewing-monitoring-dashboards.adoc

+// About monitoring dashboards
+include::modules/monitoring-about-monitoring-dashboards.adoc[leveloffset=+1]


Good call. Can you add a very short summary before the module so we don't get back-to-back headings?

modules/monitoring-about-monitoring-dashboards.adoc

jeana-redhat · 2024-12-03T18:21:05Z

modules/monitoring-about-monitoring-dashboards.adoc

+.Example dashboard in the Administrator perspective
+image::monitoring-dashboard-administrator.png[]
+
+Use the *Developer* perspective to access Kubernetes compute resources dashboards that provide the following application metrics for a selected project:
+
+* CPU usage
+* Memory usage
+* Bandwidth information
+* Packet rate information
+
+.Example dashboard in the Developer perspective
+image::observe-dashboard-developer.png[]


See SSG guidance on screenshots. In my opinion, these two do add value, but they still need alt text for screen readers.

I think the main point of including them is to demonstrate the differences, so it might work well to explain the different panels available rather than trying to fully explain the contents.

Good idea, thank you for pointing this out! I am not sure I would want to include it in this PR, I will add it as one of the tasks for this additional enhancement PR: https://issues.redhat.com/browse/OBSDOCS-1527
as that one will be dealing with the screenshots already.

Sounds good to me!

modules/monitoring-getting-detailed-information-about-a-target.adoc

openshift-ci · 2024-12-04T08:55:41Z

New changes are detected. LGTM label has been removed.

openshift-ci · 2024-12-04T09:16:41Z

@eromanova97: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

eromanova97 · 2024-12-04T10:11:02Z

/label merge-review-needed

bscott-rh

Merge review LGTM.

openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Nov 19, 2024

openshift-ci bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Nov 19, 2024

eromanova97 force-pushed the OBSDOCS-1489 branch 3 times, most recently from b6297db to 6652824 Compare November 21, 2024 13:31

eromanova97 changed the title ~~[WIP] OBSDOCS-1489: Prepare the metrics sections for transition~~ OBSDOCS-1489: Prepare the metrics sections for transition Nov 21, 2024

openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Nov 21, 2024

eromanova97 commented Nov 21, 2024

View reviewed changes

juzhao reviewed Nov 22, 2024

View reviewed changes

modules/monitoring-querying-metrics-for-all-projects-with-mon-dashboard.adoc Outdated Show resolved Hide resolved

juzhao reviewed Nov 22, 2024

View reviewed changes

modules/monitoring-querying-metrics-for-user-defined-projects-with-mon-dashboard.adoc Show resolved Hide resolved

juzhao reviewed Nov 22, 2024

View reviewed changes

modules/monitoring-querying-metrics-for-user-defined-projects-with-mon-dashboard.adoc Show resolved Hide resolved

eromanova97 force-pushed the OBSDOCS-1489 branch 2 times, most recently from b629430 to 7c869e3 Compare December 3, 2024 08:35

openshift-ci bot assigned juzhao Dec 3, 2024

openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Dec 3, 2024

openshift-ci bot added the peer-review-needed Signifies that the peer review team needs to review this PR label Dec 3, 2024

jeana-redhat added the peer-review-in-progress Signifies that the peer review team is reviewing this PR label Dec 3, 2024

jeana-redhat reviewed Dec 3, 2024

View reviewed changes

openshift-ci bot added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR peer-review-needed Signifies that the peer review team needs to review this PR labels Dec 3, 2024

eromanova97 force-pushed the OBSDOCS-1489 branch from 7c869e3 to a899dbd Compare December 4, 2024 08:55

openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Dec 4, 2024

OBSDOCS-1489: Prepare the metrics sections for transition

73bab00

eromanova97 force-pushed the OBSDOCS-1489 branch from a899dbd to 73bab00 Compare December 4, 2024 08:59

openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Dec 4, 2024

bscott-rh added merge-review-in-progress Signifies that the merge review team is reviewing this PR and removed merge-review-needed Signifies that the merge review team needs to review this PR merge-review-in-progress Signifies that the merge review team is reviewing this PR labels Dec 4, 2024

bscott-rh self-assigned this Dec 4, 2024

bscott-rh approved these changes Dec 4, 2024

View reviewed changes

bscott-rh merged commit f76ca6d into openshift:monitoring-docs-restructure Dec 4, 2024
2 checks passed

eromanova97 deleted the OBSDOCS-1489 branch December 5, 2024 13:43

		// About monitoring dashboards
		include::modules/monitoring-about-monitoring-dashboards.adoc[leveloffset=+1]

OBSDOCS-1489: Prepare the metrics sections for transition #85116

OBSDOCS-1489: Prepare the metrics sections for transition #85116

Uh oh!

Conversation

eromanova97 commented Nov 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-ci-robot commented Nov 19, 2024 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ocpdocs-previewbot commented Nov 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-ci-robot commented Nov 21, 2024 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openshift-ci-robot commented Nov 21, 2024 • edited by openshift-ci bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

eromanova97 Nov 21, 2024

Choose a reason for hiding this comment

Uh oh!

jeana-redhat Dec 3, 2024

Choose a reason for hiding this comment

Uh oh!

eromanova97 Dec 4, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

juzhao commented Dec 3, 2024

Uh oh!

eromanova97 commented Dec 3, 2024

Uh oh!

jeana-redhat left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jeana-redhat Dec 3, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

jeana-redhat Dec 3, 2024

Choose a reason for hiding this comment

Uh oh!

eromanova97 Dec 4, 2024

Choose a reason for hiding this comment

Uh oh!

jeana-redhat Dec 4, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

openshift-ci bot commented Dec 4, 2024

Uh oh!

openshift-ci bot commented Dec 4, 2024

Uh oh!

eromanova97 commented Dec 4, 2024

Uh oh!

bscott-rh left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

eromanova97 commented Nov 19, 2024 •

edited

Loading

openshift-ci-robot commented Nov 19, 2024 •

edited by openshift-ci bot

Loading

ocpdocs-previewbot commented Nov 19, 2024 •

edited

Loading

openshift-ci-robot commented Nov 21, 2024 •

edited by openshift-ci bot

Loading

openshift-ci-robot commented Nov 21, 2024 •

edited by openshift-ci bot

Loading