Documentation Issue Tracker on GitHub: Submit any Documentation Team-related issues on GitHubGitHubGitHub is a website that offers online implementation of git repositories that can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. https://github.com/
Join our discussions of documentation issues here on the blog and on Slack.
The handbooks are individual guides that teach people to work on specific aspects of WordPress.
There are two kinds of handbooks that the Docs team works on:
contributor handbooks that help people to get involved with the project
developer handbooks to teach developers how to work with and extend WordPress
Currently, the Docs team is focused on completing the Theme Developer Handbook , PluginPluginA plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the WordPress.org Plugin Directory https://wordpress.org/plugins/ or can be cost-based plugin from a third-party Developer Handbook and REST APIREST APIThe REST API is an acronym for the RESTful Application Program Interface (API) that uses HTTP requests to GET, PUT, POST and DELETE data. It is how the front end of an application (think “phone app” or “website”) can communicate with the data store (think “database” or “file system”) https://developer.wordpress.org/rest-api/. handbook.
In addition, most, if not all contributor handbooks are currently under the management of the individual teams themselves.
Each handbook has a spreadsheet associated with it so we can track the progress of it. Anyone can update the spreadsheet and assign a new percentage to a page. In general, we use the following percentages across spreadsheets:
0% – Nothing created yet
10% – Outline of the page is created.
25% – Rough draft of the part of the page.
50% – About half of the relevant content created and an outline exists for remaining content.
80% – Page is nearing completion but needs some expansion or explanations. In some cases, this may mean screenshots are needed.
95% – Final copy edit needed; final copy editor will look for fixes to the voice and style of the text.
100% – Final copy edit is complete; page is finished!
Percentages in between these are guesstimates of how far the page is to reaching the next level. If you edit a page to improve things even slightly prior to 100%, you may update the percentage even 1% higher to indicate a change has been made.
Also on the spreadsheets are columns for “what’s next” and the “current lead.” The current lead should be actively working on what’s next for the page. If they aren’t, and you intend to, you may takeover the current lead title and work on the page.
If you have questions, you ask for help in SlackSlackSlack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. (#docs). Feel free to message @sam, @kenshino and @blobaugh on Slack if you need help getting started.
You can also join the official weekly chat on Thursdays at 21:00 UTC in the #docs channel in Slack.