Summary of Docs Team Meeting May 10, 2022

Housekeeping

Project Updates

  •  @milana_cap shares the status of docs regarding WordPress 6.0
    • last week we had RC1 out, all Dev Notes and Field Guide are published
    • we’re moving on to updating end user and dev docs – anyone wants to help just 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
  • @juanmaguitar asked about a list of Projects related to Docs
    • The list is here but it’s probably a bit outdated
  •  @milana_cap shares that besides 6.0 she has created two new projects in the Docs repo:
  • @femkreations shares:
    • she completed triaging the google doc and created trackers for 6.0 end-user documentation,
    • she reviewed the google doc with help of @milana_cap on a video call and @bph (async) for clarifications.
    • she also reviewed the WP 6.0 release candidateRelease Candidate A beta version of software with the potential to be a final product, which is ready to release unless significant bugs emerge. post and About Page (draft)  for the HelpHub updates required and updated the trackers.
  •  @milana_cap shares she’s working on getting more people making code examples for code reference

Open Floor

#meeting

Agenda for docs team bi-weekly meeting 19 April 2022

The next meeting is scheduled with the following details:

When: Tuesday, April 19, 2022, 04:00 PM GMT+2

Where: #docs channel on Slack

Agenda

  1. Attendance
  2. Note-taker & Facilitator selection for Next Meeting
  3. Review of the design for documentation. We should have one more review before presenting the final design for approval
  4. Projects checks
  5. Open floor

If there’s anything you’d like to discuss on the open floor, please leave the comment below.

Summary of Docs team meeting Apr 5, 2022

Housekeeping

Project updates

WordPress 6.0 End User Documentation 

@bph created a list of changes coming to WordPress 6.0 that would need End-User Documentation. She is waiting for the 13.0 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 release happening on Friday 4/8 and the walk-through before completing the list and setting priorities. Currently, some of the sections are not fully curated and some PRs might not be user-facing. She hopes to have the list completed by Monday, April 11th.

@milana_cap to start creating GitHub issues in the tracker repo from the list, once the list of changes is finalized. She also created 2 priority levels for the tasks: High and Medium.

@estelaris noted: Contributors who work on End-User Documentation need to follow the style guide such as using sentence case for headings and adding the word ‘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.’ to the title and URLURL A specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org for all the block pages.

@bph to start wrangling PR authors for their Dev Notes for the release and the Field guide.

@bph/@milana_cap to go through all TracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. tickets to collect all DevNotes, dev and end-user docs. They will also update the Contributors-wanted post and share the post on the internet.

Other updates

@estelaris: Work on the HelpHub is progressing well. The 301 redirects issue will be fixed for wordpress.org and will be on the list of features for the next release. HelpHub sitemap has been approved by Josepha and the Docs team.

@estelaris is currently working on the HelpHub design. The Docs team reviewed the first draft in the meeting. Once the design is approved by the design team, it will be shared. And the next step will be to redirect articles (changing titles/URLs/merging articles, etc).

@milana_cap: recorded onboarding session. She will upload it to wordpress.tv after she edits out a section. She did some work on triaging Trac tickets for 6.0 docs. She also reviewed quite a few block editor end-user issues.

@femkreations: Added more new pages to the Block Editor End-User Docs for the missing block pages for the 5.9 release.

@themiked: Updated a plugin handbook page.

#meetings

Agenda for docs team bi-weekly meeting 5 April 2022

The next meeting is scheduled with the following details:

When:

Tuesday, April 5, 2022, 2PM UTC

Where: #docs channel on Slack

Agenda

1. Attendance

2. Note-taker & Facilitator selection for Next Meeting

3.  WordPress 6.0 End User Documentation list

4. Projects checks

5. Open floor

If there’s anything you’d like to discuss on the open floor, please leave the comment below.

Onboarding sessions – live!

Onboarding sessions for the Documentation team are back. If you want to get involved but don’t know how (because the documentation on that is out of date 🙄) we will be happy to answer all your questions and show you how you can start contributing in a live session.

There is no agenda. The format is AMA (Ask Me Anything) but if you don’t have any questions we’ll start with priorities. If you’re not comfortable participating with questions, feel free to keep your camera off ad mic muted and just enjoy in watching.

The session will be recorded and published at WordPress.tv so you’ll be able to watch it later, as many times as you want. The one thing you can expect is that I’ll be asking for volunteer to write up the summary of the session as writing meeting notes, as well as facilitating meetings, are some of the the most common entry points when getting started contributing to the Documentation team.

When

Wednesday, March 30, 2022, 2PM UTC

Where

I’m looking forward to seeing you on Wednesday 🤩🍪

#onboarding

Working on WordPress release 6.0 – Selecting Trac tickets for DevNotes

