Block Editor End User Documentation needs help

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 BlockBlock Block 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 UIUI UI 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 Day Contributor 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 WordCampWordCamp WordCamps 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 SlackSlack Slack 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. PingPing The 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.

Office Hours for WCEU Contributor Day is on Thursday, May 28, 2020, 15:00 UTC – on Slack in the #docs channel.

Required skill sets:

What tools do we use?

We use Google Drive and Slack to coordinate our work. 

Screenshot Capabilities

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.

Basic knowledge of Google Docs

  • How to copy a document
  • How to add images
  • How to format text
  • Sharing options for your document

Bare-bones WordPress Website

To shoot basic screenshots, you would need a self-hosted install of WordPress with the latest WordPress releaseRelease A 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 URLURL A 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!

We prepared a Google Doc Sample for Embed blocks with instructions.

  • Please copy the document to your Google Drive.
  • 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 GutenbergGutenberg The 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/ pluginPlugin A 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.
  • Created 2020-05-18

Agenda for Docs Team Meeting 16 March 2020

Our next Documentation Team meeting is scheduled on: Monday, March 16, 2020, 15:00 UTC in the #docs channel on SlackSlack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/..

  1. Attendance
  2. Notetaker & Facilitator selection
  3. Project Updates
  4. Handbook Revamp (outdated items)
  5. Outliers in Codex (non-theme or pluginPlugin A 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)
  6. Policy for External Linking (continued discussion)
  7. Licensing (continued discussion)
  8. Categorization Project, Alterations Workflow (discussion)
  9. Open Floor

Summary for Docs Team Meeting: March 2, 2020

Attendance

  • Milana Cap
  • Jon Ang
  • Yui ゆい
  • Denis Žoljom
  • Prashant Baldha
  • Chris Van Patten
  • theMikeD
  • Jb Audras
  • Akira Tachibana
  • Estela Rueda
  • Birgit Pauli-Haack
  • Jono Alderson
  • John Blackbourn

Actionable Points

  • 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 coreCore Core 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.

Next Meeting

Monday, March 9, 2020, 15:00 UTC on SlackSlack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. #docs

Documentation Licenses

Jon has spoken with Shiobhan McKeown and Sam Sidler who’ve informed him that the Codex is licensed under GPLGPL GPL 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 GutenbergGutenberg The 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 API The 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-CLI WP-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 P2P2 P2 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 migrationMigration Moving 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.

Findings in the reclassification of WordPress.org documentation

One of the goals for the redesign of the documentation in WordPress.orgWordPress.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, 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:

  1. Some articles need a more descriptive title
  2. There are still articles that do not have updated information
  3. Articles should be placed in one categoryCategory The '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
  4. 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
  5. 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

We are looking for volunteers that would like to help us with the classification and or would like to add a working session during contributor dayContributor Day Contributor 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 WordCamps.

Summary for Docs Team Meeting: February 17, 2020

Attendance

@kenshino, @wpza, @sasiddiqui, @atachibana, @milana_cap, @felipeloureirosantos, @bph, @leogermani, @estelaris, @nobnob, @sukafia, @tomf, @marcio-zebedeu

Facilitator: @kenshino
Note taker: @valentinbora

Actionable points

  • @everyone to review and give feedback on the Handbook refresh efforts here
  • @leogermani to spearhead Handbook refresh efforts, @milana_cap to help with feedback
  • @leogermani to open a ticket on TracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. regarding #meta statistics and invite @kenshino to draw attention from the appropriate stakeholders
  • @tomf to audit content for outdated or irrelevant WordPress.comWordPress.com An 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/ links and compile a list
  • @estelaris to write up notes from the WCVienna working session on classifying docs and post them on this site

Next meeting

Monday, February 24, 2020, 15:00 UTC on SlackSlack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. #docs (follow here)

Handbook refresh

For the detailed document, see @leogermani‘s New Handbook pages on Google Docs.

@leogermani gave an update on the Handbook refresh effort and found out that the “Welcome box” is really outdated with confusing links, so he started a proposal to change that as well as give the Handbook a new home page with a short overview and links to more detailed pages

