Milana Cap 11:28 am on August 31, 2021  

Agenda for Documentation Team Meeting 31 August 2021

The next meeting is scheduled with the following details:

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

Where: #docs channel on Slack.

Meeting Agenda:

  1. Project Updates
  2. Handling issues across all documentation (Ref. Ticket 5863)
  3. Documenting processes – new workflows and ways to contribute
  4. Open Floor

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

Thank you!

Akira Tachibana 9:54 am on August 31, 2021  

Summary of Docs Team Meeting Aug 24, 2021

Housekeeping

Attendance

@estelaris @atachibana @themiked @kenshino @basilh @femkreations @joyously

Where: #docs channel on Slack

Find the complete Transcript of the meeting on Slack.

Meeting Facilitator:  @atachibana

Project Updates

HelpHub content team has started the new repository and it is working well.

New repository to hande issues across all documentation

@kenshino:
New official repository for documentation issues created: https://github.com/WordPress/Documentation-Issue-Tracker. New Issues have already been reported in the new repo: https://github.com/WordPress/Documentation-Issue-Tracker/issues

Management of the repo:

@kenshino who is preparing README.md:

Focusing on how one would use the repo so that
1. Issues are picked up
2. There’s no overlap / repeated work
e.g. I’ll be putting in guidelines such as
– If you are working on an issue, assign it to yourself
– If you don’t have permissions to assign, please let us know you’d like to pick this issue up and we’ll do the assignments

Issue Templates

@femkreations who is making on updates of issue template:

https://github.com/WordPress/Documentation-Issue-Tracker/pull/12

@kenshino :
we can make 2 issue templates. One for current doc fixes, one for doc requests.
Let’s start with one of the following

  • Doc Fix / New Doc
    OR
  • User Doc / Dev Doc

@joyously :
Can there be an initial input of a URLURL A specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org, and that is used to choose the correct template?

@kenshino :
It’s a button. It will look like this.

@basilh :
Most of these have not used the template. Will these be discarded and required to use the new templates)?

@atachibana:
My failure. I copied opened issues from other repository. We should follow the template and I will do.

Labels

@femkreations:
Do we need to manually assign labels to the existing ones?

@kenshino:
Yes please manually assign for now

Open Floor

@kenshino :
We can probably use one of the meetings to do some triage

Femy Praseeth 8:06 pm on August 17, 2021  

Summary of Docs Team Meeting Aug 17, 2021

Housekeeping

Attendance

@atachibana @femkreations @kenshino @themiked @mkaz  @bgturner @tacitonic @basilh @kmhazari @ashiquzzaman @kartiks16  @thisisyeasin

Where: #docs channel on Slack

Find the complete Transcript of the meeting on Slack.

Meeting Facilitator:  @atachibana

Note Taker: @femkreations

Agenda: https://make.wordpress.org/docs/2021/08/17/agenda-for-documentation-team-meeting-17-august-2021/

Project Updates

No new project updates for the Style Guide and HelpHub. 

Handling issues across all documentation

@kenshino:
New official repository for documentation issues created: https://github.com/WordPress/Documentation-Issue-Tracker. New Issues have already been reported in the new repo: https://github.com/WordPress/Documentation-Issue-Tracker/issues

Management of the repo:

The doc issues already in the HelpHub/issues repo will be copied by @atachibana to the new repository. HelpHub/issues will be closed.

In the future, all new issues will be added to the new official repository. 

Anyone can open an issue and add comments. After the document updates are completed, the issue will be closed. 

The current implementation of the docs repo is considered as v1.

Contributors would need to register a 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/ account if they want to write up an issue.

How will the issues be assigned?

We can set it up such that certain Issue templates automatically assign a user or we can do this manually via a triage weekly.

How to track per project, for those that are in GitHub already (Eg: 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/)?

There are issues for documentation already in the WordPress/gutenberg repo – the intent is not to move those out but to create a place that people could go if they are unsure about where to post issues. They can be triaged and routed to the right team later.

The idea is to have a single place that anyone can post a doc issue and not have to know what project to go to. If someone knows it’s a Gutenberg doc, they could go directly there to file an issue.

Issue Templates:

Purpose of the issue template: To ensure that when a user reports an issue, all required information is provided right off the top.  This template will guide the issuer to provide structured data which will help the documentation team to easily fix the issue.

Suggested headers by @themiked

  • URLURL A specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org showing issue
  • Section of Page showing issue
  • description of the issue
  • why it is a problem
  • suggested fix

@femkreations will pick the suggested headers and create a pull request to add in an Issue Template.

Labels:

Each handbook will have its own project-specific label.

Why are we not using separate projects for each handbook?

  • GitHub issues now have Projects where previously we could only use Labels.
  • GitHub “Project” is more heavy weight than a label.
  • GitHub Projects are getting an overhaul soon. So we will wait for the changes to come in and work on getting this set up, in the meantime.
  • The Project View is less a classification of an issue and more a workflow tool, like a kanban board.

@kenshino will define the default labels that we’ll use.

Update docs to point to the Tracker:

@kenshino to add all project leads to the GitHub Team and they will have “maintain” access. 

All project leads to DM their GitHub username to @kenshino.

All project leads should update their docs to point towards using this Issue Tracker.

Write a guide on how this issue tracker is used and managed:

We will take Gutenberg’s contributing guidelines as a basis and expand on it.

@mkaz to create a PR for the README.  @themiked to help edit the guide.

Akira Tachibana 9:32 am on August 17, 2021  

Agenda for Documentation Team Meeting 17 August 2021

The next meeting is scheduled with the following details:

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

Where: #docs channel on Slack.

Meeting Agenda:

  1. Project Updates
  2. Handling issues across all documentation (Ref. Ticket 5863)
  3. Open Floor

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

Thank you!

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