Femy Praseeth 7:35 pm on August 9, 2021  

Summary of Docs Team Meeting Aug 3, 2021

Housekeeping

Attendance

@milana_cap, @femkreations @chaion07,  @basilh, @tacitonic, @johnbillion, @estelaris @themiked, @jrf  @fierevere 

Where: #docs channel on Slack

Find the complete Transcript of the meeting on Slack.

Meeting Facilitator:  @milana_cap

Note Taker: @femkreations

Project Updates

@tacitonic – No updates for the Style Guide. 

@milana_cap – DevHub feedback code to be done by next week.

Please refer to the Summary for details on the tool for handling the issues with documentation such as if docs are out of date, has an error/typo, etc.  For suggestions (and questions), please leave comments on this post 

@femkreations – Working on the GB end-user docs updates based on the 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 for the WordPress release 5.6. The goal is to clean up the board and move everything to the new tool we’re going to decide on.

@estelaris – Will be back next week to continue cleaning up the project.

Open Floor

Discussion 1: 

@johnbillion is looking for someone to run the WP parser (which constructs all the function, method, and hook documentation on the dev site) over trunk after 51529 (51530, 51531, and 51532) and check that the docs for the affected methods are still parsed correctly. 

Some annotations have been added in between the phpdoc 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. and the function itself, so we need to make sure that, with the extra annotation immediately above the method, the phpdoc block gets detected and parsed correctly. If it breaks, the annotations need to be moved to, before the phpdoc block. 

If anyone has documentation on setting up parser or would like to help out, please share in the #docs channel. This needs to be completed before the 5.9 release.

@jrf  added: WordPress-Docs uses only “upstream” PHPCSPHP Code Sniffer PHP Code Sniffer, a popular tool for analyzing code quality. The WordPress Coding Standards rely on PHPCS. Commenting sniffssniff A module for PHP Code Sniffer that analyzes code for a specific problem. Multiple stiffs are combined to create a PHPCS standard. The term is named because it detects code smells, similar to how a dog would "sniff" out food. at this time and she has submitted fixes for those sniffs to PHPCS and those PRs have been merged. She expects PHPCS 3.6.1, which will include the fixes, to be released before 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. 8.1/WP 5.9, so we should be good. She still has to review if there are any sniffs within WPCSWordPress Coding Standards A collection of PHP_CodeSniffer rules (sniffs) to validate code developed for WordPress. It ensures code quality and adherence to coding conventions, especially the official standards for WordPress Core. that need adjusting and will be addressing them soon.

Discussion 2: 

@basilh raised the question: How can one track the progress of a query submitted through the feedback form at the button on a support article. 

@milana_cap added: When the issue is reported, depending on its complexity, it is either fixed right away or an issue is opened in the GitHub repo for Helphub. 

Many of them are either spam or support questions that should be asked in forums and we don’t have enough people to respond to them in a timely manner. If anyone is interested in this position, 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.

@atachibana is in charge of general end-user docs and we’re still working on the block editor end-user docs, all of which are the WordPress articles in the HelpHub. 

@fierevere added:  She has cleaned spam, made sure that spammers are banned, deleted support questions, and fixed simple issues for HelpHub, and will report more complicated issues in the #docs channel on Slack. 

Milana Cap 9:45 pm on August 2, 2021  

Agenda for Documentation Team Meeting 03 August 2021

The next meeting is scheduled with the following details:

When: Tuesday, August 03, 2021, 14:00 UTC

Where: #docs channel on Slack.

Meeting Agenda:

  1. Project Updates
  2. Handling issues across all documentation
  3. Open Floor

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

Thank you!

Milana Cap 9:42 pm on August 2, 2021
Tags: daretodream   

Summary for Docs Team Meeting July 27, 2021

Housekeeping

Attendance

@chaion07, @atachibana, @ashiquzzaman, @kenshino, @mburridge, @tacitonic, @themiked, @femkreations, @courane01, @thisisyeasin, @joyously, @milana_cap

