New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Add section about using links in documentation #13422

Merged
merged 1 commit into from Jan 22, 2019

Conversation

@gziolo
Copy link
Member

gziolo commented Jan 22, 2019

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.

@gziolo gziolo self-assigned this Jan 22, 2019

@gziolo gziolo requested review from mkaz , nosolosw , dd32 , ajitbohra , chrisvanpatten and aduth Jan 22, 2019

@gziolo gziolo added this to the Documentation & Handbook milestone Jan 22, 2019

@ajitbohra
Copy link
Member

ajitbohra left a comment

Much needed 💯

LGTM 👍

@aduth

aduth approved these changes Jan 22, 2019

@mkaz

This comment has been minimized.

Copy link
Member

mkaz commented 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

@chrisvanpatten

This comment has been minimized.

Copy link
Member

chrisvanpatten commented Jan 22, 2019

@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

mkaz approved these changes Jan 22, 2019

Copy link
Member

mkaz left a comment

Will push this out and then move to Documentatino section in Contributors handbook

@mkaz mkaz merged commit 0628573 into master Jan 22, 2019

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

@mkaz mkaz deleted the update/docs-links-contributing branch Jan 22, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment