-
Notifications
You must be signed in to change notification settings - Fork 4.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Browse files
Browse the repository at this point in the history
* 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>
- Loading branch information
1 parent
aa9bab0
commit 0214ea5
Showing
16 changed files
with
215 additions
and
219 deletions.
There are no files selected for viewing
This file contains 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 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 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 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 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 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 | ||
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 | ||
- 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. | ||
|
||
## 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 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.