Where: #docs channel on Slack

Find the complete Transcript of the meeting on Slack.

Meeting Facilitator: @kenshino

Note Taker: @milana_cap

Next Meeting Facilitator: @milana_cap

Project Updates

@tacitonic – No substantial updates for the Style Guide. Currently writing the last remaining article on A for the Word List. After this one we could finally announce/publish a post WordPress-wide.

@milana_cap – DevHub and HelpHub have been updated with 5.8 changes. 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 is missing changes from previous releases (this should be a priority) and block editor developer docs is a bit ahead of WordPress release.

Handling issues across all documentation

The Problem: Docs team has more than few different projects to maintain. All these projects have different ways of maintaining which caused different ways for reporting issues. With the team being understaffed most of documentation on contributing is out of date, which makes contributing really difficult. Even for just reporting an issue. There is no system, issues get reported everywhere but mostly in our 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 so if we don’t act on it right away it gets lost. Sorting and triaging issues doesn’t exist.

The Solution: This might not be the best solution for the long run but the team wants to at least start addressing the problem by defining one centralised place where all of the docs issues will be reported. This will ensure unique experience for contributors who report issues, but also for contributors who want to work on those issues – they would have a single place 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. through all the issues and choose which ones to work on.

The team needs to decide which tool will be in use by defining features this tool needs to be useful. 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/ repo and Docs TracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. were mentioned the most. Docs Trac has benefits of contributors being already logged in which is easier for tracking contributions (and perhaps automating profile badges). GitHub, in it’s default setting, demands another account from contributor (even though this can be worked around with many automation tools at our disposal (GitHub + ZenHub and the upcoming GitHub Projects upgrade). This tool would also be in use for tracking release changes and updates to all docs, where appropriate.

Focus here is on reporting, commenting and updating issues.

The features team identified:

  • Templates how to report issue so people can create issues with guidance.
  • Useful labeling system – If we have labels “diagrams needed”, “screenshots needed”, people who don’t like to write can still contribute.
  • Owning the system and not waiting for months to get something updated.
  • Filtering is important too.
  • Make it really easy for new contributors, because making it easy to get involved will help folks continue to be involved.
  • We want to be able to just say – VISIT our issue tracker and pick anything that says “good first issue”.
  • From the perspective of someone reporting the issue, the flow: click on button – > explain the problem – > click on submit would be ideal – Gitbook docs has something like this.
  • If you’re a project lead – you can set it such that you’re notified on specific labels.
  • Have issues organized with a way to easily find what should be revised, do the work, save the revision for approval.
  • Automation could be something like [email protected] that has it’s own github account, and that is used to put publicly reported ideas into this system, into a triage bucket. So contributor reports an issue, they do so using the form. The form itself, is a front end for some magic that turns that submission into a github issue, under a generic triage account. The email address was only for the account creation and it removes the requirement for a user to create yet another account somewhere.
  • If anyone completes an issue – they should PR into the contributor list to add their own WordPress.org nickname in there and that’s how we could track contributions in the future – that sounds like the kind of thing that should be automated.
  • Maybe we can use it to block WP releases until the docs for that release are complete #daretodream

Things we could track, besides issues:

  • a user notices a simple typo
  • translation status of specific pages/content
  • special project progress
  • editing status of specific pages in a handbook (using tags for example)
  • etc

It’s worth noting that the Audit tool (proposed by Training team) could have some of the features that will be very helpful for Docs and some other teams. The audit tool could give something like following workflow:

  • you’re on page (regardless where, it shouldn’t matter) and see out of date/wrong/missing info
  • you highlight the wrong part
  • you click on “report/edit” on the page
  • textarea popup to add description if needed
  • you submit

If you have any suggestions or questions, do leave your comments below. The tool is not yet selected and we’ll try to do that on the next meeting.

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.