[GitHub] [pulsar] visortelle commented on issue #19604: [Doc] Broken links at /admin-api-clusters

[via GitHub]

visortelle commented on issue #19604:
URL: https://github.com/apache/pulsar/issues/19604#issuecomment-1445972730

   @momo-jun There are links on the page that definitely don't work. For 
example:
   
   <img width="512" alt="Screenshot 2023-02-27 at 9 36 32 AM" 
src="https://user-images.githubusercontent.com/9302460/221513953-0c14ef8c-a609-47bf-84aa-c67e83fbbae3.png";>
   
   Both REST API links:
   <img width="980" alt="Screenshot 2023-02-27 at 9 36 53 AM" 
src="https://user-images.githubusercontent.com/9302460/221514013-1b2fec4d-6206-4291-afd2-f06fde7ed957.png";>
   
   5 minutes ago @RobertIndie  already created a separate issue for it: 
https://github.com/apache/pulsar/issues/19644
   
   ---
   
   Regarding that many links about CLI commands refer to the same page.
   
   <img width="545" alt="Screenshot 2023-02-27 at 9 42 46 AM" 
src="https://user-images.githubusercontent.com/9302460/221515264-3389ec11-8094-4881-897c-2a86a414d27e.png";>
   
   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-
   
   <img width="924" alt="Screenshot 2023-02-27 at 9 48 30 AM" 
src="https://user-images.githubusercontent.com/9302460/221516498-35aad5e2-1e9c-4007-8cb6-14da96a851c0.png";>
   
   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: 
https://github.com/facebook/docusaurus/issues/395. But I'm not ready to dig 
into this now.
   
   As a docs reader, I the problem inconvenient, but not critical to run fix it 
right now. :)
   
   Maybe @tisonkun has any ideas?
   


-- 
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-unsubscr...@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
us...@infra.apache.org