Change absolute paths to relative paths in docs

[Atish-iaf]

No description provided.

[Atish-iaf]

/skip-all

[luolanzone]

I believe @tnqn mentioned that the root cause is we should use relative path in the issue comment.
you should update it as following one.

Suggested change

	checked-in [deployment yaml](https://github.com/antrea-io/antrea/blob/main/build/yamls/antrea-aks.yml):
	checked-in [deployment yaml](./build/yamls/antrea-aks.yml):

[Atish-iaf]

This wouldn't work because it expands to wrong path and searches for the file in antrea website repo.
Actually any relative path wouldn't work here because these files (mostly yaml) are not present in antrea website github repo.

[rajnkamr]

If relative path has to work , the folder "build/yamls/" needs to be created on https://antrea.io and then each file needs to be available there, otherwise will have to use absolute GitHub path

[luolanzone]

I doubt this is the right way to fix the issue. If you change it to a link, then when you have any changes on a local file, it will jump to a website link which point to a main branch file. I don't think this is what we expected.
Let's see what's @antoninbas and @tnqn 's comments.

[antoninbas]

All the docs should use relative paths. The link should be ../build/yamls/antrea-aks.yml here

The right way to fix it is in the scripts which generate the website source (they should do link substitution when applicable: ../build/yamls/antrea-aks.yml -> https://github.com/antrea-io/antrea/blob/<CORRECT TAG>/build/yamls/antrea-aks.yml)

[Atish-iaf]

Thanks, changed to use relative path.

[antoninbas]

while this change is correct, and needed IMO, it doesn't by itself fix issue #4353, and so adding Fixes #4353 to the commit message is incorrect.

in addition to this change, the https://github.com/antrea-io/website/blob/main/scripts/pkg/update-docs.go logic also needs to be improved to translate links to the build/ directory into absolute http links, as I described in a previous comment.

[Atish-iaf]

while this change is correct, and needed IMO, it doesn't by itself fix issue #4353, and so adding Fixes #4353 to the commit message is incorrect.

in addition to this change, the https://github.com/antrea-io/website/blob/main/scripts/pkg/update-docs.go logic also needs to be improved to translate links to the build/ directory into absolute http links, as I described in a previous comment.

Hi @antoninbas, thanks for your suggestions. I have few questions.

1. Could you please help me understand why changes made in this PR are needed? We can skip this PR and make changes in website repo to translate existing relative links to appropriate absolute links. Also, the existing relative links works fine when inside local antrea repo, so why to add .. as prefix in existing relative links. Both will work same when inside local antrea repo.
2. At few places in documentation (https://github.com/antrea-io/antrea/blob/main/docs/aks-installation.md#:~:text=To%20deploy%20the%20latest%20version%20of%20Antrea%20(built%20from%20the%20main%20branch)%2C%20use%20the%20checked%2Din%20deployment%20yaml%3A) link should be to the latest antrea.yml, so at these places can we put absolute link to antrea.yml from main branch of antrea github repo? (Here, I am saying not to translate)

[antoninbas]

1. It is not strictly needed for these links to the build/ directory (since we have to transform them manually anyway). However, as a rule, the website scripts don't render absolute documentation links correctly (by absolute, I mean like /docs/foo.md, and not URLs) and it is safer to always stick to relative links (docs/foo.md, ../docs/foo.md). Ideally we would have a lint rule to prevent absolute markdown links (i.e., links starting with a /). It should be possible for us to add a custom rule to markdownlint.
2. No, it is not correct to always point to the main version. The antrea.io website includes a different version of the documentation for each recent release (check https://antrea.io/docs/v1.10.0/). When visiting the documentation for an older release, links should point to the correct version of the manifests (and not point to main). This is why I described the "correct link substitution" in Change absolute paths to relative paths in docs #4698 (comment).

[antoninbas]

/skip-all