Milana Cap 9:28 pm on June 6, 2021  

Writing documentation for WordPress release

WordPress is currently in Feature freeze/Bug Fixes period of 5.8 release cycle, with 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. 1 coming up on Tuesday, 8th June. In previous releases Documentation team wasn’t much involved, if at all, into release cycles which resulted in some parts of documentation being out of date or even missing. 

This has to change and in this release we want to bring release changes to the Documentation team and help keep all parts of WordPress documentation as much up to date as possible.

Each release introduces a number of changes that should be documented for both end user and developer documentation. This means that we will have to update HelpHub and DevHub respectively. 

All 5.8 tickets that are marked for some sort of documentation can be found in this document, in All marked for docs sheet. 

HelpHub updates

Tickets that hold user facing changes can be found in Docs for HelpHub sheet. These changes do not include 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 changes as block editor end user documentation is managed separately. 

DevHub changes

Most of the changes will affect the Plugin Developer Handbook and can be found in Docs for DevHub sheet.

Block editor end user changes

Block editor end user documentation is listed in this document while the progress is managed in Trello board. Please note that NOT all changes from WordPress 5.6 and 5.7 are published yet.

Block editor developer changes

Changes for block editor developer documentation are monitored by @mkaz and listed in the Dev Block Editor sheet.

All these changes should be documented and ready for updating existing documentation on the day of the release, 20th July 2021.

What about Dev Notes?

All tickets that should end up in dev notes are listed in the Dev Notes sheet. We are starting to work on them when Beta 1 begins, on Tuesday 8th June. All of them, together with Field Guide should be published by 29th June, with 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. 1.

Is that all?

No. I need your help. As part of this experiment to involve the Documentation team into WordPress release, my hope is to bring everyone halfway. I need help with following tasks:

  • Volunteers to prepare existing and/or new HelpHub pages for 5.8 changes – this involves finding the HelpHub article that should be updated, preparing screenshots (if needed) and content to be added and/or removed. Person in charge of HelpHub content is @atachibana.  
  • Volunteers to prepare existing and/or new DevHub pages for 5.8 changes – this involves finding the DevHub page that should be updated, preparing code examples (if needed) and content to be added and/or removed. There are several people in charge of different parts of DevHub.
  • Volunteers to take over managing block editor end user documentation (as our wonderful @bph had to step down) – this involves monitoring 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/ releases for end user changes, monitoring 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 tickets and managing and onboarding contributors. This doesn’t have to be a one person role. The more the merrier.  
  • Volunteers to prepare existing and/or new articles in block editor end user documentation for 5.8 changes – this involves finding the HelpHub article that should be updated, preparing screenshots (if needed) and content to be added and/or removed. At the moment we don’t have a person in charge so I’ll jump in until someone volunteers.
  • Volunteers to prepare existing and/or new pages in block editor developer documentation for 5.8 changes – this involves finding the page that should be updated, preparing code examples (if needed) and content to be added and/or removed. Person in charge of block editor developer documentation is @justinahinon and person monitoring changes in 5.8 release is @mkaz.

Site Health documentation

Site Health is not a new feature in 5.8 release but we don’t have any kind of documentation for it. We need volunteers for both end user and developer documentation.

If you are interested in helping out do not hesitate to 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 (username: zzap) or any other mentioned project rep at 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/.. You can also express your interest in the comments below. 

We hope to start a new workflow with 5.8 release which will bring CoreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. and Documentation teams to work more closely, especially during release cycles.

Akira Tachibana 4:23 pm on July 13, 2021  

Summary for Docs Team Meeting July 13, 2021

Housekeeping

Attendance

@milana_cap, @thisisyeasin, @atachibana, @kmhazari, @webtechpooja, @mburridge, @caseymilne, @tacitonic, @mikachan, @chaion07

Where: #docs channel on Slack

Find the complete Transcript of the meeting on Slack.

Meeting Facilitator: @milana_cap

Note Taker: @atachibana

Next Meeting Facilitator: No volunteers found for facilitation of next week’s 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

