You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2022/12/01 05:12:20 UTC
[GitHub] [pulsar] ericsyh opened a new pull request, #18691: fix(docs): remove irrelevant components metrics links under broker section
ericsyh opened a new pull request, #18691:
URL: https://github.com/apache/pulsar/pull/18691
<!--
### Contribution Checklist
- PR title format should be *[type][component] summary*. For details, see *[Guideline - Pulsar PR Naming Convention](https://docs.google.com/document/d/1d8Pw6ZbWk-_pCKdOmdvx9rnhPiyuxwq60_TrD68d7BA/edit#heading=h.trs9rsex3xom)*.
- Fill out the template below to describe the changes contributed by the pull request. That will give reviewers the context they need to do the review.
- Each pull request should address only one issue, not mix up code from multiple issues.
- Each commit in the pull request has a meaningful commit message
- Once all items of the checklist are addressed, remove the above text and this checklist, leaving only the filled out template below.
-->
<!-- Either this PR fixes an issue, -->
Fixes #xyz
<!-- or this PR is one task of an issue -->
Master Issue: #xyz
### Motivation
On the https://pulsar.apache.org/docs/2.10.x/reference-metrics#broker listed all components metrics ToC links but it should only display for the broker section.
### Modifications
<!-- Describe the modifications you've done. -->
Removed irrelevant components metrics links under the broker section
### Verifying this change
- [x] Make sure that the change passes the CI checks.
*(Please pick either of the following options)*
This change is a trivial rework / code cleanup without any test coverage.
*(or)*
This change is already covered by existing tests, such as *(please describe tests)*.
*(or)*
This change added tests and can be verified as follows:
*(example:)*
- *Added integration tests for end-to-end deployment with large payloads (10MB)*
- *Extended integration test for recovery after broker failure*
### Does this pull request potentially affect one of the following parts:
*If the box was checked, please highlight the changes*
- [ ] Dependencies (add or upgrade a dependency)
- [ ] The public API
- [ ] The schema
- [ ] The default values of configurations
- [ ] The threading model
- [ ] The binary protocol
- [ ] The REST endpoints
- [ ] The admin CLI options
- [ ] Anything that affects deployment
### Documentation
<!-- DO NOT REMOVE THIS SECTION. CHECK THE PROPER BOX ONLY. -->
- [x] `doc` <!-- Your PR contains doc changes. Please attach the local preview screenshots (run `sh start.sh` at `pulsar/site2/website`) to your PR description, or else your PR might not get merged. -->
- [ ] `doc-required` <!-- Your PR changes impact docs and you will update later -->
- [ ] `doc-not-needed` <!-- Your PR changes do not impact docs -->
- [ ] `doc-complete` <!-- Docs have been already added -->
### Matching PR in forked repository
PR in forked repository: <!-- ENTER URL HERE -->
<!--
After opening this PR, the build in apache/pulsar will fail and instructions will
be provided for opening a PR in the PR author's forked repository.
apache/pulsar pull requests should be first tested in your own fork since the
apache/pulsar CI based on GitHub Actions has constrained resources and quota.
GitHub Actions provides separate quota for pull requests that are executed in
a forked repository.
The tests will be run in the forked repository until all PR review comments have
been handled, the tests pass and the PR is approved by a reviewer.
-->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet merged pull request #18691: [fix][doc] remove irrelevant components metrics links under broker section
Posted by GitBox <gi...@apache.org>.
Anonymitaet merged PR #18691:
URL: https://github.com/apache/pulsar/pull/18691
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet commented on pull request #18691: [fix][doc] remove irrelevant components metrics links under broker section
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #18691:
URL: https://github.com/apache/pulsar/pull/18691#issuecomment-1336747661
Thanks for your contribution! May I ask why the contents in the green boxes are not exactly the same?
<img width="947" alt="image" src="https://user-images.githubusercontent.com/50226895/205551860-c16e44fd-5cf6-4724-923d-190c7a469032.png">
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] ericsyh commented on pull request #18691: [fix][doc] remove irrelevant components metrics links under broker section
Posted by GitBox <gi...@apache.org>.
ericsyh commented on PR #18691:
URL: https://github.com/apache/pulsar/pull/18691#issuecomment-1336787336
@Anonymitaet I recheck the broker metrics list with each metrics content. After the fix, the list will keep consistent and I will apply the fix to previous version doc.
The preview looks like
<img width="1169" alt="截屏2022-12-05 下午1 56 44" src="https://user-images.githubusercontent.com/10498732/205560260-b09e30ff-8d8e-4680-a0f2-f034bd966de6.png">
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] ericsyh commented on pull request #18691: [fix][doc] remove irrelevant components metrics links under broker section
Posted by GitBox <gi...@apache.org>.
ericsyh commented on PR #18691:
URL: https://github.com/apache/pulsar/pull/18691#issuecomment-1340372830
@Anonymitaet Applied the suggestions. It will look like
<img width="700" alt="截屏2022-12-07 下午12 54 39" src="https://user-images.githubusercontent.com/10498732/206092016-6a0ac59a-ca14-49ca-9a3d-2be2c27c0069.png">
<img width="700" alt="截屏2022-12-07 下午12 54 49" src="https://user-images.githubusercontent.com/10498732/206092022-3556c63b-94b0-4047-a9bb-6253c7f6fc1c.png">
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] ericsyh commented on pull request #18691: [fix][doc] remove irrelevant components metrics links under broker section
Posted by GitBox <gi...@apache.org>.
ericsyh commented on PR #18691:
URL: https://github.com/apache/pulsar/pull/18691#issuecomment-1338625142
@Anonymitaet
For question 1, I found two markdown title-level issues and fixed.
<img width="1229" alt="截屏2022-12-06 上午10 01 34" src="https://user-images.githubusercontent.com/10498732/205790459-39608d40-b28f-4110-b278-e3b0368d75a3.png">
And for question 2, I guess we didn't have the right navigation panel before on the doc site, which needs a ToC on the main page. And now it's truly a little bit duplicated and will be hard to maintain the ToC in the main page, what's your suggestion shall we remove the ToC and just use the right navigation panel?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet commented on pull request #18691: [fix][doc] remove irrelevant components metrics links under broker section
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #18691:
URL: https://github.com/apache/pulsar/pull/18691#issuecomment-1340268352
@ericsyh thanks for your work! I suggest keeping the ToC on the navigation panel only because:
1) Readers: have a single source of truth (content) and a better reading experience (because the useful content length is shorter)
2) Maintainers: eliminate maintenance efforts. The ToC under the "broker" section might be generated from some editor tools (e.g. VS Code) automatically, which is error-prone.
cc @momo-jun @DaveDuggins @D-2-Ed
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] ericsyh commented on pull request #18691: [fix][doc] remove irrelevant components metrics links under broker section
Posted by GitBox <gi...@apache.org>.
ericsyh commented on PR #18691:
URL: https://github.com/apache/pulsar/pull/18691#issuecomment-1336777277
> Thanks for your contribution! May I ask why the contents in the green boxes are not exactly the same (while they should be)? <img alt="image" width="947" src="https://user-images.githubusercontent.com/50226895/205551860-c16e44fd-5cf6-4724-923d-190c7a469032.png">
I think they should keep same, and I guess I find some issues here
1. Duplicate for `Replication metrics`
<img width="443" alt="截屏2022-12-05 下午1 33 30" src="https://user-images.githubusercontent.com/10498732/205557169-1787d7b8-e542-4c73-91fa-61e72a1f6e8a.png">
2. The markdown title level should be 3 not 4 on `Replication metrics` which make the right side ToC miss to scrape it.
<img width="1095" alt="截屏2022-12-05 下午1 36 59" src="https://user-images.githubusercontent.com/10498732/205557574-e9f5c729-a25d-4e31-93f5-3b127db8cf3a.png">
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [pulsar] Anonymitaet commented on pull request #18691: [fix][doc] remove irrelevant components metrics links under broker section
Posted by GitBox <gi...@apache.org>.
Anonymitaet commented on PR #18691:
URL: https://github.com/apache/pulsar/pull/18691#issuecomment-1338613949
Hi @ericsyh
1. They are still not the same, right?
<img width="890" alt="image" src="https://user-images.githubusercontent.com/50226895/205788616-119adffd-b49d-4065-b687-5733c3eae19b.png">
2. Why would we add a ToC after the `broker` section even though users can see the structure from the right navigation panel? Is it duplicated effort?
<img width="1919" alt="image" src="https://user-images.githubusercontent.com/50226895/205788787-1f65f6e9-0ff7-4df9-9779-999d229899f2.png">
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org