Summary of Docs Team Meeting Sep 21, 2021

Housekeeping

Project updates

@tacitonic:  The WordPress Documentation Style Guide has been completed. This includes all the remaining articles, the word list, and the usage dictionary.

15 min repo triage:

Issue 1(labeled needs-discussion): Some end-user docs are too technical

@milana_cap: Agrees we shouldn’t have technical details in the end-user docs. But raises the question – where, in DevHub, should that info live?

End-user docs are for people who don’t code and most likely don’t deal with hosting/server issues but rather contact support. We need a place in DevHub that will be dedicated to tasks like .htaccess, internationalization, localization, etc that are shared throughout developing with WordPress. These are neither 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/theme topics nor common APIs but also are not the end-user concerns. 

She suggests we collect all the articles in the support section that are technical. This will help to get a better picture of the dedicated space we will need to create in DevHub.

@basilh  – Suggests hyperlinks to a dedicated space on wordpress.org for topics related to ApacheApache Apache is the most widely used web server software. Developed and maintained by Apache Software Foundation. Apache is an Open Source software available for free. and NginxNGINX NGINX is open source software for web serving, reverse proxying, caching, load balancing, media streaming, and more. It started out as a web server designed for maximum performance and stability. In addition to its HTTP server capabilities, NGINX can also function as a proxy server for email (IMAP, POP3, and SMTP) and a reverse proxy and load balancer for HTTP, TCP, and UDP servers. https://www.nginx.com/., etc. 

@milana_cap: Agrees to move all such info to another location on wordpress.org. And maybe say something like “For more advanced server settings take a check out this link”

ACTION ITEM: Please add your thoughts in the comments for the issue in GitHub.

Issue 2 (labeled good-first-issue): Update links inside the posts-screen DOC

  • @muhammadfaizanhaidar is unable to recreate the issue and will update in the comments for that issue. 
  • @TC to take a look at the issue, if needed.

Summary for Docs Team Meeting September 14, 2021

Housekeeping

Attendance

@atachibana, @mburridge, @TC , @ashiquzzaman , @femKreations,  @kmhazari , @estelaris , @Basil, @joyously , @danfarrow , @Kenshino (Jon) , @themiked ,

Where: #docs channel on Slack

Find the complete Transcript of the meeting on Slack.

Meeting Facilitator: @TC

Note Taker: @ashiquzzaman

Project Updates

From @atachibana For contents side, all issues in the repository were labeled and active discussions are on going.
Stats: 18 Open / 9 Closed.

Open Floors

estelaris highlighted on using both Google Spreadsheet and 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/ for different issues. Upon discussion it was agreed that we

#meeting-notes

[Announcement] New workflow for reporting documentation issues

For a few weeks now Documentation team is testing out new workflow for reporting issues – a GitHub repository which will be a single, centralised place for reporting all documentation issues. How and why we decided to do this can be found in team’s meeting notes.

What we hope to achieve with this workflow:

  • Easier contribution in form of reporting issues – even though this workflow still requires another account from contributor (the 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/ one), with this workflow contributor doesn’t need to know which part of documentation is issue for. They can just report the issue and move on, if they so wish. We lost many one-time contributions due to the complicated workflow for reporting issues.
  • Easier contribution in form of fixing issues – with all projects and their different reporting issues tools, contributor who wanted to join team and work on fixing issues had to decide which project they wanted to work on before even seeing issues. With everything in one place they can browse all the issues, find the ones that seem interesting and then look for advice on fixing it.
  • Some projects didn’t have any way for reporting issues except for coming to #docs SlackSlack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/. channel and hoping that someone will see it. This way is deprived of a place where the issue would be discussed as many things get lost in Slack noise. Also, this way is almost impossible to keep track of contributors and give them credits for their contributions.
  • Easier managing of projects and documentation in whole – team members have better overview of everything that’s happening in every Docs project, can help out in projects they usually don’t work on and have a general picture of WordPress documentation as a whole.
  • Easier contributions tracking – with every issue, comment, contribution being saved in one place, we have a better understanding of how certain parts of docs were created and who worked on them.
  • Better planning and setting goals with GitHub projects.
  • Better understating and following progress and statistics for each project by structured labeling system.
GitHub issue discussion.
GitHub issue discussion

