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.

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
Merged

Conversation

gziolo
Copy link
Member

@gziolo 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 the [Type] Developer Documentation Documentation for developers label Jan 22, 2019
@gziolo gziolo added this to the Documentation & Handbook milestone Jan 22, 2019
@gziolo gziolo self-assigned this 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).
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Member

@ajitbohra ajitbohra left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

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

@mkaz
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.

@gziolo gziolo merged commit 695860f into master Jan 22, 2019
@gziolo gziolo deleted the update/docs-packages branch January 22, 2019 15:01
youknowriad pushed a commit that referenced this pull request Mar 6, 2019
* Docs: Move packages section out of CONTRIBUTING.md

* Update precommit hook to look at new toc.json file
youknowriad pushed a commit that referenced this pull request Mar 6, 2019
* Docs: Move packages section out of CONTRIBUTING.md

* Update precommit hook to look at new toc.json file
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Type] Developer Documentation Documentation for developers
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants