docs: generate page for metrics per version to replace plain .txt file#1139
Conversation
Signed-off-by: Christoph Jandl <cjandl98@gmail.com>
|
Hi @christophsj. Thanks for your PR. I'm waiting for a etcd-io member to verify that this patch is reasonable to test. If it is, they should reply with Regular contributors should join the org to skip this step. Once the patch is verified, the new status will be reflected by the I understand the commands that are listed here. DetailsInstructions 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. |
|
@ronaldngounou: The Use DetailsIn response to this:
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. |
|
/ok-to-test |
Signed-off-by: Christoph Jandl <cjandl98@gmail.com>
3315cbc to
5147d2f
Compare
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: christophsj, jberkus The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
Thanks! And let us know if you want to work on the long-term replacement. |
|
@jberkus definitely, would be glad to keep working on this |
Create pages for displaying a list of metrics per version, instead of linking to a plain .txt file.
This will make it much easier to read and navigate through the metrics.
The page is based on .txt file content, e.g.:
# name: "etcd_network_peer_round_trip_time_seconds"
# description: "Round-Trip-Time histogram between peers"
# type: "histogram"
etcd_network_peer_round_trip_time_seconds_bucket{To="REMOTE_PEER_NODE_ID",le="+Inf"}
will be parsed into a single row in the table with name, description, type.
Also, Labels within the metric (To="REMOTE_PEER_NODE_ID",le="+Inf" in this example) and one example value will be displayed.
metrics.md was renamed/moved to metrics/_index.md to make breadcrumb navigation work.
{{< metrics-list >}} is no longer necessary because the links to child pages will be automatically generated below the content.
Use simple_list: true to remove the separator between the heading Generated list of metrics and links to the versions
Issue #1133