@leogermani also raised the issue about our internal codenames such as DevHub and HelpHub which can be confusing for end-users, so instead he decided in favor of using developer.wordpress.org and wordpress.org/support, respectively

@kenshino agreed we should stop using codenames in public information and address them by their URLURL A specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org only or both codename + url.

@milana_cap mentioned that we might still want to explain our codenames on specific detail pages in order to help users find the appropriate Components on the Meta Trac when they wanted to raise issues

WordPress.orgWordPress.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, plugins and themes as well as the central location for community conversations and organization. https://wordpress.org/ vs. WordPress.com

@sukafia raised the WordPress.org vs. WordPress.com issue again (reminder: people confuse the two when looking for help, documentation)

@tomf added that they had the same issue during content migrationMigration Moving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. where they noticed some content linking to WordPress.com docs when it shouldn’t have (we’re only concerned with WordPress.org here)

@kenshino asked whether we had a list of content that contains outdated or irrelevant WordPress.com links and @tomf answered that we didn’t. As such, @tomf agreed to lead the effort to audit content and compile a list

Open Floor

@leogermani was tasked with reaching out to #meta for statistics but didn’t receive anything back yet and doesn’t know who to specifically reach out to. @kenshino suggested to have a ticket open on Trac to help make it happen

@estelaris organized an interactive session at WCVienna this past weekend and together reviewed a series of articles and classified them with proper categories and subcategories

For context, there is an ongoing effort to reorganize WordPress.org documentation. For details, see Working File – HelpHub Article Categories

@estelaris mentioned that some articles didn’t have proper titles, other articles were (very) outdated and finally some articles were redundant in that they only linked to other pages

@estelaris agreed to @kenshino‘s invitation to write up some notes from the working session and post them on this site

@kenshino observed the efforts of @estelaris (Categorization) and @tomf (Content Audit) to be complementary and recommended they worked together

@kenshino mentioned that @coffee2code updated everyone with the appropriate Team and Contributor badges. Also, there’s a list of people that shouldn’t be holding a Team badge anymore due to inactivity

Transcript

https://wordpress.slack.com/archives/C02RP4WU5/p1581951613217400

#docs, #meetings, #summary

Summary for Docs Team Meeting: February 10, 2020

Attendance

@leogermani, @valentinbora, @felipeloureirosantos, @milana_cap, @marcio-zebedeu, @tomf, @chrisvanpatten, @atachibana, @rahmohn, @estelaris, @nullbyte, @bph, @kulsumsiddique, @ibdz, @kartiks16, @passionate, @audrasjb, @themiked, @kenshino, @mkaz, @sukafia

Facilitator: @leogermani
Note taker: @valentinbora

Actionable points

  • @everyone to review and give feedback on the user survey by Feb 12th, 2020.
  • @valentinbora to post DevHub migrationMigration Moving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. cross-check code to GitHubGitHub GitHub is a website that offers online implementation of git repositories that can 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/ [update: done]
  • @milana_cap to update workflow for facilitating a meeting by including a step to review prior meeting notes
  • @milana_cap @kenshino to confirm usage of CrowdSignal or another service for hosting the survey
  • @atachibana to coordinate survey review before it goes live
  • @leogermani to review and update the Handbook and welcome box to attract new contributors
  • @leogermani to reach out to the #meta team to ask for stats to help highlight how important, popular and relevant docs are, as well as stats to support the survey (most viewed pages, devices used, referrals, searches etc.)

Next meeting

Monday, February 17, 2020, 15:00 UTC on SlackSlack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. #docs (follow here)

Codex to DevHub migration

For context, please see the Codex to DevHub migration sheet.

@leogermani asked @atachibana about updated metrics regarding migration to DevHub

@valentinbora updated the team about a quick tool he’s written to cross-check migration status for Functions as he found quite a few pages out of sync in the Sheet vs. their actual live status. Before automated corrections there were 480/1069 Functions done (44.9%), after corrections we’ve won some and lost some, tallying to 374/1069 (35%)

