Repository navigation
Update and Organize Contributors Guide per #12916 #13352
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
Merged
Merged
Changes from all commits
Commits
Show all changes
19 commits
Select commit
Hold shift + click to select a range
8bd9295
Organize and reorder Contributors Guide per #12916
mkaz 3d583cd
Remove individual outreach pages, combined into single outreach.md
mkaz 6e2262b
Principles link, sections heading
mkaz 1547a0b
Fix link
mkaz 1ce66df
Fix link, typo
mkaz e0ef76a
Update docs/contributors/readme.md
Soean cd05aed
Remove meetups, there are far too many to list, since most meetups no…
mkaz 9c4d34c
Update CONTRIBUTING with links to Documentation section
mkaz 215246f
Update CONTRIBUTING.md
chrisvanpatten 17ee00c
Update CONTRIBUTING.md
chrisvanpatten 95d183f
Update CONTRIBUTING.md
chrisvanpatten 92c3c23
Update docs/contributors/outreach.md
chrisvanpatten 258344e
Update docs/contributors/outreach.md
chrisvanpatten b593f9b
Update docs/contributors/document.md
chrisvanpatten 58971fa
Update docs/contributors/document.md
chrisvanpatten e435858
Add some newlines, take some away
mkaz f220a8c
Paragraph for resources
mkaz 08d118b
Update title in generator
mkaz 27f9cec
Update docs/contributors/develop.md
mcsf File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| # Developer Contributions | ||
|
|
||
| Please see [CONTRIBUTING.md](https://github.com/WordPress/gutenberg/blob/master/CONTRIBUTING.md) for technical details on how to setup and make contributions to the Gutenberg repository. | ||
|
|
||
| The following resources offer additional information for developers who wish to contribute to Gutenberg: | ||
|
|
||
| * [Coding Guidelines](/docs/contributors/coding-guidelines.md) outline additional patterns and conventions used in the Gutenberg project. | ||
| * [Gutenberg Block Grammar](/docs/contributors/grammar.md) | ||
| * [Testing Overview](/docs/contributors/testing-overview.md) for PHP and JavaScript development in Gutenberg. | ||
| * [Scripts](/docs/contributors/scripts.md) a list of vendor and internal scripts available to plugin developers. | ||
| * [Gutenberg Release Process](/docs/contributors/release.md) a checklist for the different type of releases for Gutenberg project. | ||
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| # Documentation Contributions | ||
|
|
||
| Documentation for Gutenberg is maintained in the `/docs/` directory in the same Gutenberg Github repository. The docs are published every 15 minutes to the [Gutenberg Handbook site](https://wordpress.org/gutenberg/handbook/). | ||
|
|
||
| ## New Document | ||
|
|
||
| To add a new documentation page: | ||
|
|
||
| 1. Create a Markdown file in the [docs](https://github.com/WordPress/gutenberg/tree/master/docs) folder | ||
| 2. Add item to the [toc.json](https://github.com/WordPress/gutenberg/blob/master/docs/toc.json) hierarchy | ||
|
chrisvanpatten marked this conversation as resolved.
Resolved
|
||
| 3. Update manifest.json by running `npm run docs:build` | ||
| 4. Commit manifest.json with other files updated | ||
|
|
||
| ## Using Links | ||
|
|
||
| It's very likely that at some point you will want to link to other documentation pages. It's worth emphasizing that all documents can be browsed in different contexts: | ||
|
|
||
| - Gutenberg Handbook | ||
|
mkaz marked this conversation as resolved.
Resolved
|
||
| - GitHub website | ||
| - npm website | ||
|
|
||
| To create links that work in all contexts, you should use absolute path links without the `https://github.com/WordPress/gutenberg` prefix. You can reference files using the following patterns: | ||
|
|
||
| - `/docs/*.md` | ||
| - `/packages/*/README.md` | ||
| - `/packages/components/src/**/README.md` | ||
|
|
||
| This way they will be properly handled in all three aforementioned contexts. | ||
|
mkaz marked this conversation as resolved.
Resolved
|
||
|
|
||
| ## Resources | ||
|
|
||
| * [Copy Guidelines](/docs/contributors/copy-guide.md) for writing instructions, documentations, or other contributions to Gutenberg project. | ||
|
|
||
| * [Tone and Voice Guide](https://make.wordpress.org/docs/handbook/documentation-team-handbook/tone-and-voice-guide/) from WordPress Documentation. | ||
This file contains hidden or 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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.