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.