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

Docs: Move packages section out of CONTRIBUTING.md #13418

Merged
merged 2 commits into from Jan 22, 2019

Conversation

@gziolo
Copy link
Member

gziolo commented Jan 22, 2019

Description

CONTRIBUTING.md has become quite big. This PR extracts the part about managing packages to its own file to make the guidelines more focused on the onboarding experience.

I also update internal links to follow the same patterns we started to apply recently.

@gziolo gziolo added this to the Documentation & Handbook milestone Jan 22, 2019

@gziolo gziolo self-assigned this Jan 22, 2019

@gziolo gziolo requested review from mkaz , nosolosw , ajitbohra and chrisvanpatten Jan 22, 2019

@@ -244,15 +124,15 @@ If you'd like to contribute to the design or front-end, feel free to contribute

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'll have to create a Markdown file in the [docs](https://github.com/WordPress/gutenberg/tree/master/docs) folder and add an item to the [root-manifest.json](https://github.com/WordPress/gutenberg/blob/master/docs/root-manifest.json).
To add a new documentation page, you'll have to create a Markdown file in the [docs](https://github.com/WordPress/gutenberg/tree/master/docs) folder and add an item to the [toc.json](/docs/toc.json).

This comment has been minimized.

@gziolo

gziolo Jan 22, 2019

Author Member

Is it toc.json now? It has changed and I tried to figure out based on the tool which generated the manifest file.

This comment has been minimized.

@ajitbohra

This comment has been minimized.

@mkaz

mkaz Jan 22, 2019

Member

You are right it is toc.json, the manifest is now generated.

@ajitbohra
Copy link
Member

ajitbohra left a comment

LGTM 👍

This split will make it easy for people to refer the contribution docs
❤️

@mkaz

This comment has been minimized.

Copy link
Member

mkaz commented Jan 22, 2019

This looks good, I have a PR that changes up the contributors handbook here: #13352 but I only modified this document a little.

Go ahead and land this one and I can rebase and update.

@mkaz

mkaz approved these changes Jan 22, 2019

@gziolo gziolo merged commit 695860f into master Jan 22, 2019

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details

@gziolo gziolo deleted the update/docs-packages branch Jan 22, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment