Use relative markdown links #10615
Use relative markdown links #10615
Conversation
thaJeztah
force-pushed
the
relative_links
branch
from
b1d7ada to
fafe6e6
Compare
|
Deploy preview for docsdocker ready! Built with commit b1d7ada |
|
Deploy preview for docsdocker ready! Built with commit eb94850 |
|
Added some minor comments. @StefanScherer Appreciate an extra pair of eyes for the review as there are quite a lot of URLs that are updated. |
|
Let me see if I can fix that javascript thing. 😞 |
thaJeztah
force-pushed
the
relative_links
branch
from
fafe6e6 to
bc79cea
Compare
|
@usha-mandya @StefanScherer I pushed some commits to this PR to remove the "baseHref" from pages, fix links that were generated in the reference docs template, and to fix the JavaScript "link fix"; I also moved that script to only run on the reference pages (which is the only place where we should need it. |
thaJeztah
force-pushed
the
relative_links
branch
3 times, most recently
from
1f0949c to
f641096
Compare
Unfortunately, the only reliable way to create internal links is to use relative links to other Markdown files. This does match the way links on GitHub work, but makes it harder to create these links. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Unfortunately, the only reliable way to create internal links is to use relative links to other Markdown files. This does match the way links on GitHub work, but makes it harder to create these links. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Unfortunately, the only reliable way to create internal links is to use relative links to other Markdown files. This does match the way links on GitHub work, but makes it harder to create these links. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
thaJeztah
force-pushed
the
relative_links
branch
from
f641096 to
eb94850
Compare
|
Rebased, now that #10549 was merged; this should be ready for review again (and links should all work now) |
usha-mandya
left a comment
usha-mandya
left a comment
There was a problem hiding this comment.
Thank you @thaJeztah. The previous issues are all fixed now.
StefanScherer
left a comment
StefanScherer
left a comment
There was a problem hiding this comment.
LGTM
tested a few links and found no issues.
3 participants
Unfortunately, the only reliable way to create internal links is to use relative links to other Markdown files. This does match the way links on GitHub work, but makes it harder to create these links.
This PR changes most links to use relative paths; for now, I excluded the "enterprise" sections, as those will be migrated to the Mirantis website soon
The reference docs need some more investigating, as it looks like the Markdown inserted from the YAML files are not converted correctly (links are generated includingsee #10549.md); possibly because paths are resolved relative to the include?)