@milana_cap (zzap) requested access to the code and @valentinbora promised to push it to GitHub. [update: done]

HelpHub (User Docs) Survey

Please check the survey and give feedback

everyone’s opinion matters

@leogermani reminded everyone that the purpose of the survey is to learn: “How complete is our documentation and how can we improve our user docs?”

@themiked considered the survey to be asking some questions that could be inferred by statistics instead

@mkaz asked whether the survey was to be taken from a user’s or a developer’s standpoint. @leogermani clarified that it’s both

@themiked mentioned that the question “How complete is our documentation” is a difficult one to answer for end-users but we could still give it a try

@leogermani encouraged feedback for the survey to go to the p2 post linked above in order to have it all in one place but would like to hear from @bph in terms of the roadmap for the survey, with WordCamp Asia in mind.

Comments for the survey should be added by February 12th in order to prepare the survey well enough in advance before WordCampWordCamp WordCamps 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. Asia happening on February 21st, 2020.

@mkaz considers open ended questions to be difficult for end-users to answer and is wondering whether end-users get their answers from official documentation or elsewhere

@bph, @leogermani, @milana_cap discussed where to publish the survey, be it CrowdSignal or Pollbuddy vs. Google Forms. @kenshino should have something to say about that

@kenshino @milana_cap agreed to first focus on gathering the right questions to survey for before February 12th

@felipeloureirosantos suggested the open-source LimeSurvey as a tool

@milana_cap offered to review CrowdSignal as a tool for the survey per @kenshino‘s request

Docs presence at WordCamp Asia

@milana_cap and @atachibana will lead the Docs table at WordCamp Asia 2020

@leogermani would like to attract more people to contribute to Docs and wants to review the Welcome box on the handbook page and bring documentation up to date to make it easier for newcomers.

@atachibana mentioned @estelaris‘ suggestion to reorganize the documentation tree with categories and subcategories.

@valentinbora suggested reviewing barriers to entry alongside motivational efforts for new contributors

Docs contributor and team badges

@milana_cap shared her work in progress document for criteria on obtaining docs badges.

@kenshino suggested to simplify the docs badge tracking Sheet to just two tabs. Any project leads can add contributors and they’ll be awarded a badge without question. 

Open Floor

@valentinbora posted some tickets regarding DevHub and Explanation post types to help with Codex to DevHub migration (see more)

@leogermani @milana_cap mentioned @netweb was working on making it easier for setting up a local HelpHub environment for new code contributors to join in

@sukafia would like to know how to suggest edits to the HelpHub (user documentation) and @milana_cap suggested to ask in the #docs channel directly on Slack

@felipeloureirosantos posted an update regarding Brazilian Portuguese (pt_BR) docs. They have 5 new translated pages, 1 page in progress and a new contributor over the past week

@leogermani and @valentinbora conferred about the migration process, specifically that there’s little room for automation regarding redirection, but the redirect itself could be taken care of by an automated script once marked Ready for redirect

Transcript

https://wordpress.slack.com/archives/C02RP4WU5/p1581346828033500

Summary for HelpHub Meeting 26 August 2019

Attendance

@estelaris @kafleg @FahimMurshed @wizzard_ @softservenet @ibdz @felipeloureirosantos @justin @bph @kenshino @felipeelia @milana_cap @samikeijonen

Development

We discussed several issues today.

Excerpts on Archives

Last year it was proposed to replace auto generated excerpts with ToC list items. On today’s meeting discussion it’s been decided to use manually created excerpts which would contain the point of the article in one sentence. Short and concise. more meaning, less space.

Join discussion here: https://github.com/WordPress/HelpHub/issues/239

Posts Order on Archives

This was unsolved for a long time. We decided it’s important to order posts according to its content complexity so it resembles “Step 1, Step 2..” format or, if this doesn’t apply, to order according to post’s “importance”. As this is difficult to apply automatically to all categories we decided to use Post Attributes order and intentionally create order which we will specify in WP_Query.

