Rename "Prometheus" docs section to "Prometheus Server"#2473
Merged
Conversation
juliusv
force-pushed
the
rename-prometheus-section
branch
2 times, most recently
from
be0be3e to
8d29261
Compare
As per Björn's comment on the team mailing list: "I think the current "Prometheus" section is not very well named. It is essentially the part coming from the prometheus/prometheus repo (not prometheus/docs, as the rest fo the site), and it means "The Prometheus Server". I think it should be named that way because just "Prometheus" could mean a lot of things. On prometheus.io, "Prometheus" mostly refers to the overarching project." This also adds CSS styles to make sure that the "Prometheus Server" text gets line-broken in such a way on narrow displays that the second line is indented correctly. Signed-off-by: Julius Volz <julius.volz@gmail.com>
juliusv
force-pushed
the
rename-prometheus-section
branch
from
8d29261 to
8484509
Compare
beorn7
approved these changes
Jun 7, 2024
Member
|
❤️ |
beorn7
added a commit
that referenced
this pull request
Jun 12, 2024
After #2473 finally reaming the "Prometheus" section to "Prometheus Server", I think we should also rename the top-level "Alerting" section to "Alertmanager". This section is just the embedded documentation from the Alertmanager repository, and it speaks volumes that the "Precise alerting" link on the landing page leads to https://prometheus.io/docs/prometheus/latest/configuration/alerting_rules/ rather than the so-called "Alerting" section. In defense of the current section name, there is an "Alerting Overview" subsection that links to other places, but I think it's still better to call the whole section "Alertmanager', also because it makes it easier to find the actual Alertmanager documentation if you are looking specifically for it (rather than Alerting in general). Final point: The first item if you expand the "Alerting" navbar is the selection of the Alertmanager version, which is also confusing if the title just above it just reads "Alerting". Signed-off-by: beorn7 <beorn@grafana.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
As per Björn's comment on the team mailing list:
"I think the current "Prometheus" section is not very well named. It is essentially the part coming from the prometheus/prometheus repo (not prometheus/docs, as the rest fo the site), and it means "The Prometheus Server". I think it should be named that way because just "Prometheus" could mean a lot of things. On prometheus.io, "Prometheus" mostly refers to the overarching project."