Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve monitoring documentation #9758

Merged
merged 6 commits into from
May 24, 2024

Conversation

vicwicker
Copy link
Contributor

How to categorize this PR?

/area documentation
/kind enhancement

What this PR does / why we need it:

This PR addresses the following items to improve the monitoring documentation:

  1. Renames the cache Prometheus as such and not just "Prometheus".
  2. Motivates the need for a cache Prometheus so its role becomes clearer.
  3. States which Prometeus instances are used for alerting and which not.
  4. Unifies usage of upper and lowercase in words such as shoot, seed, aggregate and Prometheus.

Special notes for your reviewer:

/cc @rickardsjp @istvanballok

Release note:

NONE

Copy link
Contributor

gardener-prow bot commented May 15, 2024

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@gardener-prow gardener-prow bot requested a review from istvanballok May 15, 2024 09:41
@gardener-prow gardener-prow bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 15, 2024
@gardener-prow gardener-prow bot requested a review from rickardsjp May 15, 2024 09:41
@gardener-prow gardener-prow bot added area/documentation Documentation related kind/enhancement Enhancement, improvement, extension cla: yes Indicates the PR's author has signed the cla-assistant.io CLA. size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels May 15, 2024
- "seed", "shoot" and "aggregated" are not capitalized unless required
  by title case
- "Prometheus" is always capitalized as it is a name.
- Rename prometheus to cache-prometheus.
- Exported with embedded scene to allow imports into
  excalidraw for further modifications.
Copy link
Contributor

@istvanballok istvanballok left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

@gardener-prow gardener-prow bot added the lgtm Indicates that a PR is ready to be merged. label May 24, 2024
Copy link
Contributor

gardener-prow bot commented May 24, 2024

LGTM label has been added.

Git tree hash: 0a292158c11acf7afef28af33172da2644d1a469

@vicwicker vicwicker marked this pull request as ready for review May 24, 2024 13:59
@gardener-prow gardener-prow bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 24, 2024
@rfranzke
Copy link
Member

/approve

Copy link
Contributor

gardener-prow bot commented May 24, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: istvanballok, rfranzke

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@gardener-prow gardener-prow bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label May 24, 2024
@vicwicker
Copy link
Contributor Author

/retest-required

@gardener-prow gardener-prow bot merged commit d4895cf into gardener:master May 24, 2024
17 checks passed
@vicwicker vicwicker deleted the improve-monitoring-docu branch May 27, 2024 15:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. area/documentation Documentation related cla: yes Indicates the PR's author has signed the cla-assistant.io CLA. kind/enhancement Enhancement, improvement, extension lgtm Indicates that a PR is ready to be merged. size/S Denotes a PR that changes 10-29 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants