Summary of Docs Team Biweekly Meeting June 21, 2022

Housekeeping

Open Floor

Docs Onboarding Videos

PHPPHP PHP (recursive acronym for PHP: Hypertext Preprocessor) is a widely-used open source general-purpose scripting language that is especially suited for web development and can be embedded into HTML. http://php.net/manual/en/intro-whatis.php. Documentation Comments

@lucp and @milana_cap:

5.9 Issues for HelpHub

@femkreations:

  • Issues with WordPress version 5.9 for the HelpHub are being worked on.
  • Later, the issues will be merged into the 6.0 project.
  • A lot of images don’t have ALT text and this needs to be emphasized for adding screenshots to HelpHub articles.
  • @milana_cap noted that ALT text is mentioned in the docs team Handbook.
  • A list will be added for this to the GitHub Issue Template for resolving on 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. contributor days.
  • An extra phase in the content review process will be added to address this issue.

@milana_cap will add a link to the list on the Leading a Contribution Day Handbook page.

Props to @ninianepress for writing the notes.

First review on the new Sitemap for HelpHub

Following up on the post Explorations of a new classification for user documentation, we suggested to create 4 pillars (categories) and subcategories. My suggestion is to keep the subcategories to the minimum and add as many articles as needed, this will allow the system to grow as needed.

The 4 pillars in HelpHub

The 4 suggested pillars with their own subcategories are:

  1. WP Overview
    • About WordPress
    • Resources
    • FAQs
  2. Technical guides
    • WordPress installation
    • WordPress multisites
    • Configuration
    • Maintenance
    • Security
    • Troubleshooting
  3. Support guides
    • Get to know the dashboard
    • Publishing
    • Media
  4. Customization
    • Appearance
    • Default themes
    • Classic Editor
    • 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
    • Common Blocks
    • Formatting
    • Layout elements
    • Theme Blocks
    • Widgets
    • Embeds

What has been done

During Google Season of Docs 2020, there was a project to reclassify all the articles, change article titles to follow the new style guide being written at the time and review the content (including links, outdated content, etc).

These are some of title changes given and the team will discuss the next steps to either change the affected URLs or not, but that is for another post.

Due to the rotation of contributors and the team focusing on other issues, the revision of content is still ongoing. If you would like to help out, join a meeting or reach out to @femkreations on 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/, @Femy on Slack and she will guide you.

The new titles and the reclassification has been done. We will continue to include articles that are still to be written, as well as any new article.

The first draft

This is a first draft of the Sitemap and we need your help to make sure articles are in the correct categoryCategory The 'category' taxonomy lets you group posts / content together that share a common bond. Categories are pre-defined and broad ranging. or if there is anything else we need to add. You can leave your comments on this post or in the Draft of the Sitemap linked above.

What is up for review

  • Category names
  • Subcategory names
  • Articles classified in the correct category/subcategory

