Links with relative path towards other .md files open github instead of the page itself
JordanJordanov opened this issue · comments
What happened:
Links with relative path towards other .md files open github instead of the page itself
What you expected to happen:
How to reproduce it (as minimally and precisely as possible):
- https://gardener.cloud/docs/concepts/core-components/api-server/ page, towards the end has 'Please see this separate documentation file.' The link is defined as '../usage/openidconnect-presets.md' and resolved as https://github.com/gardener/gardener/blob/master/docs/usage/openidconnect-presets.md which is not correct
- https://gardener.cloud/docs/guides/applications/access_pod_from_local/ page has a link 'Access my service' defined as '../service-access/', resolved to https://github.com/gardener/documentation/tree/master/website/documentation/guides/applications/service-access
- https://gardener.cloud/blog/2021-01/00/machine-controller-manager/ -> all links to other pages within the site are broken
- ...
Anything else we need to know:
How to categorize this issue?
/kind bug
/priority critical
As discussed, for the 1st example the link is not resolved correctly, because the targeted page is not part of the site (it's not part of the manifest), so the page is treated as external. The solution will be to include openidconnect-presets.md in the manifest
For the other examples - Docforge would have parsed the url correctly if the url was pointing to a concrete .md file.
We shall add support for urls which end in / (thus pointing logically to the _index.md file in the directory)