[Doc] Broken links at /admin-api-clusters

[visortelle]

Search before asking

• I searched in the issues and found nothing similar.

What issue do you find in Pulsar docs?

https://pulsar.apache.org/docs/2.11.x/admin-api-clusters/#update-peer-cluster-data

• Pulsar admin doc
• pulsar-admin

• create

• There are more broken links to fix on this page. Please check.

What is your suggestion?

Fix it.

Any reference?

No response

Are you willing to submit a PR?

• I'm willing to submit a PR!

[momo-jun]

I've checked this page and the links you mentioned, all of which redirects to the following page. @visortelle Is this the issue you meant?

Actually, it's by design, and users can select a specific version to continue. Feel free to share your ideas.

[visortelle]

@momo-jun There are links on the page that definitely don't work. For example:

Both REST API links:

5 minutes ago @RobertIndie already created a separate issue for it: #19644

---

Regarding that many links about CLI commands refer to the same page.

As I see, it's possible to specify a link to specific command for a particular Pulsar version.
https://pulsar.apache.org/tools/pulsar-admin/2.11.0-SNAPSHOT/#-em-create-em-

If I understand it right, the problem is how to take the current version from the Docusaurus context (2.11.x), and convert it to the version that is used in auto-generated CLI tools documentation (2.11.0-SNAPSHOT). Then use it as a template variable in the docs markdown.

There is some discussion on this topic here: facebook/docusaurus#395. But I'm not ready to dig into this now.

As a docs reader, I the current behavior is inconvenient, but not critical to run and fix it right now. :)

Maybe @tisonkun has any ideas?

[tisonkun]

@visortelle I don't go through the whole issue, but for tools, I believe it should be superseded by https://pulsar.apache.org/reference/. In the site code if you search version in *.js and *.ts you may find some functions to handling versions from the page context.

[visortelle]

+1 for switching links to https://pulsar.apache.org/reference/

🐞 Anchors work after the page refresh, but don't work when I click on them.

Probably related to this issue: docsifyjs/docsify#351 (comment)

Screen.Recording.2023-02-27.at.11.54.18.AM.mov

[momo-jun]

@visortelle Thanks for the clarification. Now I understand the scope of this issue is all about the links to REST APIs. Ping @urfreespace to take a look at this issue.

If I understand it right, the problem is how to take the current version from the Docusaurus context (2.11.x), and convert it to the version that is used in auto-generated CLI tools documentation (2.11.0-SNAPSHOT). Then use it as a template variable in the docs markdown.

Agree. This behavior is more user-friendly. This challenge of implementing it still exists if we use https://pulsar.apache.org/reference/ as the reference link.

[momo-jun]

REST API links should have been fixed by @urfreespace through apache/pulsar-site#439. I will double-check the result later today and close this issue.

For switching links from https://pulsar.apache.org/tools/ to https://pulsar.apache.org/reference/, ping @Anonymitaet to take a look. I'm not sure whether the tools site can be abandoned.

[Anonymitaet]

+1 on replacing https://pulsar.apache.org/tools/ with https://pulsar.apache.org/reference/

[momo-jun]

@visortelle I've filed #19676 to track the issue of using the reference site (replacing tools) with versioned links and closed this one. Thank you.