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: Documentation page on certificate management has a broken link to example files #998

Closed
Kowsz opened this issue May 5, 2022 · 3 comments · Fixed by #1007
Closed
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed triage/accepted Indicates an issue or PR is ready to be actively worked on.

Comments

@Kowsz
Copy link
Contributor

Kowsz commented May 5, 2022

Issue description

Hello,

Apache APISIX documentation page Manage Ingress Certificates With Cert Manager link to example cert-manager manifests is broken. The link https://apisix.apache.org/docs/ingress-controller/practices/cert-manager returns a 404 error.

image

Best regards,
Kowsz

Environment

not applicable

Minimal test code / Steps to reproduce

  1. Go to https://apisix.apache.org/docs/ingress-controller/practices/manage-ingress-certificates-with-cert-manager/
  2. Click on the "For testing purposes, we will use a simple CA issuer. All required files can be found here." link

Actual result

image

Error log

not applicable

Expected result

The webserver serves the correct files

@tao12345666333
Copy link
Member

Thanks for your report, it should link to https://github.com/apache/apisix-ingress-controller/tree/master/docs/en/latest/practices/cert-manager

Are you interested in submitting a PR to fix it?

@tao12345666333 tao12345666333 changed the title bug: Documentation page on certificate management has a broken link to example files docs: Documentation page on certificate management has a broken link to example files May 6, 2022
@tao12345666333 tao12345666333 added documentation Improvements or additions to documentation triage/accepted Indicates an issue or PR is ready to be actively worked on. good first issue Good for newcomers help wanted Extra attention is needed labels May 6, 2022
@Kowsz
Copy link
Contributor Author

Kowsz commented May 7, 2022

Yeah, sure.
As far as I can tell, the files to be updated are:

  1. /docs/en/latest/practices/manage-ingress-certificates-with-cert-manager.md
  2. /docs/en/latest/practices/manage-certificates-with-cert-manager.md

Should I also bump the patch version in /docs/en/latest/config.json?

@tao12345666333
Copy link
Member

only update the two markdown files. Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
Development

Successfully merging a pull request may close this issue.

2 participants