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:
@atachibana made an update about the re-routing of Codex to Code Reference. 1054 of 1070 Function pages have already been completed. Also, @stevenlinx and @collinsmbaka are working on complexed cases with opened tickets. After it is released, WordPress 5.5 will merge the fixes on documents into the Code Reference.
@tacitonic mentionned that There is no update for the BEEDocs team for this week. This will be discussed in another meeting next monday.
@estelaris shared the progress on the categorization project and if is it chosen or not for Season of Docs. She proposed to include asif2bd’s pillar content proposals as part of the categorization proposal. The reason for that is the content can be included as part as categorization. Also, the marketing team is still giving some feedback on the related p2 post. This could help in having some guidelines in the naming for pillars and categories.
@themiked shared the current Plugins Handbook status. The pages organization proposed can be found here. He also expressed the interest to have a glossary that automatically finds and links terms that should be defined in the handbook.
External Linking Policy
@milana_cap mentionned that the team has now a new approach, that can be found in this document. Everyone is welcomed to add comments and feedbacks. This will be discussed again during the next meeting.
Milana is also requesting a correction in the latest Month of WordPress post as the docs team has not banned the use of commercial links in the documentation articles. This is a discussion that is still happening.
New Member Mentoring
@sukafia shared the new members in Docs team stats. For the month of July, 37 new members joined the #docs channel on Slack. These members were reached out to by the mentorship team. Only one member has already joined the channel for the month of August.
@sukafia linked to some nice pics from the last monthly coffee break. You can find them here and here. Many members also mentionned how useful this coffee break was; allowing to learn about people with which we are contributing.
The next Monthly Coffee Break will take place at the end of August, hopefully in Asia friendly time. The team is also open to rotating the time to make it favourable to people in different time zone to attend.
Google Season of Docs 2020
@timohaver said that all the Season of Docs proposals were scored by the mentors last week. The top three proposals have been submitted to Google.
Open Floor
@joyously asked if all the references to Codex URLs have already changed to the new format. She is wondering about links external to the Codex that point to it, because there were a bunch in code and are not elsewhere on 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/.
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 End-User Documentation (BEEDocs):
@collinsmbaka: Published issuu, crowdsignal, and reverbnation blocks & reviewed the TrelloTrelloProject management system using the concepts of boards and cards to organize tasks in a sane way. This is what the make.wordpress.com/marketing team uses for example: https://trello.com/b/8UGHVBu8/wp-marketing. board.
@tacitonic: Arranged the task list spreadsheet priority-wise, got in touch with the contributors who have claimed blocks but are not worked upon.
@bph: Started looking at WordPress.comWordPress.comAn online implementation of WordPress code that lets you immediately access a new WordPress environment to publish your content. WordPress.com is a private company owned by Automattic that hosts the largest multisite in the world. This is arguably the best place to start blogging if you have never touched WordPress before. https://wordpress.com/ documentation to see what can be ‘harvested’, reviewed contributors documents, in the works and already published, with @atachibana worked on Block Directory documentation, started on a third worksheet in our spreadsheet with WordPress 5.5 and more task listing: BlockPattern, Image Editing, Block Directory.
@milana_cap reported that she didn’t manage to do anything new on this agenda. But she’ll be sharing Google docs soon with this so we all can comment and join the discussion. She also mentioned that the team is trying to change the strategy because it’s impossible to label websites as “commercial” and “personal” only. So they’ll focus on the license, which has to be compatible with GPLGPLGPL is an acronym for GNU Public License. It is the standard license WordPress uses for Open Source licensing https://wordpress.org/about/license/. The GPL is a ‘copyleft’ license https://www.gnu.org/licenses/copyleft.en.html. This means that derivative work can only be distributed under the same license terms. This is in distinction to permissive free software licenses, of which the BSD license and the MIT License are widely used examples. 2+.
The July Coffee Break is set for this Thursday (July 30) at 1500 UTC.
Google Season of Docs 2020
@kenshino reported that they’re still evaluating proposals. The deadline for evaluating the proposals is 28th July.
Open Floor
@bph mentioned that the next Block Editor Enduser documentation team meeting will be on August 10.
@themiked mentioned that he’s concerned about the way of doing the ‘keep the content promotion free’ part. He also mentioned that defining content and promotion is going to be a challenge and he’s looking forward to seeing the first draft.
Please feel welcome to suggest revisionsRevisionsThe WordPress revisions system stores a record of each saved draft or published update. The revision system allows you to see what changes were made in each revision by dragging a slider (or using the Next/Previous buttons). The display indicates what has changed in each revision. in the comments.
*this is a cumulative doc/proposal from the Docs Onboard Team
Purpose
To create an area away from the high traffic active postings in the main channel that new and existing Contributors can go for assistance and support. Members can also ask a quick question in the new channel. This would declutter the existing #docs channel from error reports and questions, while distinguishing it exclusively for docs related discussions.
At this point, we’ve been direct messaging people and working with them one on one to get started, but this would allow us to have a hub to do so, while information supplied to others could also be of benefit as reference.
Presently, we’ve noticed (especially in the case of new contributors), they tend to get overwhelmed and also intimidated by asking for information in the channel. We’re also duplicating quite a bit of human effort in the case where we have potential solutions to make this process more efficient.
@atachibana reported that for the migrationMigrationMoving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. and re-routing of Codex to Code Reference for Functions, 1033 of 1070 (96.5% <- 95.5%) pages have been completed. He thanked @stevenlinx for the contribution with open tickets. He also mentioned that we have to wait until version 5.5 releaseReleaseA release is the distribution of the final version of an application. A software release may be either public or private and generally constitutes the initial or new generation of a new or upgraded application. A release is preceded by the distribution of alpha and then beta versions of the software. and enhancement of document fixes to Code Reference for 100%.
@makewebbetter offered to volunteer for working on migrating hooksHooksIn WordPress theme and development, hooks are functions that can be applied to an action or a Filter in WordPress. Actions are functions performed when a certain event occurs in WordPress. Filters allow you to modify certain functions. Arguments used to hook both filters and actions look the same..
@bph updated on the Bee-Docs (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 End-user):
@tacitonic has been reviewing posts with new contributors.
We are looking at WordPress.comWordPress.comAn online implementation of WordPress code that lets you immediately access a new WordPress environment to publish your content. WordPress.com is a private company owned by Automattic that hosts the largest multisite in the world. This is arguably the best place to start blogging if you have never touched WordPress before. https://wordpress.com/ to fill gaps in 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/ documentation
The TrelloTrelloProject management system using the concepts of boards and cards to organize tasks in a sane way. This is what the make.wordpress.com/marketing team uses for example: https://trello.com/b/8UGHVBu8/wp-marketing. board finds more usage now that we have more team members on board.
@collinsmbaka will connect with the coreCoreCore is the set of software required to run WordPress. The Core Development Team builds WordPress.-editors regarding plans for Hulu and Photobucket embeds blocks, if they are abandoned or if we should file issues for them.
WordPress 5.5 is coming fast now. 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 versions 8.5 and lower will come to core. Including the import button for external images. So we can keep drafting and collaborating on Google Docs and copy/paste for publishing. The button appears on each image block, and just needs click to get the image into the media library of wordpress.org
Also shared the betaBetaA pre-release of software that is given out to a large group of users to trial under real conditions. Beta versions have gone through alpha testing in-house and are generally fairly close in look, feel and function to the final product; however, design changes often occur as part of the process.-tester plugin with the team in case they want to do some peek preview. We’ll keep and eye out for the denotes, too.
good news/bad news: We ran out of tasks for new contributors:
Homework for next week for all: thinking about new tasks for new contributors early wins.
The Bee-Docs team meets each Monday at 14:00 UTC in the #meta-helphub channel over Slack.
@Prubhtej_9 reported that he completed the Scribd block editor documentation earlier that week & thanked @tacitonic for reviewing the doc.
@christiano.zanca reported that @glorialchemica started testing italian helphub translation. The Italian Team is providing support to this ticket to onboard more contributors.
Categorization Project
@estelaris reminded that we can still leave comments on the p2 post and this agenda item will be on hold until the finalization of Technical Writers for this project on the Season of Docs.
@bph suggested that we might need to review how block editor end user documentation is presented. It’s kind of buried, and probably needs a separate entrance and TOC.
External Linking Policy
We’ve witnessed vivid discussion on this agenda item.
Anyone with a WordPress.org username can propose the link (as equivalent to anyone with a WordPress.org account can edit Codex). We could have a Google form or airtable or something similar. They need to fill out following fields (all mandatory):
External link
Placement link at wp.org (where this external link should be added to)
Short description (why this link is a good fit)
WordPress.org username
Consent (“I read the external linking policy rules…” checkbox)
If the proposed domain name appears to not follow the rules 3 times, the domain name gets on the “banned” list.
Review Process:
To make the review process less confusing, we can prepare the set of questions to which all answers have to be “yes” in order to allow a link.
3 members of docs team completes a review (to avoid bias)
The review results are published on #docs team blog
domain name gets 5 links approved get the “trusted” status and we add them to the public list of trusted resources
If one allowed external link gets changed after being approved in a way that is against the rules, all links from that domain get removed, domain name loses its “trusted” status (with possibility to land on “banned” list perhaps?)
The Rules: (Brainstorming Ideas)
The content (article/tutorial) must not include any plugin, theme, service (hosting and similar) that is not bundled with WordPress clean install (which can be downloaded at WordPress.org)
The content, in its entirety or parts, must not be behind the payment or any sort of compensation from the reader (like, share etc)
The page where the content is can not contain visible ads for paid products and services (link in menu is OK but banners are not)
@kenshino suggested When people submit links, one of 2 things can happen
The link is added directly
The content is copied because it’s really good and they get attributed
The discussion centered from trusted links to commercial blogs, tutorials, promoting products, banners, attribution and even GPLGPLGPL is an acronym for GNU Public License. It is the standard license WordPress uses for Open Source licensing https://wordpress.org/about/license/. The GPL is a ‘copyleft’ license https://www.gnu.org/licenses/copyleft.en.html. This means that derivative work can only be distributed under the same license terms. This is in distinction to permissive free software licenses, of which the BSD license and the MIT License are widely used examples. licensing.
We request input from everyone. There are many aspects to policy making. Please join the conversation on the respective p2 post on commercial blogs and trusted sources.
New Member Mentor Training
@Prubhtej_9 reported that for the month of July 22 new members had joined & 13 new members had joined #docs in the past week.
Due to the unavailability of @sukafia & @tomf the discussion on #docs-help channel was postponed to next week.
Monthly coffee break
@chaion07 reported that he’s still in the process of writing a p2 post, which he had volunteered for. @sukafia is assisting with the p2 post.
Google Season of Docs
@Kenshino(jon) suggested that the ‘Documentation Team’ badge be given to the selected Technical Writers and Mentors for Google Season of Docs. He also mentioned that @ChloéBringmann along with the Mentors are finalizing the selection of the Technical Writers which needs to be reviewed by Google as well.
Open Floor
@tacitonic reported that @Lucila Stancatohad contacted him regarding the following matter:https://wordpress.slack.com/archives/C02RP4WU5/p1594123868113500
@chaion07 offered to make a specific Meeting Summary and Meeting Agenda Document Template in Google Docs so that anyone as a New Contributor can find a direct guideline to assist with the Note taking process & requested to write a p2 post for the same.
@kenshino(jon) also reported that he had shut down the wp-helphub.com server.
@atachibana informed on the MigrationMigrationMoving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. of Codex that 1022 out of 1070 pages had been completed. Currently the project is 95.5% completed which is a 0.70% improvement from last week. He also thanked @stevenlinx for processing complex cases with Open Tickets.
@christiano.zanca informed that the Italian team started translation of HelpHub. Currently Google Docs is being used as the base for checking and then publishing it.
@mkaz is continuing to work on theBlockBlockBlock 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. Tutorial. Currently working on the developer’s environment portion through PR 23953 and more.
@tacitonic currently reviewing The Bee-Docs tasks as @collibnsmbaka and @khushbu.desai are publishing the final drafts on embed blocks. The Bee-Docs Meetings are held every Mondays at 14:00 UTC in #meta-helphub under the supervision of @bph as always.
@Prubhtej_9 is contributing to the Scribd block editor documentation including a few of the handbooks this week & had a small discussion with the 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/. team regarding their inputs for improving the Rest API handbook.
Categorization Project
@estlaris reminds everyone that we are looking forward to comments on the p2 post that she wrote earlier. @milana_cap is looking into the comment left by @annezazu previously that focuses on the Github issue.
You can join the conversation by visiting the p2 post related to this topic. We are expecting input from everyone.
New Member Mentoring Team
@softservenet reported that the New Member Mentor Training Team met recently to discuss support capabilities for new members.
@sukafia reported that the Mentoring Team is actively reaching out and checking up on new members. The team is ensuring that every member gets a Welcome Message and is provided with links to helpful resources and guidance relevant to #docs. 7 new members have joined since last week, raising the numbers for this month to 75. The Team is considering to write a p2 post on the proposal for a dedicated channel on Making WordPress Slack so that this can be discussed with the #meta team.
@chaion07 is writing a p2 post covering the monthly summary piece (with the assistance of @sukafia). The new Doodle for the coffee break will be shared in the channel soon. Since it’s not Asian and some timezone friendly, we’ll have to be rotating the time. We will try to rotate the timing in such a manner to suit as many geo-location as possible to gain maximum audience.
Today @atachibana@milana_cap and I got on a call and went through the list of people that had Doc Team Badges.
We removed 16 in-active people and added gave 2 people the team badge. We’re now at 20
I have also give @milana_cap and @atachibana the ability to manage both the Docs Team and Contributor badges.
If you’ve lost the badge and feel like that was in error, please feel free to 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 in #docs
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 releaseReleaseA release is the distribution of the final version of an application. A software release may be either public or private and generally constitutes the initial or new generation of a new or upgraded application. A release is preceded by the distribution of alpha and then beta versions of the software. (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.
First tasks for new contributors
The most immediate tasks is creating new pages for each Embed block of the Block editor. Here is the list in a spreadsheet.
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
Deadline (optional)
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.
“If it weren’t for the last minute, nothing would get done.”
Rita Mae Brown
Are we done with the preliminaries? Let’s get documenting!
Share the link to Your Google Doc in the spreadsheet.
Start working on your first page!
As you can see it’s a bit of a set-up, but once you are through the preliminaries (Slack account, Google Account, clean install, Google Doc) you are up and running.
Three Examples: Twitter, Facebook, YouTube
We have three embed blocks already on site, their example might help you decide how deep you can go into your explanations.
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.
Changelog
Updated 2020-05-20
Added a paragraph regarding Gutenberg plugin screenshot to prepare for the WordPress 5.5 changes to come in August 2020.
Outliers in Codex (non-theme or 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)
Policy for External Linking (continued discussion)
Jon to await Matt’s response to his questions about licensing of content on w.org.
JB to ask about proposing changes to recommendations in the next coreCoreCore is the set of software required to run WordPress. The Core Development Team builds WordPress. meeting (not docs specific).
Jon to investigate cross-posting the announcement of the start of the meeting in #core.
Estela to propose further discussion of the docs reclassification for next week’s meeting.
Jon has spoken with Shiobhan McKeown and Sam Sidler who’ve informed him that the Codex is licensed under GPLGPLGPL is an acronym for GNU Public License. It is the standard license WordPress uses for Open Source licensing https://wordpress.org/about/license/. The GPL is a ‘copyleft’ license https://www.gnu.org/licenses/copyleft.en.html. This means that derivative work can only be distributed under the same license terms. This is in distinction to permissive free software licenses, of which the BSD license and the MIT License are widely used examples. v2. Much of the content on HelpHub originated from the Codex, therefore relicensing the content would likely involve getting explicit permission from every author involved for every line of documentation.
Jon is waiting for Matt Mullenweg to confirm about the existing licensing of the Codex, there is currently no license declaration on the Codex.
It was pointed out that many handbook pages were written from scratch, but there’s a good chance that they contain derivative content from the Codex anyway. This means they may need to remain GPL licensed.
Chris van Patten pointed out that 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/’s documentation is part of the Gutenberg repo and therefore falls under its same GPL license.
The 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/. documentation is currently unlicensed.
WP-CLIWP-CLIWP-CLI is the Command Line Interface for WordPress, used to do administrative and development tasks in a programmatic way. The project page is http://wp-cli.org/https://make.wordpress.org/cli/ documentation is MIT licensed.
Jon will follow up with further discussion on this topic in a post on the Docs P2P2P2 or O2 is the term people use to refer to the Make WordPress blog. It can be found at https://make.wordpress.org/.
Policy for External Linking
Jon pointed out that various docs on w.org link to external resources that might not be correct and might not have been audited. Akira confirmed that dead links and some links with heavy advertising were removed during the migrationMigrationMoving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. to HelpHub.
Jon posed whether such links should be audited, removed, or left, what kind of links should get in or not, and what kind of links are appropriate, and what to do about links whose content changes over time.
A few people expressed interest in discouraging external linking at all, but there was no consensus. Further discussion needed.
Jono mentioned that the general policy of the forums is that linking out is bad, because links break, and because the motivations and value of external resources can’t be trusted, but noted that this can mean users miss out from accessing otherwise valuable external resources.
Open Floor
JB asked what is the best way to propose changes to the “abbreviation best practices” section of the Core Handbook. He’s going to mention it during the next core chat as this isn’t specific to the docs team.
Estela mentioned that she’s unsure about how to proceed with the documentation reclassification. Jon suggested bringing this up for further discussion next week, Estela agreed.
John (myself) pointed out that the starting of the #docs meeting doesn’t get automatically cross-posted into the #core channel like other meetings do. Jon will investigate.
Estela Rueda
8:25 am on February 21, 2020 Tags: docs
One of the goals for the redesign of the documentation in 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/ is to create a better search. The best way to do it is by reclassifying all the articles and creating categories with subcategories.
In discussions with the #docs team, we agreed that the best option to do this was by working with a group of people that included developers, documentation, designers and content specialists.
Our goals for the working session were:
Classify documentation articles in categories and provide subcategories if possible
Utilize the already existent categories and perhaps add one or two. The reasoning is that we already have many users that are familiar with it.
Think of the final user: new user to advanced user, not necessarily advanced developers
A working session during Contributors Days at WordCamp Vienna with about 15 contributors gave us some ideas. The results show the following recommendations:
Some articles need a more descriptive title
There are still articles that do not have updated information
Articles should be placed in one categoryCategoryThe 'category' taxonomy lets you group posts / content together that share a common bond. Categories are pre-defined and broad ranging./subcategory, even if the information could be related to other categories
There are unnecessary articles that must be removed. An example of this is the article WordPress Lessons that only offers links to other articles. Once the reclassification is done, there won’t be a need for this type of articles
Revisiting 170+ articles is going to take a lot of time. Some participants from WC Vienna agreed on continuing reading the articles but we will need more people
