Welcome to the official home of the WordPress documentation team.
This team is responsible for coordinating all documentation initiatives around WordPress, including the Codex (moving to HelpHub and DevHub), handbooks, parts of developer.wordpress.orgWordPress.orgThe community site where WordPress code is created and shared by the users. This is where you can download the source code for WordPress core, plugins and themes as well as the central location for community conversations and organization. https://wordpress.org/, admin help, inline docs, and other general wordsmithing across the WordPress project.
Want to get involved?
There are many ways in which you can help the Docs team. Every small contribution counts and helps! You can report an issue or typo you found in the docs, or even help us write new documentation for parts that are still missing. These are some helpful links to find out more about what we do and how to collaborate:
Block Editor Handbook: An overview of documentation contributions of BlockBlockBlock is the abstract term used to describe units of markup that, composed together, form the content or layout of a webpage using the WordPress editor. The idea combines concepts of what in the past may have achieved with shortcodes, custom HTML, and embed discovery into a single consistent API and user experience. Editor / GutenbergGutenbergThe Gutenberg project is the new Editor Interface for WordPress. The editor improves the process and experience of creating new content, making writing rich content much simpler. It uses ‘blocks’ to add richness rather than shortcodes, custom HTML etc. https://wordpress.org/gutenberg/
Documentation Issue Tracker on GitHub: Submit any DevHub/HelpHub/”Doc Team Handbook” Docs-related issue 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.
Over the last four months, I have been working on the infrastructure, processes, a page inventory, updates on existing pages and new pages for the BlockBlockBlock is the abstract term used to describe units of markup that, composed together, form the content or layout of a webpage using the WordPress editor. The idea combines concepts of what in the past may have achieved with shortcodes, custom HTML, and embed discovery into a single consistent API and user experience. editor.
There are gaps in the existing documentation with missing pages and existing pages that need to be updated as 80% of them haven’t seen an update since WordPress 5.0 came out. With constant UIUIUI is an acronym for User Interface - the layout of the page the user interacts with. Think ‘how are they doing that’ and less about what they are doing. changes on for every version, we need more contributors.
It’s time we expand the number of contributors!
The upcoming virtual Contributor DayContributor DayContributor Days are standalone days, frequently held before or after WordCamps but they can also happen at any time. They are events where people get together to work on various areas of https://make.wordpress.org/ There are many teams that people can participate in, each with a different focus. https://2017.us.wordcamp.org/contributor-day/https://make.wordpress.org/support/handbook/getting-started/getting-started-at-a-contributor-day/. at WordCampWordCampWordCamps are casual, locally-organized conferences covering everything related to WordPress. They're one of the places where the WordPress community comes together to teach one another what they’ve learned throughout the year and share the joy. Learn more. Europe is a great occasion to bring new contributors on board. Here are some instructions and thoughts for new contributors on how to get started. Your feedback is wanted and you can share your ideas, as well as your questions in the comments below.
Hello, New contributors!
Thank you for volunteering to work on Block Editor End Documentation! My name is Birgit Pauli-Haack. My SlackSlackSlack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. username is @bph. PingPingThe act of sending a very small amount of data to an end point. Ping is used in computer science to illicit a response from a target server to test it’s connection. Ping is also a term used by Slack users to @ someone or send them a direct message (DM). Users might say something along the lines of “Ping me when the meeting starts.” me on Slack if you have questions or ideas, either publically in the #docs channel or via private message and I will respond quickly, yet asynchronously.
To illustrate our documentation screenshots are essentials. You would need to know how to create screenshots with your own operating system and how to convert them into image to be uploaded to your text.
To shoot basic screenshots, you would need a self-hosted install of WordPress with the latest WordPress release (as of now 5.4.1). Many plugins add additional screen properties to the editor or your WP Admin that will confuse user, when they compare your screenshot with their own. If you can’t install WordPress on your computer, most hosting companies allow you to create sites with a temporary URLURLA specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org without increasing your hosting costs. Contact me, if you need assistance with this.
What about Creating Videos?
Videos are not our primary tool to help end users with the block editor. We try to explain everything in writing and with screenshots. However, sometimes it helps to just show how a certain screen option behaves in sequence to augment the written explanation. You see a few very short videos embedded into pages. It’s an enhancement and might not come into play in the first version of your documentation article. Also, the tools are not easily available and require additional skill sets.
Please select the one block you want to work on next, and enter your information into the respective columns.
Enter your name,
Your email address and
Your Slack user name
It’s not necessary to add a date into the deadline column, although it helps to know approximately when you might find time to finish it. Don’t worry, we won’t hold your feet to the fire. Those dates are approximations, and for me, there are also a way to know when to check in with you and if everything is on track or if there are any blockers.
Are we done with the preliminaries? Let’s get documenting!
When you are done with your first draft, let us know on Slack, and we’ll review it together.
Again, thank you for volunteering to work on the Block Editor End user documentation. We are thrilled to have you onboard!
If you are testing on a self-hosted site, and you can activate the GutenbergGutenbergThe Gutenberg project is the new Editor Interface for WordPress. The editor improves the process and experience of creating new content, making writing rich content much simpler. It uses ‘blocks’ to add richness rather than shortcodes, custom HTML etc. https://wordpress.org/gutenberg/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, please add also the Gutenberg 8.1 screenshots for the embed block on the bottom of the Google Doc. With the new WordPress version coming in August we will need to update your pages again to include the new UI. Add the screenshots will give us a head start on those changes.
Disclaimer: This is the first version of these onboarding instructions and you are the first contributors working this way.
Added a paragraph regarding Gutenberg plugin screenshot to prepare for the WordPress 5.5 changes to come in August 2020.