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

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

Summary of Docs Team Meeting April 19, 2022

Housekeeping

Review of the design for documentation 

The design team has reviewed the design. We are waiting on Josepha’s approval. The mobile version is not ready yet as there are a few items to be resolved. 

  • We now have 4 categories for the content and a submenu with the 4 categories, displayed at the top so users can easily navigate. 
  • The breadcrumbs are included as part of the left navigation (the blue square on the top left). The first 3 lines are the breadcrumbs, followed by the headings in the article. We also have another option (on the 3rd article example) where the breadcrumbs are horizontal, at the top of the TOC 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..

Please add your comments here or in the slack channel.

Discussion 1: @femkreations: How are we handling the Changelog section since some of the Changelog entries are long?

@milana_cap: suggests not to delete the Changelog as it’s a history of the WP docs.
@bph: The Changelog is also used for translation and some locales might be behind on the pages.
@ibdz: We can have 2 different font sizes- one for the parent <li> (date) and one for secondary level <li> (content) to keep it aesthetically pleasing.

It was decided to add pagination to the Changelog. It is accessible and we can limit the number of entries per page, keeping the newest entries on page one and the oldest on page 2.

Discussion 2: @milana_cap: Would the definition list be semantic markup for the Changelog?

 @mburridge suggests the details disclosure element

Discussion 3: @estelaris: What about the FAQs that are on some of the block articles? Are we going to keep them there or can we extract them and create a new FAQs section under resources?

@milana_cap: Thinks all FAQs should be in FAQs and articles that currently have them could link to them.
@atachibana: Suggests keeping it as is, to reduce the cost, and also create independent pages of the FAQ.
@ibdz: Thinks from the user’s point of view, it’s good to have the FAQ attached to the page.

Project updates

@milana_cap:

  • Closed a few more 5.9 block editor end-user issues.
  • All tracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. tickets are labeled for docs and GitHub project is ready.
  • We have a new channel #docs-firehose for getting 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/ updates so that we keep the #docs channel clean

@femkreations:

  • Triaging the Google Doc and creating the Tracker issues for 6.0 end-user documentation.
  • So far, 40 trackers have been added for 6.0 End User Documentation.
  • Will complete the triage by the end of the week.

@estelaris:

All the block editor articles listed in the inventory have been added to the new sitemap.

Open floor

@estelaris and @femkreations to review the following two pages: Block Editor and WordPress Editor to make sure they are not repetitive and if so, merge and delete one. @atachibana: Suggests renaming WordPress Editor to Classic Editor and keeping with TinyMCE.

@milana_cap gave a talk about Docs 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. Athens in person.

@milana_cap to lead the Docs table at the 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/. for WCEU.

#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

X-post: Brand Guideline Additional Consideration

X-comment from +make.wordpress.org/training: Comment on Brand Guideline Additional Consideration

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.

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