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: health-check Page Not Found #10035

Closed
qyk1995 opened this issue Aug 16, 2023 · 16 comments
Closed

docs: health-check Page Not Found #10035

qyk1995 opened this issue Aug 16, 2023 · 16 comments
Assignees
Labels
doc Documentation things

Comments

@qyk1995
Copy link

qyk1995 commented Aug 16, 2023

Current State

Description of the current state/issue:
404 Page Not Found

Link to the page:

https://apisix.apache.org/zh/docs/apisix/admin-api/health-check.md/

Screenshots (if relevant):

Desired State

Description of the change you are proposing:

Would you like to fix this issue?

None

@yzeng25 yzeng25 transferred this issue from apache/apisix-website Aug 17, 2023
@yzeng25 yzeng25 added the doc Documentation things label Aug 17, 2023
@shreemaan-abhishek
Copy link
Contributor

feel free to raise a PR.

@yuluo-yx
Copy link
Member

@qyk1995 I didn't find the specific link address, can you take a screenshot to point out where it is

@yuluo-yx
Copy link
Member

@shreemaan-abhishek Please assign to me, I will try solve it.

@yuluo-yx
Copy link
Member

yuluo-yx commented Aug 21, 2023

@yzeng25 I found that in the documentation of the apisix warehouse, his link address is correct, and when the clone apisix-website project, the link points to the wrong address

`,其中 `arg_***` 是来自 URL 的请求参数,详细信息请参考 [NGINX 变量列表](http://nginx.org/en/docs/varindex.html)。 |                                                  |
| checks         | 否                                             | health_checker | 配置健康检查的参数,详细信息请参考 [health-check](./tutorials/health-check.md)。 

Any Idea?

@yzeng25
Copy link
Contributor

yzeng25 commented Aug 21, 2023

@yzeng25 I found that in the documentation of the apisix warehouse, his link address is correct, and when the clone apisix-website project, the link points to the wrong address

`,其中 `arg_***` 是来自 URL 的请求参数,详细信息请参考 [NGINX 变量列表](http://nginx.org/en/docs/varindex.html)。 |                                                  |
| checks         | 否                                             | health_checker | 配置健康检查的参数,详细信息请参考 [health-check](./tutorials/health-check.md)。 

Any Idea?

@yuluo-yx ,you meant [health-check](./tutorials/health-check.md) right?

@yuluo-yx
Copy link
Member

yuluo-yx commented Aug 21, 2023

@yzeng25 I found that in the documentation of the apisix warehouse, his link address is correct, and when the clone apisix-website project, the link points to the wrong address

`,其中 `arg_***` 是来自 URL 的请求参数,详细信息请参考 [NGINX 变量列表](http://nginx.org/en/docs/varindex.html)。 |                                                  |
| checks         | 否                                             | health_checker | 配置健康检查的参数,详细信息请参考 [health-check](./tutorials/health-check.md)。 

Any Idea?

@yuluo-yx ,you meant [health-check](./tutorials/health-check.md) right?

yeay, you can refer to https://github.com/apache/apisix/tree/master/docs/zh/latest/tutorials, This file does exist in this folder

@yuluo-yx
Copy link
Member

yuluo-yx commented Aug 21, 2023

@yzeng25
Sorry, for some reason, I can't post pictures in the discussion area, I can only show them to you in the form of code blocks!
This is the content under the en language,

Configures the parameters for the [health check](./tutorials/health-check.md).   

this link is reachable:
https://apisix.apache.org/docs/apisix/tutorials/health-check/

@yzeng25
Copy link
Contributor

yzeng25 commented Aug 21, 2023

@yuluo-yx ,can you provide the link of the page that contains the dead link?

@yuluo-yx
Copy link
Member

yuluo-yx commented Aug 21, 2023

@yzeng25 of cources,
zh : https://apisix.apache.org/zh/docs/apisix/admin-api/health-check.md/.
zh doc: 详细信息请参考 [health-check](./tutorials/health-check.md)。
en : https://apisix.apache.org/docs/apisix/tutorials/health-check/
en doc: the [health check](./tutorials/health-check.md).
The obvious difference between them is the path problem, but the path of apisix seems to be suitable, and the paths of zh and en are consistent

@yzeng25
Copy link
Contributor

yzeng25 commented Aug 21, 2023

@yuluo-yx You can raise a pull request with the following change in zh-cn doc:

详细信息请参考 [health-check](./tutorials/health-check.md)

@yuluo-yx
Copy link
Member

@yuluo-yx You can raise a pull request with the following change in zh-cn doc:

详细信息请参考 [health-check](./tutorials/health-check.md)

Sorry, I don't quite understand what you mean, the content of this document is just like this, no need to change.

@yzeng25
Copy link
Contributor

yzeng25 commented Aug 21, 2023

@yuluo-yx Change ./admin-api/health-check.md to ./tutorials/health-check.md will solve the problem.

@yzeng25
Copy link
Contributor

yzeng25 commented Aug 21, 2023

@yuluo-yx , In zh-cn doc, the dead link problem occurs in this page: https://apisix.apache.org/zh/docs/apisix/admin-api/#upstream-body-request-methods

image

When digging into the link and doc revision history, the health-check.md file has been moved out of admin-api folder since #8129, which was merged on Oct 25th, 2022.

On the other hand, the en-us doc is correct. So then you can raise a pull request to fix the problem in zh-cn doc. Open the admin-api,md file under zh-cn path, search for ./admin-api/health-check.md and replace it with ./admin-api/health-check.md should fix the problem.

To go a step forward, you can global search ./admin-api/health-check.md and replace it with ./admin-api/health-check.md in all files, so that you can fix the same problem occurs in all docs.

@yuluo-yx
Copy link
Member

yuluo-yx commented Aug 21, 2023

I can understand what you mean, but there is only one version of the latest folder under the apisix docs/zh folder.
In the latest version, the address of the zh docis the same as the address pointed to by the en doc.

you can see :

they have the same address.

docs
| -- turtorials
| -- | -- health-check.md
| -- admin-api.md (ref ./turtorials/health-check.md)

As shown above, I cannot modify the parent path of admin-api.md, I can only modify the reference file path in this admin-api.md

and as you can see the wrong path is:

docs
| -- turtorials
| -- | -- health-check.md
| -- admin-api.md (ref ./health-check.md)

But from the apisix documentation, the paths of zh and en are consistent, and I don’t know how to modify them. This is where I am troubled.

@yzeng25

@yzeng25
Copy link
Contributor

yzeng25 commented Aug 21, 2023

Oh ok, I see. Then we can come back and check when the next version is released. The changes in the latest folder should be able to actually show up in the web page along with the release of next version, @yuluo-yx .

@yuluo-yx
Copy link
Member

Oh ok, I see. Then we can come back and check when the next version is released. The changes in the latest folder should be able to actually show up in the web page along with the release of next version, @yuluo-yx .

ok, got it🫡

@shreemaan-abhishek shreemaan-abhishek changed the title [Docs]: health-check Page Not Found docs: health-check Page Not Found Aug 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
doc Documentation things
Projects
Archived in project
Development

No branches or pull requests

4 participants