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 team did a second revision of the first recommended site map because we still found articles that should be moved to the developers documentation. The reason is that we want to keep the end-user documentation as clean as possible of developer jargon and make sure it only provides advice on how to use WordPress not how to alter it with code.
The main goal of article reclassification is to improve search and allow new articles to be added into the existing categories without creating a ‘miscellaneous’ categoryCategoryThe 'category' taxonomy lets you group posts / content together that share a common bond. Categories are pre-defined and broad ranging..
The first site map included 4 main categories and subcategories under each. The new recommendation maintains the 4 main categories, some subcategories have been renamed to better work in the future.
The categories for end-user documentation were created to improve search, making it easier for the user to find the information. A secondary goal is to allow a continued learning path.
WordPress Overview is the first category with 3 subcategories:
Where to start
The intention of these subcategories is to provide a starting point for the new user and a quick access to resources to more seasoned users in the form of FAQs. About WordPress provides background information on how to become a contributor, WordPress’ history, etc.
Technical guides is the second category which includes 3 subcategories:
Although the technical guides include topics that could be seen as developer-focused, there is some basic information that the end-user needs to learn about installing WordPress and working with their hosting companies, as well as maintaining a healthy and secured site.
Support guides is the third category, also includes 3 subcategories:
These guides are all about the software, getting to know the moving parts of the front end, how to manage and publish content and media. The guides include articles for Classic Editor as well as 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.
This is the fourth category and as the titles says, it is all about giving the site or blog the look and feel that the user wants. The number of subcategories increased to 9 and this will help with categorization as the FSE features and new blocks are developed.
WidgetWidgetA WordPress Widget is a small block that performs a specific function. You can add these widgets in sidebars also known as widget-ready areas on your web page. WordPress widgets were originally created to provide a simple and easy-to-use way of giving design and structure control of the WordPress theme to the user. blocks
Content review Video shortcodeShortcodeA shortcode is a placeholder used within a WordPress post, page, or widget to insert a form or function generated by a plugin in a specific location on your site.
The #docs team will collaborate with other teams to find the best way to make all the changes. So far, the hosting team is collaborating in moving articles to DevHub.
Create new categories and subcategories
Change title names to articles and create 301s for older URLs (with the metaMetaMeta is a term that refers to the inside workings of a group. For us, this is the team that works on internal WordPress sites like WordCamp Central and Make WordPress. team’s direction)
Merge pages and create 301’s
Delete pages and redirect to similar content pages/articles.
Other articles written as part of the redesign of HelpHub
If you are interested in making any content review on any of the tickets above, reach out to @estelaris on SlackSlackSlack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. or leave a comment in the GH ticket.