SkyeYoung commented on issue #1055: URL: https://github.com/apache/apisix-website/issues/1055#issuecomment-1108703660
> @SkyeYoung Yes. That is correct. However, does the current link checker check for cases where links are on other repos? > > Since all the files from all the repos are pulled in `apisix-website` during build, links referencing other repos should work for the link checker in this repository. > > For docs changes in the other repos, we can't however check this as we do not build the website in those repos. Only static link checking will work and it will fail in the case where we refer documents in other repos. > > Does this make sense? > > _Originally posted by @navendu-pottekkat in https://github.com/apache/apisix-website/issues/1047#issuecomment-1108636219_ @navendu-pottekkat The checker will check for links in other repositories. (Although it was not written by me) But the question you ask is actually very complicated. When you add links to our other repositories like in one of the articles, you need to determine the format of the links you use: 1. Using internal link, like relative path (`../apisix/xxx`),or absolute path (`/docs/apisix/xxxx`) 2. Using external link, such as `https://apisix.apache.org/docs/apisix/xxxx` The first type will undoubtedly be treated as an internal file, and the checker will check if the file exists. (This can cause problems and should be avoided if the article being cited is new) The second type will be treated as an external link and checked for existence by means of a ping. (The actual processing is a bit more complicated, and I don't fully understand how the current link checker works.) > For docs changes in the other repos, we can't however check this as we do not build the website in those repos. Maybe I expressed it wrong, what I wanted to say is that we can check on the website repository, but still need to modify the failed links in other repositories than the website repository. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
