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

Update and Organize Contributors Guide per #12916 #13352

Merged
merged 19 commits into from
Jan 23, 2019

Conversation

mkaz
Copy link
Member

@mkaz mkaz commented Jan 17, 2019

Description

Organize the Contributors Guide per outline defined in #12916
Fixes #12916

Most of the information is from existing documents and organized in to Design, Develop, and Document sections for Contributors. Each of these sections can probably be refined within the section. However the main goal of this PR is to get the documents into a better organized structure with some updates. The goal is not to update every document within the guide and make sure they are up-to-date.

The biggest change was within the Outreach section which included multiple sections for links to external articles, talks, and discussions about Gutenberg. This was combined into a single page.

How has this been tested?

You can view the docs online here

Types of changes

Documentation, primary reorder and structure.

@chrisvanpatten
Copy link
Contributor

Hoping to review this today!

docs/contributors/readme.md Outdated Show resolved Hide resolved
@mkaz mkaz force-pushed the docs/12916/contributors-guide branch from 02a3419 to 3a13676 Compare January 22, 2019 17:15
@mkaz mkaz force-pushed the docs/12916/contributors-guide branch from d772199 to 9c4d34c Compare January 22, 2019 17:57
Copy link
Contributor

@chrisvanpatten chrisvanpatten left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall a wonderful improvement; thanks @mkaz 🥇

Just some general notes but on the whole this is a really much-needed streamlining. Thanks for working on this!

CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
docs/contributors/develop.md Show resolved Hide resolved
docs/contributors/document.md Show resolved Hide resolved
docs/contributors/grammar.md Show resolved Hide resolved
docs/contributors/outreach.md Outdated Show resolved Hide resolved
docs/contributors/outreach.md Outdated Show resolved Hide resolved
docs/contributors/outreach.md Outdated Show resolved Hide resolved
docs/contributors/outreach.md Outdated Show resolved Hide resolved
chrisvanpatten and others added 8 commits January 23, 2019 06:12
Co-Authored-By: mkaz <marcus@mkaz.com>
Co-Authored-By: mkaz <marcus@mkaz.com>
Co-Authored-By: mkaz <marcus@mkaz.com>
Co-Authored-By: mkaz <marcus@mkaz.com>
Co-Authored-By: mkaz <marcus@mkaz.com>
Co-Authored-By: mkaz <marcus@mkaz.com>
Co-Authored-By: mkaz <marcus@mkaz.com>
docs/contributors/develop.md Outdated Show resolved Hide resolved
mkaz and others added 2 commits January 23, 2019 09:06
Copy link
Contributor

@chrisvanpatten chrisvanpatten left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm happy with this! I think it's worth landing and iterating further in separate PRs if necessary.

@mkaz mkaz merged commit 50ab754 into master Jan 23, 2019
@mkaz mkaz deleted the docs/12916/contributors-guide branch January 23, 2019 17:34
daniloercoli added a commit that referenced this pull request Jan 24, 2019
…rnmobile/372-add-title-to-gutenberg-mobile

* 'master' of https://github.com/WordPress/gutenberg: (56 commits)
  Save package-lock.json file changes (#13481)
  Plugin: Deprecate gutenberg_add_responsive_body_class (#13461)
  Add speak messages to the feature toggle component. (#13385)
  Plugin: Deprecate gutenberg_kses_allowedtags (#13460)
  Plugin: Deprecate gutenberg_bulk_post_updated_messages (#13472)
  Plugin: Avoid calling deprecated gutenberg_silence_rest_errors (#13446)
  Plugin: Deprecate gutenberg_remove_wpcom_markdown_support (#13473)
  Fix: Categories block: add custom classes only to wrapper (#13439)
  is-shallow-equal: Use ES5 ruleset from eslint-plugin module (#13428)
  Update and Organize Contributors Guide per #12916 (#13352)
  Dismissible-notices: fix text overlapping icon (X) (#13371)
  Framework: Remove 5.0-merged REST API integrations (#13408)
  Plugin: Remove 5.0-merged block registration functions, integrations (#13412)
  Framework: Bump minimum required WP to 5.x (#13370)
  [Mobile] Improve keyboard hide button (#13415)
  Improve castError handling of non strings (#13315)
  Fix: File block add custom class (#13432)
  Consider making Fullscreen Mode effects visible only on larger screens (#13425)
  Update plugin version to 4.9.0 (#13436)
  DateTimePicker: fix prop warning for (#12933)
  ...
youknowriad pushed a commit that referenced this pull request Mar 6, 2019
* Organize and reorder Contributors Guide per #12916

* Remove individual outreach pages, combined into single outreach.md

* Principles link, sections heading

* Fix link

* Fix link, typo

* Update docs/contributors/readme.md

Co-Authored-By: mkaz <marcus@mkaz.com>

* Remove meetups, there are far too many to list, since most meetups now all cover Gutenberg in some degree or other

* Update CONTRIBUTING with links to Documentation section

* Update CONTRIBUTING.md

Co-Authored-By: mkaz <marcus@mkaz.com>

* Update CONTRIBUTING.md

Co-Authored-By: mkaz <marcus@mkaz.com>

* Update CONTRIBUTING.md

Co-Authored-By: mkaz <marcus@mkaz.com>

* Update docs/contributors/outreach.md

Co-Authored-By: mkaz <marcus@mkaz.com>

* Update docs/contributors/outreach.md

Co-Authored-By: mkaz <marcus@mkaz.com>

* Update docs/contributors/document.md

Co-Authored-By: mkaz <marcus@mkaz.com>

* Update docs/contributors/document.md

Co-Authored-By: mkaz <marcus@mkaz.com>

* Add some newlines, take some away

* Paragraph for resources

* Update title in generator

* Update docs/contributors/develop.md

Co-Authored-By: mkaz <marcus@mkaz.com>
youknowriad pushed a commit that referenced this pull request Mar 6, 2019
* Organize and reorder Contributors Guide per #12916

* Remove individual outreach pages, combined into single outreach.md

* Principles link, sections heading

* Fix link

* Fix link, typo

* Update docs/contributors/readme.md

Co-Authored-By: mkaz <marcus@mkaz.com>

* Remove meetups, there are far too many to list, since most meetups now all cover Gutenberg in some degree or other

* Update CONTRIBUTING with links to Documentation section

* Update CONTRIBUTING.md

Co-Authored-By: mkaz <marcus@mkaz.com>

* Update CONTRIBUTING.md

Co-Authored-By: mkaz <marcus@mkaz.com>

* Update CONTRIBUTING.md

Co-Authored-By: mkaz <marcus@mkaz.com>

* Update docs/contributors/outreach.md

Co-Authored-By: mkaz <marcus@mkaz.com>

* Update docs/contributors/outreach.md

Co-Authored-By: mkaz <marcus@mkaz.com>

* Update docs/contributors/document.md

Co-Authored-By: mkaz <marcus@mkaz.com>

* Update docs/contributors/document.md

Co-Authored-By: mkaz <marcus@mkaz.com>

* Add some newlines, take some away

* Paragraph for resources

* Update title in generator

* Update docs/contributors/develop.md

Co-Authored-By: mkaz <marcus@mkaz.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants