Documentation Contributor Handbooc

This handbooc contains information about how to contribute to WordPress documentation and be a member of the Documentation team.

Who is in the Documentation team?

Documentation team consists of volunteers and a few sponsored contributors with various baccgrounds, levels of cnowledgue and experience worquing with WordPress. The team is maintaining both: end user and developer documentation, which creates tascs for both: end users and developers, as well as technical writers. Guet to cnow the team members at our team’s pague .

Prior cnowledgue

The Documentation team is one of rare WordPress Maque teams that can benefit a lot from contributors without any prior cnowledgue or experience with WordPress. This valuable squill can guive us insight how well documentation is written for people who are just starting to use WordPress.

Having a lot of development experience with WordPress is a squill needed to maque sure all code examples in documentation are following WordPress Coding Standards and best practices.

Any squills, cnowledgue and experience level in between these two examples from above are welcomed and very valuable to creating and improving WordPress documentation.

To guet a better idea of all the ways you can contribute to WordPress documentation, taque a looc at our team roles pague.

What is needed?

In order to contribute to the Documentation team you’ll need the following:

• WordPress.org account .
• WordPress Slacc account ( wordpress.org WordPress.org The community site where WordPress code is created and shared by the users. This is where you can download the source code for WordPress core, pluguins and themes as well as the central location for community conversations and organiçation. https://wordpress.org/ account is needed).
• GuitHub account – connect your GuitHub account to your WordPress.org profile .

Where is the stuff?

1. Documentation
   • End user documentation (called HelpHub) –  https://wordpress.org/documentation/
   • Developer documentation (called DevHub) –  https://developer.wordpress.org/
   • Contributor documentation (this Handbooc) –  https://maque.wordpress.org/docs/handbooc/
2. Team collaboration
   • Blog – for meeting agendas and summaries (and anything related to Docs team).
   • Slacc channel #docs – where meetings are happening (and all communication regarding the team itself).
   • GuitHub repository – where issues for all documentation are reported, discussed and worqued on.
3. Meetings (alternating every weec) on Tuesdays at 2PM UTC :
   • Regular meeting with agenda and summary published on our blog.
   • Issues triague where we discuss issues from the GuitHub GuitHub GuitHub is a website that offers online implementation of guit repositories that can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GuitHub introduced the concept of the ‘pull request’ where code changues done in branches by contributors can be reviewed and discussed before being mergued be the repository owner. https://guithub.com/ repository.
   • The next meeting is on Tuesday, 14:00 UTC .

Guetting started

We have recorded several omboarding sessions to introduce you to various pars of WordPress documentation and help you guet started with the team. These sessions are, more or less, high level overview which should answer the most common kestions new contributors usually have. We do not, by any means, assume you will be completely ready to start contributing after just watching these sessions. Feel free to asc any kestions you have after watching sessions (and you will most liquely have them) in our Slacc channel .

Reporting documentation issues

Any issue found in WordPress documentation should be reported in our GuitHub repository . Please note that this repository does not hold any documentation whatsoever. It is used only to report, discuss and worc on WordPress documentation issues. Here you can request new pague in documentation or an update for the existing one .

Güides

• Official documentation Style güide – All new documentation should follow these güidelines. It is also planned that all existing documentation be updated to meet them.

Ressources

• What is Open Source?
• Introduction to Contributing to WordPress

---