Docs: Add section about using links in documentation #13422
Merged
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
gziolo
requested review from
mkaz,
oandregal,
dd32,
ajitbohra,
chrisvanpatten and
aduth
aduth
approved these changes
Jan 22, 2019
|
Definitely needed 👍 There is a Contributors handbook being updated in PR #13352) which I include a new section for Documentation contributions. I think that might be a better spot than adding to CONTRIBUTING.md |
|
@mkaz How about landing this in CONTRIBUTING.md for now, and rebasing/updating #13352 to move it into the contributor handbook? I agree it's better in the handbook to align with our goals for simplifying CONTRIBUTING.md and making it more actionable, but it's valuable enough to get it in ASAP so we can iterate more on #13352. |
mkaz
approved these changes
Jan 22, 2019
This was referenced Feb 4, 2019
youknowriad
pushed a commit
that referenced
this pull request
Mar 6, 2019
youknowriad
pushed a commit
that referenced
this pull request
Mar 6, 2019
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
This PR adds the section about using links in the documentation. It seems to be confusing and produces a lot of inconsistency. This is my try to make it more clear. I'm sure that we can improve the wording by the general idea is to have a place to share when reviewing docs.