Skip to content
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: Contributor Guide update subpages #19939

Merged
merged 8 commits into from Feb 10, 2020
Merged

Docs: Contributor Guide update subpages #19939

merged 8 commits into from Feb 10, 2020

Conversation

@mkaz
Copy link
Member

mkaz commented Jan 29, 2020

Description

Continues updates to Contributor Guide, see previous work in #19853
These changes update the main sub-pages of the guide, providing consistent info at the top for each section.

  • Main Contributor Guide page minor change for formatting, adding bold to start of bullet list

  • Code Contribution changes rename page to the type of contribution, not the person, this is inline with Design and Documentation. Add Discussion, Development Hub sections. Remove Grammar and Scripts links from resources since not related to Contributing, will surface elsewhere. Remove Localizing since i18n is now linked to from top section and translating is different than contributing code.

  • Design Contrubtion update top section with discussion area.

  • Documentation Contribution update top section with discussion area. Add section for two types of documentation User vs Developer. Add link to Git workflow and additional explanation with an update example.

@bph If you can take a look at the short explanation on how to contribute to Gutenberg User docs, I'm not real happy with what I have now, which basically says ask in Slack. Is there an existing page or link for better info? I think tasks are tracked in Trello or Google Docs, hence the "ask in Slack" which they can get access and links.

How has this been tested?

Documentation. Browse live on branch see links above to each page.

@bph

This comment has been minimized.

Copy link
Contributor

bph commented Jan 29, 2020

@mkaz

User documentation is information on how to use the Editor as an author publishing posts. For contributing to user docs, follow docs blog above to see priorities. Ask in #docs channel for latest list of priorities for user docs.

That's right now the process. It's not ideal, and end users certainly won't go through the trouble of creating a slack account. We are aware of that. We have been working on adding a feedback section on each page. People could leave a note there, we then triage it and add to the to-do-list. The respective meta ticket is here: https://meta.trac.wordpress.org/ticket/4915

That's just for background. Right now I don't have a better way to connect, than Docs Channel. I keep a card in Trello to submit a PR once this feature is in place

@mkaz

This comment has been minimized.

Copy link
Member Author

mkaz commented Jan 29, 2020

Thanks @bph for the response. Not a problem, it takes time to get the processes right, and always iterated upon. As long as we're sending people to the right spot to get answers that's a plus for now.

@mkaz mkaz force-pushed the update/docs-contrib-dev branch from bb928a1 to ff9cf34 Feb 1, 2020
Copy link
Member

chrisvanpatten left a comment

Some small nits on formatting/grammar. Awesome improvements!

docs/contributors/design.md Outdated Show resolved Hide resolved
docs/contributors/design.md Outdated Show resolved Hide resolved
docs/contributors/design.md Outdated Show resolved Hide resolved
docs/contributors/design.md Outdated Show resolved Hide resolved
docs/contributors/develop.md Outdated Show resolved Hide resolved
docs/contributors/document.md Outdated Show resolved Hide resolved
docs/contributors/document.md Outdated Show resolved Hide resolved
docs/contributors/document.md Outdated Show resolved Hide resolved
docs/contributors/document.md Outdated Show resolved Hide resolved
docs/contributors/document.md Outdated Show resolved Hide resolved
Copy link
Member

chrisvanpatten left a comment

Looks great!

mkaz and others added 8 commits Jan 29, 2020
- Add info for make blog and links
- Add links to discussion in slack
- Update links, remove links to docs not relevant to how to contribute
code, to be moved to new Gutenberg Platform section
Wow, thanks for all the fixes!

Co-Authored-By: Chris Van Patten <hello@chrisvanpatten.com>
@mkaz mkaz force-pushed the update/docs-contrib-dev branch from 87b36bd to 2a71fa3 Feb 10, 2020
@mkaz mkaz merged commit 53e55a8 into master Feb 10, 2020
2 checks passed
2 checks passed
pull-request-automation
Details
Travis CI - Pull Request Build Passed
Details
@mkaz mkaz deleted the update/docs-contrib-dev branch Feb 10, 2020
@github-actions github-actions bot added this to the Gutenberg 7.5 milestone Feb 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants
You can’t perform that action at this time.