search

jina-ai / jina

☁️ Build multimodal AI applications with cloud-native stack
https://docs.jina.ai
Apache License 2.0
20.99k stars 2.22k forks source link

Redirection of links in docs not working #1030

Closed bwanglzu closed 3 years ago

bwanglzu commented 3 years ago

I was looking at the change logs here, the redirection of links such as RELEASE NOTE 0.0.4 is not working in my browser.

This also happens here.

Tested on safari & chrome.

danielkomaz commented 3 years ago

I updated the links within the CHANGELOG.md and CONTRIBUTING.md because they were i the wrong format "001" instead of "0-0-1" Also fixed a few other broken links in hub/build-pod-image.md and hub/publish-your-pod-image.md https://github.com/jina-ai/jina/pull/1033

jancijen commented 3 years ago

@hanxiao This remains a problem because there is a GitHub worfkflow (see commits with message chore(docs): update TOC) which automatically re-generate CONTRIBUTING.md and CHANGELOG.md.

It is specified in contributors.yml. Therefore it seems that link generation is handled by https://github.com/technote-space/toc-generator.

This can be fixed by using manual html hyperlink tags as I described in #1032, with the anchors naming convention that is automatically generated by toc-generator (the one that works fine on GitHub). I will submit a PR.