@tacitonic: For the Style Guide, He has completed the article for C. Currently writing the article for B.

@milana_cap: 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 end user docs: we are seeing progress being made by @annezazu, Milana is joining this week. For WordPress 5.8 release cycle today we’re having RCRelease Candidate A beta version of software with the potential to be a final product, which is ready to release unless significant bugs emerge. 3 only 7 days till 5.8 going into the wild.

New Member Mentoring

@milana_cap will give some advices to @mburridg and @kmhazari.

Anyone else new and need a bit of guidance feel free to join #docs channel and post your questions or comments.

An Audit Tool Update

@milana_cap: She and @courane01 had a meeting and discussed a lot of ideas on tracking changes and updates from releases also, some nice ideas on making contribution process easier and simpler (hopefully unified throughout the wp.org)

If you’re interested, keep an eye on Audit Tool in #training and #marketinghttps://make.wordpress.org/training/2021/05/28/proposal-an-audit-tool-for-learn/
She personally thinks it could be a game changer if we get all we talked about.

Doc update for 5.8 update release – DevHub & HelpHub updates

@milana_cap: This is the last week of the release cycle and this week She is working on DevHub and HelpHub updates. @femkreationsdid most of HelpHub updates, @annezazu is rocking that block editor end user updates.

She will go through all the 5.6, 5.7 and 5.8 cards in 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 to see where we are with block editor end user docs and work on those DevHub updates. if anyone is interested in helping out, here’s the sheet 

https://docs.google.com/spreadsheets/d/1RS0BEwy8pNNHR7P_nZ3yKcgWKVABbEn9RMjja-wkJwY/edit?usp=sharing

Doc Team is looking for Block Editor End User Docs Project Lead

Michael Burridge (@mburridge) raised hand for this role!

Open Floor

none.

Milana Cap 11:55 am on July 13, 2021  

Agenda for Documentation Team Meeting 13 July 2021

The next meeting is scheduled with the following details:

When: Tuesday, July 13, 2021, 14:00 UTC

Where: #docs channel on Slack.

Meeting Agenda:

  1. Project Updates
  2. New Member Mentoring
  3. An Audit Tool update
  4. Doc update for 5.8 update release – DevHub & HelpHub updates
  5. Doc Team is 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
  6. Open Floor

Please feel free to suggest agenda items by commenting on this post or by raising it during Open Floor.

Thank you!

ashiquzzaman 7:19 am on July 11, 2021
Tags:   

Summary for Docs Team Meeting July 6, 2021

Housekeeping

Attendance

@ashiquzzaman, @femkreations , @chaion07, @thisisyeasin, @manzwebdesigns , @annezazu, @milana_cap, @tacitonic, @mburridge, @kmhazari ,

Where: #docs channel on Slack

Find the complete Transcript of the meeting on Slack.

Meeting Facilitator: @chaion07

Note Taker: @ashiquzzaman

Next Meeting Facilitator: @milana_cap

Open floor

 @Michael Burridge interested in 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 End User Docs Project Lead’ position.

@Femy wrote HelpHub updates, @zzap to review later

#meeting-notes

ashiquzzaman 6:07 am on June 30, 2021
Tags:   

Summary for Docs Team Meeting June 29, 2021

Housekeeping

Attendance

@milana_cap, @ashiquzzaman,  @atachibana, @mburridge @mkaz,  @femKreations, @tacitonic, @kmhazari @chaion07, @joyously @themiked, @manzwebdesigns 

Where: #docs channel on Slack

Find the complete Transcript of the meeting on Slack.

Meeting Facilitator: @ashiquzzaman

Note Taker: @femKreations

Next Meeting Facilitator: No volunteers found for facilitation of next week’s 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

Doc update for 5.8 update release

Update from @milana_cap:  WordPress 5.8 release cycle today enters 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. 1 phase. This means that all dev notes and field guides should be published today (June 29, 2021). Once that’s done the doc team will move on to updating DevHub and HelpHub. @femKreations is currently working on the HelpHub updates, hence a lot of HelpHub is ready.

