Fix various links that were generating URLs with .md
#10548
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Member
Author
|
ping @usha-mandya PTAL |
usha-mandya
reviewed
Apr 1, 2020
thaJeztah
commented
Apr 1, 2020
thaJeztah
force-pushed
the
fix_markdown_links
branch
from
45395dd to
f53fde8
Compare
usha-mandya
previously approved these changes
Apr 1, 2020
Member
usha-mandya
left a comment
usha-mandya
left a comment
There was a problem hiding this comment.
LGTM. Thank you for fixing all the links :)
thaJeztah
force-pushed
the
fix_markdown_links
branch
from
f53fde8 to
c2a9ad9
Compare
usha-mandya
previously approved these changes
Apr 1, 2020
there's a bug causing wrapped links to not work, and replacing some links to point to the .md file, so that IDE's can check if the anchors are valid. Also replaced some links to point to their new location. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
thaJeztah
force-pushed
the
fix_markdown_links
branch
from
c2a9ad9 to
6622697
Compare
Closed
usha-mandya
reviewed
Apr 1, 2020
| - [Discover Network Encryption on | ||
| Kubernetes](/ee/ucp/kubernetes/kubernetes-network-encryption/) | ||
| - [Deploy an Ingress Controller on Kubernetes](/ee/ucp/kubernetes/layer-7-routing/) | ||
| - [Discover Network Encryption on Kubernetes](../kubernetes-network-encryption.md) |
Member
There was a problem hiding this comment.
Wondering why we have a relative path and an absolute path for topics in the same directory
Member
Author
There was a problem hiding this comment.
Looked at some of those (probably worth a discussion after ee-topics have migrated). So:
Advantage of relative links:
- they work when browsing the markdown on GitHub (I think absolute links don't work there, but would have to double-check)
- moving a whole directory to a different location doesn't break links to pages in the same directory
- ^^ this could help with, e.g. moving whole of
ee/ucptopic to an archived location (datacenter/ucp/3.x), and still linking to related topics for the same version (not the "current" version)
Disadvantage of relative links:
- they can be harder to read. it's "ok" when linking to a child directory (
child-dir/page.md), but becomes hard to follow when linking to parent directories (../../../somedir/page.md) - it's hard to find/replace links when things move (can't search for
/some/old/dir/page.mdto find which links needs updating)
I think the disadvantages are real; mostly when linking to "other" topics (linking to, e.g., a reference-docs page from a product manual). I'm ok with using relative links to link within the same topic though.
Member
There was a problem hiding this comment.
Sure, thanks for that. Agree, relative links can be very confusing when linking to parent directories. We can discuss this in one of our weekly syncs.
usha-mandya
reviewed
Apr 1, 2020
There's a bug in the "jekyll-relative-links" plugin that causes wrapped links to not work. Also replacing some links to point to the .md file, so that IDE's can check if the anchors are valid. Finally, replaced some links to point to their new locations, so that users don't get redirected.. Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
thaJeztah
force-pushed
the
fix_markdown_links
branch
from
6622697 to
7640687
Compare
usha-mandya
approved these changes
Apr 1, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There's a bug in the "jekyll-relative-links" plugin that causes wrapped links to not work. Also replacing some links to point to the .md file, so that IDE's can check if the anchors are valid.
Finally, replaced some links to point to their new locations, so that users don't get redirected..
Found wrapped markdown links by grepping for
\[[^\]]*\n.*\]\([^\n]+.mdfixes #10546
closes #10551