What is not for review

  • The four pillars (the title yes, but we won’t be adding anymore pillars)
  • Order of articles under categories nor order of subcategories (we will review them at a later time)
  • New name titles for articles (these were given during GSoD and have been already reviewed and accepted/rejected by the #docs team)

Other articles written as part of the redesign of HelpHub

If you would like to contribute or have any questions, reach out to @estelaris on Slack or leave a comment.

Props to @milana_cap for peer review.

#helphub

The hashtag and its future in documentation articles

In a previous post, we listed the requirements for the new design for HelpHub. This article is going to discuss one particular requirement, the hashtag at the end of the headlines inside an article.

Basically, we want to remove the # character from the headlines. It may be a radical change but it is necessary for accessibilityAccessibility Accessibility (commonly shortened to a11y) refers to the design of products, devices, services, or environments for people with disabilities. The concept of accessible design ensures both “direct access” (i.e. unassisted) and “indirect access” meaning compatibility with a person’s assistive technology (for example, computer screen readers). (https://en.wikipedia.org/wiki/Accessibility) reasons.

First of all, let’s mention the requirements to remove or replace the hashtag. The function must be:

  1. Clear on purpose
  2. Easy to read with keyboard
  3. Reduce visual noise
  4. Not polluting the link’s list for screen readers

The hashtag is used at the end of a headline in the articles as seen in the image below. In order to define its future, we need to understand its behavior.

Image of a headline including the hashtag

The hashtag is a link; the anchor is the H2 in the example above. It’s the anchor element, but it’s the link behavior, so it is ambiguous.

Technically, anchor refers to the target of an on-page link. This appears to be a link that gives easy access to identify the URLURL A specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org that will give you access to the current location on the document. That’s…actually kind of complicated.

What about accessibility?

The icon of the character used is not as important as communicating the function of the link. Right now, the # has aria-hidden=true label, so it won’t be read at all.

<h2 id="requirements-on-the-server-side" class="toc-heading" tabindex="-1">Requirements on the server side <a href="#requirements-on-the-server-side" class="anchor"><span aria-hidden="true">#</span><span class="screen-reader-text">Requirements on the server side</span></a></h2>

Link to the code page, line 196

It’s backed by screen reader text that duplicates the heading title, but is also nested inside the heading; this means that the heading text will be read  (e.g.) “Recommended setup Recommended setup”.  It’s creating duplicate text nested inside the heading and does not expose any visible text to explain the purpose.

The options

After some research, I have found several options for replacing and/or removing the hashtag.

  • Adding the link to the heading with a character
  • Making the heading a link
  • Replacing the hashtag with a fly-out menu

Adding the link to the heading, as used by GitHub,  where the link is currently the method to expose the link to that section. It can also be linked from the topics table, at the top of the article. We would have to make sure the implementation is accessible to others besides sighted mouse users.

The link element can be added at the beginning of the headline.
The link element can also be inserted at the end of the headline.

Adding the link to the heading is reasonable and the simplest solution to replace the hashtag, as it will simplify the problem: the functionality will be clear and the visual noise would be reduced considerably.

There are arguments against providing links that point to themselves, however, as it can make a confusing interaction. One of the arguments against this method is that it pollutes the link list on a screen reader. The way the hashtag is presented now, already pollutes the screen reader’s link list.

Replacing the hashtag

Replacing the hashtag with a fly-out menu, as explained by the w3.org. The w3.org recommends using the fly-out menu to meet WCAGWCAG WCAG is an acronym for Web Content Accessibility Guidelines. These guidelines are helping make sure the internet is accessible to all people no matter how they would need to access the internet (screen-reader, keyboard only, etc) https://www.w3.org/TR/WCAG21/.. The fly-out menu removes the need for multiple page loads. The biggest disadvantage is for people with reduced dexterity who can have trouble or it could be almost impossible to operate fly-out menus,which can be prevented with the correct implementation.


Video showing how the fly-out menu operates

The design above would be changed to meet the 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/ design style.

Removing the Symbol

Is removing the symbol entirely an option? Another recommendation from w3.org is placing the interactive elements in an order that follows sequence. This means adding a table of contents which will link to the interactive element, the headline in this case. Basically, the way it is right now but without the hashtag.

Video showing mouse-click to headline and the URL pointing to that headline

References

We would like to hear from you. Do you have another solution that could meet all the requirements?

Props to @ryokuhi, @joedolson, @milana_cap, @jillmugge for peer review.

Update 8 March 2022

We are moving the discussion to a meta ticket to discuss options and accessibility.

#accessibility, #docs, #helphub

Summary of Docs Team Meeting Jan 25, 2022

Attendance

@estelaris, @kafleg, @milana_cap, @atachibana, @femkreations, TC, @kenshino, @themiked

Housekeeping

Project Updates

A full transcript can be found in the #docs channel in the Making WordPress 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/.

HelpHub page titles and urls

In the future, we should be able to be able to change page titles/urls /301s. For more detail refer this discussion and @estelaris‘ two tickets:

Now, we should keep current page titles and urls.

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. EU 2-4 June

@milana_cap will lead the Documentation Team at Contributor Day.

Do contribution and get a cookie!

Summary of Docs Team Meeting Jan 11, 2022

Attendance

@milana_cap, @daisyo, @atachibana, @kafleg, @mburridge, @estelaris, @jdy68, @wizzard_, @utz119, @juanmaguitar, @mitchblue006, @femkreations, @kenshino, @sukafia

Housekeeping

Project Updates

A full transcript can be found in the #docs channel in the Making WordPress 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/.

  • HelpHub content
    • thanks to @annezazu, HelpHub is getting new pages relating to V5.9. Those pages will be translated via #polyglots team.
    • @atachibana highlighted the need for auto-changelog – this is a topic for future discussion.
    • future plans: re-design of HelpHub, adding TOC or index into side bar area – however global design changes are coming.
  • 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 end user docs
    • currently without lead in case anyone wants to volunteer.
    • a large amount of work is still outstanding here, tasks need to be moved from TrelloTrello Project 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. 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/ while filtering out what’s no longer relevant and keeping what is still relevant.
    • @milana_cap will start working on that this week and allocate some time each week until a new lead volunteers to own the project and can then continue the work themselves.
    • @atachibana will also help with this.
    • @jdy68 expressed interest in helping.
  • HelpHub feedback curating
    • currently without lead in case anyone wants to volunteer.
    • comments are coming in but someone is needed to curate them, filterFilter Filters are one of the two types of Hooks https://codex.wordpress.org/Plugin_API/Hooks. They provide a way for functions to modify data of other functions. They are the counterpart to Actions. Unlike Actions, filters are meant to work in an isolated manner, and should never have side effects such as affecting global variables and output. out the spam and support and move the relevant ones to GitHub.
    • @esteleris has been helping out.
    • if anyone wants to be responsible for managing these comments, @milana_cap is willing to explain everything in detail.
  • 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 handbook
    • future plans: needs to be updated with the style guide.
    • it has been “blockified” already but still needs external linking.
    • @themiked plans to create a plugin which will form the basis for a progressive tutorial – this is still in the preliminary stages.
  • Theme handbook
    • in addition, some typos, old links, and other minor things have been updated.
    • @milana_cap asked whether there is any content on converting a classic theme into a block based theme, but @kafleg reports that content on block themes has not been started on yet. There are, however, plans to create a list of topics.
  • Common APIs handbook
    • @milana_cap stated that she has ideas for this one and will create a GitHub issue for it.
  • Reference handbook – curating user contributed notes
    • there are currently 38 pending comments.
    • please 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.” @milana_cap  if help is needed on this.
  • Docs team handbook
    • there’s a requirement to go through this handbook and see what’s missing/outdated/etc…
  • Onboarding 
    • @sukafia acknowledges that this has been on hold for a while. Previous work will be reviewed and next steps decided on.
  • Coffee breaks
    • @sukafia acknowledges that this has been on hold for a while. Previous work will be reviewed and next steps decided on.
  • Design
    • WP.org is getting a full redesign, @estelaris now has access to the style guide and will change the previous design of HelpHub and hopes to present the new redesign at WCEU.

The following projects were not addressed, either because the lead was not present or because we ran out of time.

Would the leads of those project please reply in comments on the agenda, thanks.

Summary for Docs Team Meeting November 9, 2021

Attendance

@milana_cap @mkaz @juanmaguitar @chaion07 @muhammadfaizanhaidar @kafleg @atachibana @mitchblue006

Housekeeping

Find the complete Transcript of the meeting on Slack.

Please note: Next week (16.11.2021) shall be  “Issues Triage Meeting” and thereafter (23.11.2021) “Docs Team Meeting”.

@chaion07 will facilitate this meeting and the agenda will be revision of projects that were put on hold.

Project Updates

5.9 Release (Documentation)

@mkaz is the Docs Lead for WP 5.9 https://github.com/orgs/WordPress/projects/11/. Integration of custom spreadsheets may be used for future releases as default. 

@mkaz made “Doc Type” properties to filterFilter Filters are one of the two types of Hooks https://codex.wordpress.org/Plugin_API/Hooks. They provide a way for functions to modify data of other functions. They are the counterpart to Actions. Unlike Actions, filters are meant to work in an isolated manner, and should never have side effects such as affecting global variables and output. by Dev Note, User Docs, or Dev Docs.

Additional help welcome as @audrasjb  @milana_cap @annezazu are also working on this release.

@milana_cap also mentioned today is feature freeze, and closed tracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. tickets as well as planning in writing docs should be considered.@mkaz is the go to regarding this.

Open Floor

@muhammadfaizanhaidar  is awaiting response with https://github.com/WordPress/Documentation-Issue-Tracker/issues/47, @milana_cap suggested waiting for @estelaris to respond.

@milana_cap mentioned that content from Themes handbook could be combined and updated https://developer.wordpress.org/themes/theme-security/using-nonces/.

#meeting-notes

#docs, #meetings

Summary for Docs Team Meeting October 26, 2021

Attendance

@kenshino @mkaz @mburridge @juanmaguitar @chaion07 @ashiquzzaman @donaldwmoorejr @muhammadfaizanhaidar @kafleg @atachibana @femkreations @sasiddiqui

Housekeeping

Find the complete Transcript of the meeting on Slack.

Open Floor

5.9 Release (Documentation)

@mkaz will be the Docs Lead for WP 5.9 with help from @audrasjb and @zzap on coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. docs, and @annezazu for user docs

@femkreations @mburridge offered to help with these docs

Design refresh for Org sites

@mkaz comments the 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. team is working on a design refresh for Org sites starting with /News, see work-in-progress here: https://wordpress.org/news-test/

They are building them as 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. themes, with the idea of other handbooks would be child themes off them.

Licensing Legal Text

 @chaion07 comments a few weeks back we were discussing on Licensing Legal Text with Josepha to assist us (saw this in the #team-reps channel)

@kenshino says the text is expected to be with the lawyers this week because 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/ docs are also on WordPress.org, it makes things slightly more complicated

The main issue is that general contents are CC0 and code is GP, but Gutenberg is also dual-licensed – 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. + MIT, so this info has been passed to the lawyers for them to sort out

#meeting-notes

#docs, #meetings

[Announcement] New workflow for reporting documentation issues

For a few weeks now Documentation team is testing out new workflow for reporting issues – a GitHub repository which will be a single, centralised place for reporting all documentation issues. How and why we decided to do this can be found in team’s meeting notes.

What we hope to achieve with this workflow:

  • Easier contribution in form of reporting issues – even though this workflow still requires another account from contributor (the 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/ one), with this workflow contributor doesn’t need to know which part of documentation is issue for. They can just report the issue and move on, if they so wish. We lost many one-time contributions due to the complicated workflow for reporting issues.
  • Easier contribution in form of fixing issues – with all projects and their different reporting issues tools, contributor who wanted to join team and work on fixing issues had to decide which project they wanted to work on before even seeing issues. With everything in one place they can browse all the issues, find the ones that seem interesting and then look for advice on fixing it.
  • Some projects didn’t have any way for reporting issues except for coming to #docs 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/. channel and hoping that someone will see it. This way is deprived of a place where the issue would be discussed as many things get lost in Slack noise. Also, this way is almost impossible to keep track of contributors and give them credits for their contributions.
  • Easier managing of projects and documentation in whole – team members have better overview of everything that’s happening in every Docs project, can help out in projects they usually don’t work on and have a general picture of WordPress documentation as a whole.
  • Easier contributions tracking – with every issue, comment, contribution being saved in one place, we have a better understanding of how certain parts of docs were created and who worked on them.
  • Better planning and setting goals with GitHub projects.
  • Better understating and following progress and statistics for each project by structured labeling system.
GitHub issue discussion.
GitHub issue discussion

We are still configuring labels, templates and the repo itself; and still figuring out the best way to work on/with issues. For the future we hope to connect this repository with the actual documentation at 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/ so that contributions can be make directly on the page with the issue which would automatically create new issue and apply proper labels.

In the next phase, which will be soon, we will start using GitHub Projects for managing all the issues.

GitHub Project board for managing all GitHub issues from the repository.
GitHub Projects board

Documentation Team is managing all documentation as an unified project and is adopting appropriate tools in order to do so.

As always, if you have any questions or suggestions, please leave the in comments bellow.

Summary for Docs Team Meeting June 22, 2021

Attendance

@milana_cap, @courane01, @kmhazari, @chaion07, @femKreations, @tacitonic, @atachibana, @mehbubrashid, @ramthas, @kenshino, @mehbubrashid, @caseymilne, @deadpool76, @piermario, @estelaris, @collinsmbaka, @mburridge, @kafleg, @daisyo, @ahmedriyadh, @themiked

Housekeeping

Where: #docs channel on Slack
Find the complete Transcript of the meeting on Slack.

Meeting Facilitator: @milana_cap

Note Taker: @caseymilne

Next Meeting Facilitator: No volunteers found for facilitation of next weeks meeting. Volunteer over #docs 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/. if you can do this.

Project Updates

Proposal Update: An audit tool for Learn

Update provided from @courane01. No deadline set at the moment. Proposal gaining interest from team leaders, Learn/Training team will see a few new contributors from Automattic. Importance of streamlining auditing for teams mentioned, new Instructional Designers that are on-boarding at Learn. 

Discussion about revision management and the importance of tracking changes. Some questions from facilitator @milana_cap about existing tools used in editing workflow. 

Plans to continue collaboration between #docs and #train on this proposal, to set to write up docs needs in two weeks time, and have a video chat to discuss further.

5.8 Release

  • Today we’re entering betaBeta A 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. 3 phase. 
  • By the next Tuesday (when RC1 is starting) we’ll have all dev notes and field guide published
  • After that we start working on DevHub and HelpHub updates

Volunteers: anyone wants to help with DevHub, 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.” @milana_cap over Slack #docs.

@atachibana shares that 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. Japan 2021 there were many new contributions, one team is creating an end-user manual. Reference link https://jawordpressorg.github.io/user-manual/1_login/.

@chaion07 is focused on onboarding new members. Meeting will be set later this week for new members, details posted later on 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/..

Docs #docs team is actively looking for new members and a new 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 End User Docs Project Lead. Block Editor End User Docs behind by 2 releases. For reference on this project see TrelloTrello Project 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 at https://trello.com/b/JnTCzOsL/gutenberg-end-user-docs.

@femKreations is continuing work on the Site Health docs.

#meeting-minutes, #meeting-notes, #taking-notes, #updates

Summary for Docs Team Meeting June 15, 2021

Attendance

@zzap@atachibana@mkaz@DaisyO@clorith@tacitonic@estelaris@ashiquzzaman, @chaion07, @courane01, @kenshino

Housekeeping

Where: #docs channel on Slack
Find the complete Transcript of the meeting on Slack.

Meeting Facilitator: @milana_cap
Note Taker: @estelaris

Proposal: An audit tool for Learn

@courane01 presented the proposal for an audit tool from the #training and LearnWP team and asked the #docs team to think about what would help in revision control that could work inside a .org site?  What would help our workflows more?

It is important to have revision control features but also more granular ways of tracking entire articles, images, videos, etc. that make it a low-lift for short term contribution work.

The docs team to add requirements and ideas to the spreadsheet and to share later with #training.

A reminder

We are looking for 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 End User Docs Project Lead. Let @milana_cap know if you are interested.

Open Floor

@webcommsat thanked everyone who participated in WCEU this year.