As you might know, we have entered WordPress 6.0 release cycle. Important part of it is going through all TracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. tickets and selecting those for documentation.

There are 3 types of documentation created for release:

  • End user documentation – updates to HelpHub
  • Developer documentation – updates to DevHub
  • Dev notes – published on #core blog and then gathered in release Field Guide

During last Documentation team meeting attendees showed interest in seeing how this is done so I’ll be doing a live session in a Zoom call. Everyone is welcome to join.

Session will be recorded for everyone who can’t make it and wants to see it later. See you soon 🍪

#meetings

#release

Summary of Docs Team Meeting March 22, 2022

Housekeeping

Project updates

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 documentation updates for 5.9:

We are currently updating the documentation to 5.9

@femkreations: Currently adding new pages for the various blocks that are missing in the end-user documentation. Completed 7 pages and will continue working on this.
@rmartinezduque: Worked on the Pinterest embed and Wolfram embed block pages.
@atachibana: Updating the end-user docs with screenshots and images.

if anyone wants to join, please chose one of these issues: https://github.com/WordPress/Documentation-Issue-Tracker/projects/3. The board also has Good First Issue label on issues, to help you get started.

WordPress 6.0 documentation:

@bph is working on the Dev notes board. She also went through 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 releases to prepare the list of needed end-user documentation changes for 6.0. This document will be done by the end of the week with one Gutenberg plugin release (13.0) to go for 6.0.

@milana_cap to go through the coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. tracs and add tickets to the Dev notes board. She will make it a zoom call so anyone who wants to see how it’s done can join. The date/time for the zoom call will be announced beforehand in a blog post (coming soon) and the process will also be recorded.

Others:

@bph created a Trac ticket for the modification needed on developer.w.org/news for the Developer News Blog  (Proposal

#meetings

Agenda for docs team bi-weekly meeting 22 March 2022

The next meeting is scheduled with the following details:

When: Tuesday, March 22, 2022, 03:00 PM GMT+1

Where: #docs channel on Slack

Agenda

1. Attendance

2. Note-taker & Facilitator selection for Next Meeting

3. Projects checks

4. Open floor

If there’s anything you’d like to discuss on the open floor, please leave the comment below.

#agenda, #meeting-agenda, #meetings

Summary of Docs Team Meeting March 8, 2022

Housekeeping

Project updates

Docs issue tracker

Updates for issues repo in last 7 days: https://make.wordpress.org/updates/2022/03/07/documentation-team-update-march-7-2022/

WordPress 6.0 release

Docs focus team for WordPress 6.0 release had a first meeting yesterday. If anyone likes to join, help with writing parts of docs, just watch the process, get involved in whatever form, you can do so by stating your interest in #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 or pinging @milana_cap (zzap in slack).

Everyone is welcome to join #6-0-release-leads; you might not be able to post but you’ll see the process and what’s happening.

End user 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 docs

General end user docs

  • new sitemap@estelaris wrote First review on the new Sitemap for HelpHub and needs feedback on it.
  • replacing hashtag@estelaris opened ticket with #meta for evaluating 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) issues and design for removing the hashtag https://meta.trac.wordpress.org/ticket/6171

Developer docs

  • technical parts removed from HelpHub@femkreations created a GH Projects that has the inventory of the technical parts that are removed from the end user docs https://github.com/orgs/WordPress/projects/26/views/1. It’s a work in progress. If you’d like to help, 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.” @femkreations (Femy in slack).

Needs feedback

  • First review on the new Sitemap for HelpHub – one of discussion questions – should FAQ articles live separately in FAQ category or be in their respective sections
  • Change article titles part 1it was recommended from Marketing team (@jonoaldersonwp) to change URLs as well and use 301 redirects – we have to ask in 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. for options to do this.
  • URLs for new HelpHub articles – we don’t have anything about this in Style Guide and @femkreations needs directions for those missing articles in 5.9. Proposed solution is to follow consistency where possible (e.g. adding -block for block articles and embed- for embed blocks) and leave other slugs to be created naturally from the title.

#summary

Agenda for docs team bi-weekly meeting 8 March 2022

The next meeting is scheduled with the following details:

When: Tuesday, March 8, 2022, 03:00 PM GMT+1

Where: #docs channel on Slack

Agenda:

  1. Attendance
  2. Note-taker & Facilitator selection for Next Meeting
  3. Projects checks

@femkreations has the floor

For the URLURL A specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org for the new pages in the HelpHub, is there anything specific to keep in mind while creating the URL?

@estelaris has the floor

Reviewing the re-categorization and renaming of some articles.

4. Open floor

If there’s anything you’d like to discuss on the open floor, please leave the comment below.

#agenda, #meeting-agenda, #meetings