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.

Sign up for GitHub

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

Jump to bottom

Docs: Improve Contributors Guide Structure #12916

Closed
mkaz opened this issue Dec 15, 2018 · 0 comments
Closed

Docs: Improve Contributors Guide Structure #12916

mkaz opened this issue Dec 15, 2018 · 0 comments
Assignees
@mkaz
Labels
[Type] Developer Documentation Documentation for developers
Milestone
Documentation & H...

Comments

@mkaz
Copy link
Member

mkaz commented Dec 15, 2018

The Contributors Guide in the Handbook could be organized a bit better, there are also two sources of contributors information which are loosely cross-linked. The following outline was proposed in: #10911

  1. Contributor Handbook
    1. Introduction
    2. Philosophy
    3. Design
      1. Design Resources
      2. Link to HIG
    4. Develop
      1. Coding guidelines
      2. Testing
      3. Release Process
      4. Deprecations
      5. Links to components/package references
    5. General
      1. History
      2. Glossary
      3. FAQs
      4. Repository management guidelines

This ticket is to confirm that is the outline we still want, secondly how to incorporate the information from CONTRIBUTING.md. I'm not sure how much of CONTRIBUTING.md should be maintained there vs. moving it to within the handbook, open to suggestions.

Current Contributors Guide: https://wordpress.org/gutenberg/handbook/contributors/

Current CONTRIBUTING.md: https://github.com/WordPress/gutenberg/blob/master/CONTRIBUTING.md
@mkaz mkaz added the [Type] Developer Documentation Documentation for developers label Dec 15, 2018
@youknowriad youknowriad added this to the Documentation & Handbook milestone Jan 9, 2019
mkaz added a commit that referenced this issue Jan 16, 2019
@mkaz
Organize and reorder Contributors Guide per #12916
ee5c0de
@mkaz mkaz mentioned this issue Jan 17, 2019
Merged
@mkaz mkaz self-assigned this Jan 17, 2019
mkaz added a commit that referenced this issue Jan 22, 2019
@mkaz
Organize and reorder Contributors Guide per #12916
8bd9295
mkaz added a commit that referenced this issue Jan 23, 2019
@mkaz
Update and Organize Contributors Guide per #12916 (#13352)
50ab754 
* 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>
daniloercoli added a commit that referenced this issue Jan 24, 2019
@daniloercoli
Merge branch 'master' of https://github.com/WordPress/gutenberg into …
b5e679b 
…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 issue Mar 6, 2019
@mkaz @youknowriad
Update and Organize Contributors Guide per #12916 (#13352)
0214ea5 
* 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 issue Mar 6, 2019
@mkaz @youknowriad
Update and Organize Contributors Guide per #12916 (#13352)
85d941a 
* 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
Assignees

@mkaz mkaz

Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Milestone
Documentation & Handbook
Development

No branches or pull requests
2 participants
@mkaz @youknowriad