Skip to content

Commit

Permalink
Update CONTRIBUTING with links to Documentation section
Browse files Browse the repository at this point in the history
  • Loading branch information
mkaz committed Jan 22, 2019
1 parent cd05aed commit 9c4d34c
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 16 deletions.
18 changes: 2 additions & 16 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,23 +124,9 @@ If you'd like to contribute to the design or front-end, feel free to contribute

## Contribute to the Documentation

Documentation is automatically synced from master to the [Gutenberg Documentation Website](https://wordpress.org/gutenberg/handbook/) every 15 minutes.

To add a new documentation page, you create a Markdown file in the [docs](https://github.com/WordPress/gutenberg/tree/master/docs) folder and add an item to the [toc.json](https://github.com/WordPress/gutenberg/blob/master/docs/toc.json) and generate using `npm run docs:build`.

### Using links
Please see the [Documentation section](/docs/contributors/document.md) of the Contributors Handbook.

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

That's why it's recommended to use absolute links without the `https://github.com/WordPress/gutenberg` part for all files which match 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.
Documentation is automatically synced from master to the [Gutenberg Documentation Website](https://wordpress.org/gutenberg/handbook/) every 15 minutes.

### `@wordpress/component`

Expand Down
23 changes: 23 additions & 0 deletions docs/contributors/document.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,29 @@

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. Generate 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

That's why it's recommended to use absolute links without the `https://github.com/WordPress/gutenberg` part for all files which match 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.
Expand Down

0 comments on commit 9c4d34c

Please sign in to comment.