We are still configuring labels, templates and the repo itself; and still figuring out the best way to work on/with issues. For the future we hope to connect this repository with the actual documentation at 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/ so that contributions can be make directly on the page with the issue which would automatically create new issue and apply proper labels.

In the next phase, which will be soon, we will start using GitHub Projects for managing all the issues.

GitHub Project board for managing all GitHub issues from the repository.
GitHub Projects board

Documentation Team is managing all documentation as an unified project and is adopting appropriate tools in order to do so.

As always, if you have any questions or suggestions, please leave the in comments bellow.

Summary of Docs Team Meeting Sep 7, 2021

Housekeeping

Attendance

@TC, @femkreations, @milana_cap, @atachibana, @kenshino, @themiked, @joyously, @estelaris, @kartiks16, @kafleg, @kmhazari 

Where: #docs channel on Slack

Find the complete Transcript of the meeting on Slack.

Meeting Facilitator:  @TC

Note Taker: @femkreations

Next Meeting Facilitators: @kmhazari  and @TC

Project updates

@milana_cap – Work in progress on the 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/. post about the doc team’s new workflow that we can share with other teams.

@atachibana – From the content site, processing as many related issues as possible. 

@femkreations: Added labels to the existing issues in the repo.

Handling issues across all documentation

Discussion on adding a dedicated time for repo triage :

by @milana-cap

The easy and straightforward issues don’t need triage but for issues that need discussion and the team’s decision, we could add a label like “discussion” or “needs discussion”.

Based on the number of issues under that label we can plan the meeting time for triage.

@kenshino: The triage is required so we can build the habit and for people to pick up issues.

DECISION: Dedicate 15 mins to triage issues during the weekly doc meetings. Depending on the number of issues we can make changes to the triage time if needed. Keep this in mind when making meeting agendas.

Discussion on adding labels to issues requesting new document/article:

by @milana-cap

This is related to the PR – issue template that’s requesting a new page/article.

@milana-cap has added labels for 5.6, 5.7, 5.8, and 5.9 for releases.

@kenshino: At some point, we should have documentation tied to specific releases.

DECISION: Add “new document” label to the issues requesting new document/article, for now. @femkreations to update the issue template with the label.

Summary of Docs Team Meeting Aug 31, 2021

Housekeeping

Attendance: @zzap, @atachiba, @basil, @TC, @Kris Hazari, @Kartik Shukla@femkreations, @estelaris, @themiked, @joyously, @Michael Burridge

Where: #docs channel on Slack

Find the complete Transcript of the meeting on Slack.

Meeting Facilitator:  @zzap

1. Project Updates

@atachiba:
New repository is working quite well.

2. Handling issues across all documentation

@atachiba:
@Kenshino (Jon) is still working on the readme

@zzap
New maintainers added to the repo

@femkreations:
Intends to complete 2 overdue tasks this week –
1. Creating templates for new doc request and fix bugs in existing.
2. Adding labels to existing issues in the repo.

3. Documenting processes – new workflows and ways to contribute

@zzap:
This page in particular that needs updating with new info –
https://make.wordpress.org/docs/handbook/workflows/reporting-an-issue/
There are new members (TC and @yusuf saifur-Rahman) interested in doing this in order to learn the process of contributing along the way.

@zzap:
We should start migrating end user blockBlock Block is the abstract term used to describe units of markup that, composed together, form the content or layout of a webpage using the WordPress editor. The idea combines concepts of what in the past may have achieved with shortcodes, custom HTML, and embed discovery into a single consistent API and user experience. editor docs issues from 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 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 use release labels – @Michael Burridge to look at this.

@zzap:
To co-ordinate with 5.9 release team (when announced) to make communication between release team and docs team a habit.

4. Open Floor

@joyously:
Do the new folks have the capabilities they need, to do things like add labels or whatever?
@zzap added some accounts at the github repo.

@zzap to ask metaMeta Meta is a term that refers to the inside workings of a group. For us, this is the team that works on internal WordPress sites like WordCamp Central and Make WordPress. to connect github repo with the 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 that we are notified for every new issue.

@joyously:
Was there still a planned automation of opening issues directly from the docs?
@zzap:
It is planned but first we want to see how this will go and what exactly we want the workflow to look like. I believe that would be 2nd phase.