Skip to content
This repository was archived by the owner on Jan 24, 2024. It is now read-only.

Conversation

@BewareMyPower
Copy link
Collaborator

Motivation

#389 exposed the metrics for KoP and added the docs. However, users cannot click into the metrics docs in the main web page.

Modifications

Add the link of metrics docs to README.md. In addition, sync docs/kop.md with README.md so that upgrade.md and reference-metrics.md can both be navigated from SN hub. Then remove the Upgrade section because it's duplicated with upgrade.md.

@BewareMyPower
Copy link
Collaborator Author

PTAL @Huanli-Meng

Copy link
Contributor

@Huanli-Meng Huanli-Meng left a comment

Choose a reason for hiding this comment

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

LGTM. One more question, should we sync KoP Readme to SN hub? if need. We need to submit a PR in SN hub repo.

@BewareMyPower
Copy link
Collaborator Author

@Huanli-Meng It's better not. Because it requires the docs using {{protocol:version}}, which leads to some wrong links in github pages.

@BewareMyPower BewareMyPower merged commit cffa9db into streamnative:master Nov 17, 2021
@BewareMyPower BewareMyPower deleted the bewaremypower/doc-hub-update branch November 17, 2021 01:57
BewareMyPower added a commit that referenced this pull request Nov 17, 2021
### Motivation

#389 exposed the metrics for KoP and added the docs. However, users cannot click into the metrics docs in the main web page.

### Modifications

Add the link of metrics docs to README.md. In addition, sync docs/kop.md with README.md so that upgrade.md and reference-metrics.md can both be navigated from SN hub. Then remove the **Upgrade** section because it's duplicated with upgrade.md.
BewareMyPower added a commit that referenced this pull request Nov 17, 2021
### Motivation

#389 exposed the metrics for KoP and added the docs. However, users cannot click into the metrics docs in the main web page.

### Modifications

Add the link of metrics docs to README.md. In addition, sync docs/kop.md with README.md so that upgrade.md and reference-metrics.md can both be navigated from SN hub. Then remove the **Upgrade** section because it's duplicated with upgrade.md.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants