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

Metrics documentation is missing placeholder text #2579

Closed
Donnerbart opened this issue Nov 15, 2024 · 1 comment · Fixed by #2580
Closed

Metrics documentation is missing placeholder text #2579

Donnerbart opened this issue Nov 15, 2024 · 1 comment · Fixed by #2580

Comments

@Donnerbart
Copy link
Contributor

Donnerbart commented Nov 15, 2024

Bug Report

The metrics table in the documentation is missing the <reconciler name> and <resourcemetadata> placeholders.

What did you do?

Open https://javaoperatorsdk.io/docs/features/#metrics in a browser and scroll down to the metrics table.

What did you expect to see?

Complete metric and tag names.

What did you see instead? Under which circumstances?

Some metric and tag names are incomplete, due to not-rendered placeholders.

Screenshot from 2024-11-15 11-45-40

Possible Solution

The special characters must be put in a literal or escaped.

Additional context

It would also be great to have a distinct anchor for the metrics table for a direct link to the available metrics.

@Donnerbart
Copy link
Contributor Author

Donnerbart commented Nov 15, 2024

I've provided fix PRs for the main and next branch.

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant