Make Markdown links relative, so browsing a git ref stays in the same git ref #173
Conversation
This file contains 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
6 tasks
webmat
changed the title
webmat
changed the title
ruflin
reviewed
Nov 7, 2018
| * [Logging](https://github.com/elastic/ecs/blob/master/use-cases/logging.md) | ||
| * [Metricbeat](https://github.com/elastic/ecs/blob/master/use-cases/metricbeat.md) | ||
| * [TLS](https://github.com/elastic/ecs/blob/master/use-cases/tls.md) | ||
| * [APM](use-cases/apm.md) |
There was a problem hiding this comment.
I'm wondering if these links still work if someone looks at the README directly from the landing page? Because then the link changes to blob/master so the relative link is not correct.
We should make sure these links keep working as I assume that are the ones most used.
There was a problem hiding this comment.
I tested all combinations, and it works in all cases:
- From a branch, clicking in root page rendering of readme towards use cases
- From a branch, clicking from /readme.md towards use cases
- From a branch, clicking from use cases back to field defs in the readme
- From root page of the repo (temporarily merged to master in my fork) to the readme and back
All of these cases worked as expected.
ruflin
approved these changes
Nov 7, 2018
added 3 commits
November 7, 2018 15:11
This prevents leaving forked repo or branch.
webmat
force-pushed
the
relative-links
branch
from
06cba18
to
3951e5b
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This is important for Beta1, as people visiting elastic/ecs will soon be directed
to past versions (e.g.
v1.0.0-beta1), if they're looking for official ECSreleases.
This fix ensures that navigating the links from the Readme to the use cases and
the links from use cases back to the readme keeps the person in the same branch
or tag. Prior to this, they would get sent back to the latest version of ECS.
In this PR:
They now link to the "current" stack version.
This addresses one element of #167.