As some articles have more than one categoryCategory The 'category' taxonomy lets you group posts / content together that share a common bond. Categories are pre-defined and broad ranging. assigned, in which it might have different “importance” and order, we decided to make larger steps between posts using the same logic as menu items in dashboard. So two posts in a succession would have 10 places in between, rather than 1. This should also help with ordering articles published in the future.

Join discussion here: https://github.com/WordPress/HelpHub/issues/237

Single article mobile view

Viewing single article on smaller devices reveals the sidebarSidebar A sidebar in WordPress is referred to a widget-ready area used by WordPress themes to display information that is not a part of the main content. It is not always a vertical column on the side. It can be a horizontal rectangle below or above the content area, footer, header, or any where in the theme. throughout the whole visible area. The rest of Handbooks solve this by hiding the sidebar altogether. @milana_cap suggested to place search form and single posts navigation instead of sidebar. For this single posts navigation to be useful, the order of posts (above) should be logical and intuitive.

@estelaris said that she’s working on templates and will discuss this issue on #design team meeting this Wednesday, as this is effecting all WordPress.orgWordPress.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, plugins and themes as well as the central location for community conversations and organization. https://wordpress.org/ Handbooks.

Join discussion here: https://github.com/WordPress/HelpHub/issues/236

Design

@estelaris is working on overview of HelpHub design. Her analysis can be found in Google Spreadsheet: https://docs.google.com/spreadsheets/d/1ZnhtiLxqjXviFlnWsDE5L8YRiBXtkmanvM8doIc1lrg/edit?usp=sharing

After we agree on design template we need to have #accessibility review and usability test. @samikeijonen kindly accepted to perform these testings once we have everything ready.

Content and Rosetta Releases

We skipped these due to absence of key people.


Next Docs meeting is in #docs channel on

Monday, September 02, 2019, 15:00 UTC

You can take a look at the meeting transcript via this link: https://wordpress.slack.com/archives/C02RP4WU5/p1566831612366600

Summary for Docs Team Meeting 12 August 2019

Attendance

@kenshino @milana_cap @atachibana @clorith @David Curtiss @bph @leogermani @juliobox @softservenet @audrasjb @chrisvanpatten @clorith

Development

We are waiting for @netweb to finish setting up SVNSVN Apache Subversion (often abbreviated SVN, after its command name svn) is a software versioning and revision control system. Software developers use Subversion to maintain current and historical versions of files such as source code, web pages, and documentation. Its goal is to be a mostly compatible successor to the widely used Concurrent Versions System (CVS). WordPress core and the wordpress.org released code are all centrally managed through SVN. https://subversion.apache.org/. and GITGit Git is a free and open source distributed version control system designed to handle everything from small to very large projects with speed and efficiency. Git is easy to learn and has a tiny footprint with lightning fast performance. Most modern plugin and theme development is being done with this version control system. https://git-scm.com/. repos together. Meanwhile @milana_cap started working on https://github.com/WordPress/HelpHub/issues/214 Once the new workflow is completed regular bug scrubs will be scheduled again.

Mobile view of HelpHub is identified as making HelpHub hard to use so we are going to prioritize those fixes if we don’t get the git + svn work done by this week.

Content

There are no requests for new pieces that we need to write. @atachibana volunteered to follow the state of BlockBlock Block 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 user’s docs as it is still hard to be found by people. @bph volunteered to help. They will reach out to @karmatosed regarding improvements.

We would like to have some input from Support Team on obvious gaps for Block Editor Docs. @clorith will bring this up on their next meeting.

@leogermani did half of remaining redirects and updated the spreadheet, expecting to finish everything by the end of the week. @audrasjb volunteered to help, @juliobox is already on it.

Design

Skipped due to missing reps.

Rosetta Releases

Japaneese releaseRelease A 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. gathered 11 volunteers. Serbian rosetta still doesn’t have HelpHub enabled. @kenshino will pingPing The 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.” @sergey about this.

Open Floor

We currently have 288 user notes (DevHub comments) in queue. @audrasjb volunteered to help with reviews. @softservenet will start a spreadsheet of Docs Team’s ongoing tasks and members working on them. 

