Skip to content
This repository has been archived by the owner on Apr 1, 2024. It is now read-only.

ISSUE-19676: [Doc] Use the reference site (replacing tools) with versioned links #5575

Open
1 of 2 tasks
sijie opened this issue Mar 1, 2023 · 0 comments
Open
1 of 2 tasks

Comments

@sijie
Copy link
Member

sijie commented Mar 1, 2023

Original Issue: apache#19676


Search before asking

  • I searched in the issues and found nothing similar.

What issue do you find in Pulsar docs?

The new reference site https://pulsar.apache.org/reference/ has been built, while up to 200 links are still pointing to the old tools site https://pulsar.apache.org/tools/ in the master branch.

Given that the user experience of the tools site has the following cons/inconvenience:

  • The root/main page seems to be unfinished/unpolished.
  • Inside the command pages, there is no anchor to locate a specific command directly.

What is your suggestion?

In the latest discussion, the consesus is we'd better:

  1. replace the existing links https://pulsar.apache.org/tools/ with https://pulsar.apache.org/reference/
  2. specify a link to a specific command for a particular Pulsar version.

The challenge of suggestion no.2 is to take the current version from the Docusaurus context (2.11.x) and convert it to the version used in reference documentation.

Any reference?

As @tisonkun pointed out in this comment, some functions in the pulsar-site code can handle versions with contextual pages when you search for versions in *.js and *.ts files.

Are you willing to submit a PR?

  • I'm willing to submit a PR!
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant