Skip to content

Move some new docs from "Concepts" to "Instrumenting", fix up titles#2657

Merged
juliusv merged 1 commit intomainfrom
move-new-sections
May 28, 2025
Merged

Move some new docs from "Concepts" to "Instrumenting", fix up titles#2657
juliusv merged 1 commit intomainfrom
move-new-sections

Conversation

@juliusv
Copy link
Member

@juliusv juliusv commented May 27, 2025

See #2653 (comment)

Also change the titles:

  • "Prometheus" is redundant in the context of Prometheus, let's make it more about UTF-8
  • Make the nav titles shorter so they fit nicer into the nav (title on the page itself can still be long)
  • We don't use title casing (at least in the "Instrumenting" section), so lower-casing the titles

See #2653 (comment)

Also change the titles:

* "Prometheus" is redundant in the context of Prometheus, let's make it
  more about UTF-8
* Make the nav titles shorter so they fit nicer into the nav (title
  on the page itself can still be long)
* We don't use title casing (at least in the "Instrumenting" section), so
  lower-casing the titles

Signed-off-by: Julius Volz <julius.volz@gmail.com>
@juliusv
Copy link
Member Author

juliusv commented May 27, 2025

As mentioned in #2653 (comment), there needs to be more work done to link these from the existing "Exposition formats" sibling page and/or potentially merge some content with it (but I really want to move them out of "Concepts" fast for now to not confuse new users).

@juliusv
Copy link
Member Author

juliusv commented May 27, 2025

Btw. another candidate section for these would be the "Specifications" section, because both docs read very spec-y. But so does https://prometheus.io/docs/instrumenting/exposition_formats/, which is currently under "Instrumenting", so not sure.

Copy link
Member

@ArthurSens ArthurSens left a comment

Choose a reason for hiding this comment

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

The move makes sense to me, thanks for the suggestion!

What do you think @ywwg ?

@juliusv
Copy link
Member Author

juliusv commented May 28, 2025

Thanks for the approval! I'm going to merge this for now because I think it's fairly urgent to not display it under "Concepts", but definitely feel free to change / improve things further!

@juliusv juliusv merged commit a946db5 into main May 28, 2025
5 checks passed
@juliusv juliusv deleted the move-new-sections branch May 28, 2025 14:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants