pulsar icon indicating copy to clipboard operation
pulsar copied to clipboard

[Doc] Historical doc versions still have a number of broken doc page links

Open momo-jun opened this issue 3 years ago • 0 comments

What issue do you find in Pulsar docs?

Due to the website upgrade (adopting Docusaurus 2.0), all internal page links on Pulsar doc pages should strictly contain .md extensions. Otherwise, the links cannot be redirected as expected and return 404. Therefore, a number of links need to be adapted to the new framework with new rules.

By now, the broken links in 2.8.x, 2.9.x, 2.10.x, and next have been fixed.

What is your suggestion?

  1. Use the Regex (\[[^\]]+\]\((?!http|assets|\.|\/|#)((?!\.md|:|\.|#).)*)\) to search for occurrences with this issue.
  2. Add .md to each internal page link. image

Do you have any references?

Related PRs that fixed this issue for 2.10.x

  • https://github.com/apache/pulsar/pull/16190
  • https://github.com/apache/pulsar/pull/16367 (master and 2.10)
  • https://github.com/apache/pulsar/pull/16413 (2.10.1)

Would you like to fix this issue?

Yes.

Note

  • [X] I have researched my question.

momo-jun avatar Jul 20 '22 11:07 momo-jun