-
Notifications
You must be signed in to change notification settings - Fork 53
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
Move pkg/ext-proc/metrics/README.md -> site-src/guides/metrics.md #373
Conversation
Hi @courageJ. Thanks for your PR. I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. |
✅ Deploy Preview for gateway-api-inference-extension ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
/ok-to-test |
That is not the only change we need, if you look at the preview https://deploy-preview-373--gateway-api-inference-extension.netlify.app/guides/; the metrics guide doesn't show up. We need to add it to https://github.com/kubernetes-sigs/gateway-api-inference-extension/blob/main/mkdocs.yml |
Updated the doc links and verified with |
@@ -57,6 +57,7 @@ nav: | |||
- User Guides: | |||
- Getting started: guides/index.md | |||
- Adapter Rollout: guides/adapter-rollout.md | |||
- Metrics: guides/metrics.md |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I can't comment on the file itself, but here are a few observations from the preview (https://deploy-preview-373--gateway-api-inference-extension.netlify.app/guides):
- The "table of contents" at the top is not needed since it shows up on the right side already.
- When I click on the metrics guide, the left bar completely disappears. Interestingly, when I click on metrics, it sends me to
https://deploy-preview-373--gateway-api-inference-extension.netlify.app/guides/metrics.md
, but for the other guides it sends me to the url without the.md
at the end. - The formatting of the metrics table perhaps can be improved? add gray fill to the headers perhaps? widen the "Labels" cell? See https://deploy-preview-373--gateway-api-inference-extension.netlify.app/guides/metrics.md/#exposed-metrics;
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updated the structure and details.
For the table, I used bold text to highlight the headers instead of colors as when my cursor moves to any row of this table, that row will also be gray.
/lgtm Thanks! |
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: ahg-g, courageJ 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 |
Addressing #347