Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[feat][website] REST API URL does not go to the correct place #14928

Closed
Anonymitaet opened this issue Mar 29, 2022 · 16 comments
Closed

[feat][website] REST API URL does not go to the correct place #14928

Anonymitaet opened this issue Mar 29, 2022 · 16 comments
Labels
doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.

Comments

@Anonymitaet
Copy link
Member

Anonymitaet commented Mar 29, 2022

All REST API URL on Pulsar documentation has this issue.

Website: https://pulsar.apache.org/docs/en/next/admin-api-tenants/

image

@urfreespace thinks the anchor does not work correctly but we have not figured out how to solve this issue

Anyone would like to fix it? Thanks

@Anonymitaet Anonymitaet added doc Your PR contains doc changes, no matter whether the changes are in markdown or code files. website labels Mar 29, 2022
@github-actions
Copy link

The issue had no activity for 30 days, mark with Stale label.

@Anonymitaet
Copy link
Member Author

Feedback from @BewareMyPower:

Hi, I'm reporting a bug of the new website again:joy:The rendering of the REST API is wrong. See https://pulsar.apache.org/docs/next/schema-manage/#topic-level.

We can see GET /admin/v2/topics/:tenant/:namespace/:topic. However, the original text is
{@Inject: endpoint|GET|/admin/v2/topics/:tenant/:namespace/:topic|operation/schemaCompatibilityStrategy?version=[[pulsar:version_number]]}

It's frustrated that I cannot compare it with the rendering of the old website. (should we add an entry point to the old website?) But the rendering result should be like the 2nd image.

BTW, I think the description Send a PUT request to this endpoint: is redundant. See the 3rd image from https://pulsar.apache.org/docs/next/admin-api-topics.

image
image
image

@urfreespace
Copy link
Member

@Anonymitaet you can access the old website here: https://pulsar.staged.apache.org/ (it's the old website backup, it will be closed AFTER the new site is stable)

@Anonymitaet
Copy link
Member Author

@urfreespace OK, thanks!

@github-actions
Copy link

The issue had no activity for 30 days, mark with Stale label.

@horizonzy
Copy link
Member

The pr apache/pulsar-site#127 submit, maybe fix this problem

@github-actions github-actions bot removed the Stale label Jun 30, 2022
@Anonymitaet
Copy link
Member Author

@momo-jun I check some occurrences on master, and they do not function well. For example:
image
https://pulsar.apache.org/docs/next/admin-api-functions

Can you take a look? Thank you!

@Anonymitaet
Copy link
Member Author

@momo-jun your PR was merged 3 hours ago and the website build was done 4 hours ago, maybe that is the reason why the new changes do not take effect. Let's wait for a while to see if it works. Thank you.

@Anonymitaet
Copy link
Member Author

@momo-jun do you update all occurrences only for master or master + other versions?

@momo-jun
Copy link
Contributor

momo-jun commented Jul 7, 2022

@momo-jun do you update all occurrences only for master or master + other versions?

Master only. I want to verify whether they work well before applying the changes to more versions.

@momo-jun
Copy link
Contributor

momo-jun commented Jul 8, 2022

@Anonymitaet the issue has been fixed and verified. I will find some time to update those links in versioned docs.

@Anonymitaet
Copy link
Member Author

@momo-jun

I check some occurrences randomly and find that:

  1. It shows loading all the time, do you have the same issue?
    package: https://pulsar.apache.org/docs/next/admin-api-packages

image

  1. Some contain version while others not, is this intended behavior?

image

@momo-jun
Copy link
Contributor

momo-jun commented Jul 8, 2022

Same on my side. I checked the MD file and its syntax {@inject: endpoint|POST|/admin/v3/packages/:type/:tenant/:namespace/:packageName/:version} doesn't contain any anchor nor the version number variable, that's why it cannot be loaded. Since it doesn't contain the version number variable, such cases are not covered in the previous fix. I need to use a new search term to clean up this type of occurrence. Thanks for your check.

  1. It shows loading all the time, do you have the same issue?
    package: https://pulsar.apache.org/docs/next/admin-api-packages
image

The version we can see here does not refer to the injected version number, but a static text. The display text is correct. The only issue is the same as above - the syntax needs to be fixed by adding a version number variable and an anchor.

  1. Some contain version while others not, is this intended behavior?
image

@momo-jun
Copy link
Contributor

momo-jun commented Jul 8, 2022

When searching for the remaining incorrect REST API links, I found the REST API docs missed "lookup topic" and "get bundles".
@shibd helped checked the issue in code and pushed a PR-#16470 to fix it.

I've fixed other incorrect REST API links in #16433 and will update for "lookup topic" and "get bundles" as soon as #16470 is merged.

@github-actions
Copy link

github-actions bot commented Aug 8, 2022

The issue had no activity for 30 days, mark with Stale label.

@github-actions github-actions bot added the Stale label Aug 8, 2022
@momo-jun
Copy link
Contributor

This issue can be closed after #16746 is merged. Any other problematic occurrence is an individual case of error.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Your PR contains doc changes, no matter whether the changes are in markdown or code files.
Projects
None yet
Development

No branches or pull requests

4 participants