Docs: Update links to reference HEAD instead of a specific branch #28331
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
sarayourfriend
added
[Type] Developer Documentation
sarayourfriend
requested review from
adamziel,
ajitbohra,
atimmer,
cameronvoell,
chrisvanpatten,
draganescu,
ellatrix,
guarani,
karmatosed,
kevin940726,
mapk,
mkaz,
nerrad,
noahtallen,
noisysocks,
ntwb,
talldan and
tellthemachines
as code owners
sarayourfriend
force-pushed
the
refactor/update-GH-links-to-reference-HEAD-instead-of-master
branch
from
b1e0c0d to
f7e85c9
Compare
|
Size Change: 0 B Total Size: 1.28 MB ℹ️ View Unchanged
|
noahtallen
approved these changes
Jan 19, 2021
|
Inside the |
gziolo
approved these changes
Jan 19, 2021
gziolo
approved these changes
Jan 19, 2021
|
Thanks @gziolo and @noahtallen |
sarayourfriend
deleted the
refactor/update-GH-links-to-reference-HEAD-instead-of-master
branch
Merged
6 tasks
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.
Description
Updates documentation GitHub links to reference
HEADas an alias for the main branch of a repository rather than referencing the main branch itself. This allows the main branch of the referenced repository to change without having to update the links to reference the new name of the main branch. For example, when the Gutenberg repository changes it's main branch totrunkwe won't have to update these links.This also fixes to stylelint documentation links that were stale (the links were 404s, now they're fixed).
All links to the Gutenberg repository don't need to be tested. If one works, they all work.
I've tested all the links to other repositories manually and they worked. It'd be good if someone could give those a once over.
The goal of this PR is only to update documentation, not any other places where we may be referencing a specific branch (for example CI). Those updates are out of scope and should happen in a separate PR.
How has this been tested?
Links have been tested. Documentation still builds and links are functional.
Types of changes
Non-breaking changes to documentation.
Checklist: