[fix][doc] Optimize URLs for CLI tools page - #18101
Conversation
|
@SignorMercurio |
tisonkun
left a comment
There was a problem hiding this comment.
I check the experience from:
- https://pulsar.apache.org/docs/next/reference-cli-bookkeeper/
- https://pulsar.apache.org/docs/next/reference-cli-tools/
All works correctly. Could you share a video to clarify the issue?
Screen.Recording.2022-10-19.at.13.11.46.mov
SignorMercurio
left a comment
There was a problem hiding this comment.
Why not use a single link instead of a list of CLI tool?
|
@SignorMercurio updated as you suggested, PTAL |
All commands in the green box are on the same page, so I set them all to https://pulsar.apache.org/reference (users can choose versions then) instead of individual links for lower maintenance costs and a temporary workaround for #18051 (comment) |
tisonkun
left a comment
There was a problem hiding this comment.
OK...Although I think it changes several links if users save them in their bookmark previously.
Comments inline.
| :::tip | ||
|
|
||
| For how to make contributions to documentation, see [Pulsar Documentation Contribution Guide](https://docs.google.com/document/d/11DTnNPpvcPrebLkMAFcDEIFlD8ARD-k6F-LXoIwdD9Y/edit#). | ||
| For how to make contributions to documentation, see [Pulsar Documentation Contribution Guide](../README.md). |
There was a problem hiding this comment.
We don't move this README.md file to the site repo.
You can use https://github.com/apache/pulsar/blob/master/site2/README.md as a workaround, which I hope we can move into another doc page and update these links to the new page.
There was a problem hiding this comment.
It works on the GitHub repository but not for the Pulsar website. You can try to preview it and verify if you can jump to the README.md file.
| --- | ||
| id: reference-cli-bookkeeper | ||
| title: Pulsar CLI tools - bookkeeper | ||
| sidebar_label: "cli-bookkeeper" | ||
| --- |
There was a problem hiding this comment.
Why do you make these chanes? If you'd like to set up redirections, I suggest:
````mdx-code-block
import {Redirect} from '@docusaurus/router';
<Redirect to="/reference" />
````
There was a problem hiding this comment.
@SignorMercurio can I use this? Does it work?
There was a problem hiding this comment.
No, the aim is not redirecting. Actually, reference-cli-bookkeeper.md (and the below) will not be shown on pulsar.apache.org. Rather, it'll be shown only in pulsar.apache.org/reference. Therefore, the frontmatter is no longer useful as it only works for Docusaurus.
| --- | ||
| id: reference-cli-broker-tool | ||
| title: Pulsar CLI tools - broker-tool | ||
| sidebar_label: "cli-broker-tool" | ||
| --- |
| title: Pulsar CLI tools - pulsar-daemon | ||
| sidebar_label: "cli-pulsar-daemon" | ||
| --- | ||
|
|
|
Hi @tisonkun @SignorMercurio I‘ve updated based on your comments:
PTAL and feel free to approve, thanks. |
tisonkun
left a comment
There was a problem hiding this comment.
Generally looks good. I suggest you leave the removing and moving reference cli docs task to @SignorMercurio so that he can simultaneously handle the process.
Otherwise, site build can fail and it takes more effort to recover these files and copy to the pulsar-site repo.
That is, do not remove:
- reference-cli-bookkeeper.md
- reference-cli-broker-tool.md
- reference-cli-pulsar-daemon.md
in this pull request. I think @SignorMercurio will handle it later.
fbc7b67 to
ac48a8c
Compare
@tisonkun OK, I've updated this PR based on your comments, PTAL |
|
Ping @momo-jun to review |
|
ping @momo-jun |


This PR:
Removes
broker-toolbecause [feat][doc] Separate CLI docs for doc gen automation #18051 (comment)Update URLs to https://pulsar.apache.org/reference to make it more generic and easier to maintain
doc