The doc team also has a new 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 activated at HelpHub and DevHub, which allows the documentation team to edit already published posts and pages and schedule changes for later date while existing content is intact.

Update from @tacitonic:  No new updates for the Style Guide. Currently working on the article for C.

New Member Mentoring

Update from @chaion07:  A schedule is being prepared to support the onboarding of new members. A link to the form will be shared in a blog post (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/.) for the convenience of everyone. The team is aiming to start in early July.

Monthly Coffee Break: Also for Docs Coffee Break The team is unlikely to have one for June due to the unavailability of coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. members and a lot of contributors struggling to find time due to COVID.

@mburridge will be working with @chaion07 for guidance and mentoring to get started with contributing to the docs team.

Audit Tool Proposal Update (proposed by the Training Team)

@courane01 and @milana_cap have a meeting scheduled on Friday, July 2. 2021 to review how the docs audit HelpHub/DevHub currently and collect the feature requests for the audit plugin/tool. Also to be determined what in the tool would benefit the docs workflows.

DevHub & HelpHub updates

@justinahinon’s raised few questions on DevHub:

  • Is there a reason why 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/ APIAPI An API or Application Programming Interface is a software intermediary that allows programs to interact with each other and share data in limited, clearly defined ways. documentation is hosted on Codex (https://codex.wordpress.org/WordPress.org_API), and not on DevHub?
  • It seems like WordPress.org API documentation could benefit from some improvements, by adding examples, use cases, and endpoints, for example. But it also seems like some of these are intentionally not documented because they are not meant to be used by third parties. Is this the case, and if yes, where should we look to find what should not be documented?

@milana_cap suggested discussing this with the #meta team and see if there’s a good place for such documentation.@atachibana suggested Common API Handbooks to add the WordPress.org API documentation. @milana_cap and @atachibana agreed that adding the WordPress.org API documentation to the Common API Handbooks would be confusing.

@femKreations will continue working on the HelpHub

Doc Team is 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. @mburridge has shown interest and would consider the role after onboarding.

Update from @milana_cap The categorization of support articles is still in progress. @estelaris is working on the site search and it will be done soon.

Open Floor

@joyously asked about the categorization of support articles?

@milana_cap commented that it’s still in progress.

#meeting-notes

ashiquzzaman 11:44 am on June 24, 2021
Tags:   

Agenda for Documentation Team Meeting 29 June 2021

The next meeting is scheduled with the following details:

When: Tuesday, June 29, 2021, 14:00 UTC

Where: #docs channel on Slack.

Meeting Agenda:

  1. Project Updates
  2. New Member Mentoring
  3. An Audit Tool (proposed by the Training Team)
  4. Doc update for 5.8 update release
  5. DevHub & HelpHub updates
  6. Doc Team is 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
  7. Open Floor

Please feel free to suggest agenda items by commenting on this post or by raising it during Open Floor.

Thank you!

#meeting-agenda

Casey Milne 3:53 pm on June 22, 2021
Tags: , , , , train,   

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

Estela Rueda 2:10 pm on June 22, 2021
Tags: , training   

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.

webcommsat AbhaNonStopNewsUK 8:55 pm on June 15, 2021
Tags: make.wordpress.org/marketing,   

X-post: Agenda: Global Marketing Meeting – 16 June 2021

X-comment from +make.wordpress.org/marketing: Comment on Agenda: Global Marketing Meeting – 16 June 2021

Jon (Kenshino) 10:29 am on June 8, 2021  

Agenda for Documentation Team Meeting 8 June 2021

The next meeting is scheduled with the following details:

When: Tuesday, June 8, 2021, 14:00 UTC

Where: #docs channel on Slack.

Meeting Agenda:

  1. Project Updates
  2. New Member Mentoring
  3. Theme Handbook changes
  4. An Audit Tool (proposed by the Training Team)
  5. A tighter partnership between CoreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. & Docs (as proposed by @milana_cap and @mkaz)
  6. We need 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 User Docs Project Lead!
  7. Open Floor

Please feel free to suggest agenda items by commenting on this post or by raising it during Open Floor.

Thank you!