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

docs: Fixed broken link to tutorial in Manage API Consumers tutorial #11669

Open
wants to merge 5 commits into
base: master
Choose a base branch
from

Conversation

sreeram-venkitesh
Copy link

Description

This PR is a potential fix for the broken link to the tutorial in #11217. The issue is that the link to the tutorial only exists in the English documentation and not in the Chinese version. It was discussed that we could link the Chinese page to the English version of the tutorial as well. I've updated the link so that both versions of the page points to the correct tutorial page instead of ./expose-api.md, which only exists in the English version and not in Chinese.

Fixes #11217

Checklist

  • I have explained the need for this PR and the problem it solves
  • I have explained the changes or the new features added to this PR
  • I have added tests corresponding to this change
  • I have updated the documentation to reflect this change
  • I have verified that this change is backward compatible (If not, please discuss on the APISIX mailing list first)

@dosubot dosubot bot added size:XS This PR changes 0-9 lines, ignoring generated files. doc Documentation things labels Oct 22, 2024
@sreeram-venkitesh sreeram-venkitesh changed the title Fixed broken link to tutorial in Manage API Consumers tutorial docs: Fixed broken link to tutorial in Manage API Consumers tutorial Oct 22, 2024
@kayx23 kayx23 requested review from kayx23 and guoqqqi October 28, 2024 05:41
@kayx23
Copy link
Member

kayx23 commented Oct 28, 2024

I've updated the link so that both versions of the page points to the correct tutorial page instead of ./expose-api.md, which only exists in the English version and not in Chinese.

This PR updates the internal link to external to allow the Chinese doc (in which the link is currently broken) to redirect to the English doc; but I'm not sure if this is the best practice. @guoqqqi please help confirm.

@guoqqqi
Copy link
Member

guoqqqi commented Oct 29, 2024

I've updated the link so that both versions of the page points to the correct tutorial page instead of ./expose-api.md, which only exists in the English version and not in Chinese.

This PR updates the internal link to external to allow the Chinese doc (in which the link is currently broken) to redirect to the English doc; but I'm not sure if this is the best practice. @guoqqqi please help confirm.

But we already have the corresponding Chinese version, we should modify the documentation of the Chinese version to fix the corresponding broken links. https://apisix.apache.org/zh/docs/apisix/tutorials/expose-api/

@sreeram-venkitesh
Copy link
Author

@guoqqqi Ah thank you! I didn't know that the corresponding tutorial was added in Chinese. I will update the link.

@dosubot dosubot bot added size:L This PR changes 100-499 lines, ignoring generated files. and removed size:XS This PR changes 0-9 lines, ignoring generated files. labels Nov 1, 2024
@sreeram-venkitesh
Copy link
Author

@guoqqqi Please let me know if b1ec6aa will fix this. I have added a manage-api-consumers.md page under the zh directory so that it can use the tutorials/expose-api.md from the zh directory. I couldn't setup docusaurus locally to setup apisix-website and confirm my changes locally. Are there any documentation explaining how to test docs changes locally? Thanks!

@kayx23
Copy link
Member

kayx23 commented Nov 3, 2024

Please check the failed CI.

@sreeram-venkitesh
Copy link
Author

@kayx23 PR needs approval for the checks to run. I've fixed the issue with the new page not being present in docs/zh/latest/config.json file and tested it locally. Need to check the check-links script again.

@kayx23
Copy link
Member

kayx23 commented Nov 4, 2024

Approved. Still has error.

@sreeram-venkitesh
Copy link
Author

@kayx23 I missed to add the .md extension in the link. Please check now.

@sreeram-venkitesh
Copy link
Author

All checks have passed!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation things size:L This PR changes 100-499 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: broken links in manage api consumers page
4 participants