Next Docs meeting is in #docs channel on

Monday, August 19, 2019, 15:00 UTC

You can take a look at the meeting transcript via this link: https://wordpress.slack.com/archives/C02RP4WU5/p1565622003178300

#docs

Summary for Docs Team Meeting 1 April 2019

Attendance

@milana_cap @nosolosw @joyously @chrisvanpatten @kafleg @makewebbetter @aduth @jankimoradiya @immeet94 @kenshino attended

HelpHub Development

We’re currently trying to move issues form GitHubGitHub GitHub is a website that offers online implementation of git repositories that can 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/ to MetaMeta Meta 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. TracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. to give proper visibility over bugs that affect the code base that was merged into WordPress.orgWordPress.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, plugins and themes as well as the central location for community conversations and organization. https://wordpress.org/

The team is working on checking if the issues are reproducible on WordPress.org and will migrate related issues.

@milana_cap has updated the list of developers that contributed code to HelpHub. We’re working out which badge to give (Meta or Doc) and will finalise this soon

@milana_cap and @clorith are working on a monthly bug scrub date/time

HelpHub Design

It’s been raised that the forum and HelpHub landing pages are too similar. A discussion will be needed with @iviolini and @clorith to work this through

GutenbergGutenberg The 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/ Handbook

@nosolosw mentioned that the Gutenberg docs have improved quite a bit thanks to the efforts of many people, and the main issue now is discoverability

It was recommended by both @Kenshino and @chrisvanpatten to get the contents of the current Gutenberg developer documentation into a DevHub handbook as a main focus and work out both the technical roadmap and the content re-ordering at a later stage.

@nosolosw will be conferring with the Gutenberg team over the next few days.

Google Season of Docs

In short – there’s 3 months that a technical writer (or more) that can sign up to write docs for WordPress.org

We could decide where the focus should be. It could be working on improving Gutenberg Docs or making sure we look at the other handbooks to review the level of technical writing that we’re at

@chanthaboune is looking into how we’d apply as WordPress.org and mentors are needed for this effort. If you’re interested, take a look at https://developers.google.com/season-of-docs/docs/mentor-guide and let us know you’re interested either via DM on Slack, a message in #docs or a comment on this P2P2 P2 or O2 is the term people use to refer to the Make WordPress blog. It can be found at https://make.wordpress.org/. post!

Documentation Team Badges

After a bit of discussion, we’ve landed at a criteria

  • Documentation Contributor: You have contributed over X number of changes across HelpHub or DevHub.
  • Documentation Team: You regularly attend Documentation Team meetings and you are either a project lead or a team lead of a project.

Contributor badges are likely to be permanent and Team badges denote current activity over a period of 2 months.

We’ll likely have to work on the criteria a little more and will make a separate P2 post to solicit feedback before confirming it.

Maintenance of Theme Developer Handbook

The Docs Team would like to bring in the Theme Review Team to take ownership of the Theme Review Handbook (just as Plugins has done so for the plugins handbook).

@kafleg has been requested to form a team and work with @atachibana to bring the theme handbook up to speed.

You can read a transcript of the meeting via https://wordpress.slack.com/archives/C02RP4WU5/p1554130866012100

Agenda for Docs Team Meeting 18 March 2019

Our next Documentation Team meeting is scheduled on

Monday, March 18, 2019, 15:00 UTC

in the #docs channel on SlackSlack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/.

Current Projects Updates:

  1. Content MigrationMigration Moving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. from Codex to HelpHub & DevHub – @atachibana
  2. HelpHub development – @milana_cap
  3. Inline Docs – @drewapicture and @atimmer
  4. GutenbergGutenberg The 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/ Handbook – @dryanpress @chrisvanpatten and @nosolosw

    Now we have “Block Editor” icon on the DevHub main page: https://developer.wordpress.org/
    But, the plan of moving contents is not clear from previous discussion. Can anyone explain it in the meeting or on #docs?

Open Floor

Feel free to comment if you have items to add to the agenda.