Housekeeping
- Attendance: @estelaris @femkreations @milana_cap @atachibana @TC @themiked @mitchblue006 @adeebmalik
- Where: #docs channel on Slack. Find the complete Transcript of the meeting on Slack.
- Meeting Facilitator: @estelaris
- Note Taker: @femkreations
- Agenda: https://make.wordpress.org/docs/2022/02/21/agenda-for-docs-team-bi-weekly-meeting-22-february-2022/
- Next Meeting Facilitator: @TC
Project updates
@milana_cap: Updated the following 2 articles to 5.9.
- https://github.com/WordPress/Documentation-Issue-Tracker/issues/138
- https://github.com/WordPress/Documentation-Issue-Tracker/issues/142
The future of the hashtag in documentation articles
@estelaris: Please read the post about the hashtag, and share your comments and questions. The accessibility team supports any of the ideas in the post. She will be discussing further with the Meta team. The post has been flagged to Josepha for Matt’s attention as we need his approval to apply any of the solutions.
Block Editor end-user doc pages inventory on GH projects
@femkreations: The inventory for the block editor end-user docs is ready in GH Projects. She will open new trackers for the 56 pages that are missing in HelpHub based on the inventory.
Adding tips section to docs
@milana_cap: We are deciding whether we want to offer “best practices” kind of advice to docs. These best practices would not be our personal opinions, but ones collected from dev notes, other teams, opinions of the majority/most experienced, and a general guide of what works.
ACTION ITEM: @milana_cap to write a P2 to discuss this further and get opinions from other teams.
Some things to consider: Whose opinions should be considered for making the best practices and what happens if they disagree?
Best practices to handle GH tickets (who to contact when you have issues/questions when documenting):
This item came up as a contributor posted in the #docs channel on Slack that he was having issues with screenshots quality and his comment went unanswered.
ACTION ITEM: We could add a list of team reps’ names in CONTRIBUTING.md maybe in the issues template.
Question by @mitchblue006: For this issue, when creating screenshots is it ok to use a dummy account?
@milana_cap: As long as it is the correct WordPress version, fresh install with no additional plugins, no themes or languages changed, dummy account is fine
She also shared this awesome app https://app.instawp.io/login. You can choose PHP and WP versions and the installation lives for 72 hours, after which you can revive it and the content will be preserved.
Documenting best practices and rules
Based on a discussion started here, which code standard should code samples adhere to?
@themiked: the answer was WordPress-Core but WordPress-Extra is better. He re-visited every page in the plugin handbook and fixed the code samples to be compliant.
@milana_cap: For plugin/theme development you should really compile to WordPress Coding Standards. We need to present the code in docs by WordPress-Extra coding standards. This is applicable mainly for the docs maintainers.
@estelaris: Do we need to add this tip somewhere so all contributors are aware of it?
Open Floor:
Discussion 1:
@femkreations: Related to this tracker – removing the technical content from the HelpHub where will the removed technical parts go, as she starts making the updates to end user docs?
@milana_cap: They will go into some/few of devhub handbooks, depending on the topic.
ACTION ITEM: @femkreations to create a GH project to track the removed technical parts- where they came from and an open column that tracks where they are going.
Discussion 2:
@milana_cap: To revive docs team coffee breaks, and use it partly as onboarding calls if new contributors like to join. We will try them for a couple of months and see results.
ACTION ITEM: @milana_cap to set up a doodle to start.