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

docs: additional formatting fixes to 3.0 migration guide #15379

Merged
merged 5 commits into from
Nov 12, 2024

Conversation

fionaliao
Copy link
Contributor

Mostly more newlines/spaces/bullet points being added

Changed the table used to explain the . regex change to bullet points as I couldn't figure out a way to get an indented table to display properly on the website 😅.

Preview: https://deploy-preview-2540--prometheus-docs.netlify.app/docs/prometheus/latest/migration/ (made some hacky changes to prometheus/docs to do this preview: prometheus/docs#2540)

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
Signed-off-by: Fiona Liao <fiona.liao@grafana.com>

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
Signed-off-by: Fiona Liao <fiona.liao@grafana.com>
Signed-off-by: Fiona Liao <fiona.liao@grafana.com>
Signed-off-by: Fiona Liao <fiona.liao@grafana.com>
following regular expressions now match the accompanying strings, whereas in
Prometheus v2 these combinations didn't match.

| Regex | Additional matches |
Copy link
Member

Choose a reason for hiding this comment

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

Is it really more readable without table? The text feels quite dense now:

image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I think the table would be better, but I didn't figure out a way to get it to display properly on the website. I think tables don't work well with nanoc/kramdown when they're indented within bulleted lists.

Currently the PromQL section looks like:

image

With the table section messed up

Copy link
Member

@bwplotka bwplotka left a comment

Choose a reason for hiding this comment

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

LGTM just wonder if table for regex change is worth keeping, thanks!

Signed-off-by: Fiona Liao <fiona.liao@grafana.com>
@bboreham bboreham merged commit 32e28a2 into prometheus:release-3.0 Nov 12, 2024
31 checks passed
@fionaliao fionaliao deleted the fix-migration-guide branch November 12, 2024 13:58
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.

None yet

4 participants