Summary for Docs Team Meeting on 21 September 2020

Attendance

@justinahinon, @dianamivelli, @estelaris, @kartiks16, @tacitonic, @chaion07, @atachibana, @sukafia, @bobbingwide, @kulsumsiddique, @mkaz.

Thanks to @estelaris for Facilitating the Meeting.

Notetaker & Facilitator Selection

Notetaker: We could use a few volunteers to take notes for our weekly meetings. If you want to help then please comment here or let us know during our meetings.

Facilitator for the next meeting: @chaion07

Next Meeting: 28 September 2020

Find the complete Transcript of the meeting on 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/..

Project Updates

@milana_cap updated badges page with a new document and a process for tracking contributions. (asynch to the meeting)

@atachibana reported on the migrationMigration Moving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. and re-routing of Codex to Code:

  • 29 Classes out 43 have been completed which is an improvement of 7.4% leading to 67.4% from last week’s 60.5%, and
  • 51 HooksHooks In WordPress theme and development, hooks are functions that can be applied to an action or a Filter in WordPress. Actions are functions performed when a certain event occurs in WordPress. Filters allow you to modify certain functions. Arguments used to hook both filters and actions look the same. out of 355 have been completed which is an improvement of 2.6% leading to 14.4% from last week’s 11.8%.
  • @atachibana thanked @stevenlinx for the contribution.
  • He also did some housekeeping on Codex this week and welcomed suggestions from everyone.

@bph also provided an update beforehand on Digital check in 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 Documentation (BEE-docs). Birgit requested that the BEE-docs team members leave comments on that post. (async to the meeting)

Docs Videos

@milana_cap fully recorded a contributing video and forgot to silent nearby devices and as a result there were a lot of background noises in the recording. Eventually had to delete it and she’ll attempt to re-record it. (async to the meeting)

External Linking Policy

@milana_cap reported prior to the meeting that the team started with the Plugin Developer Handbook for the discussion on External Linking Policy. @themiked outlined two phases. Please let Milana know if help is needed with this. We want to make the entire process transparent and publish on our blog. It’ll also help with defining the workflow for the other parts of #docs.

@themiked also reported that the goal is to compile a list of all the links on all the pages in the 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 guide and start with that, hopefully deleting them all and then adding back the ones on the approved domain list (asynch to the meeting).

New Member Mentoring Team

Due to everyone’s commitments, the Mentoring Team isn’t being able to properly focus on the Mentoring process for the past few weeks. The team is looking for new people to join over Making WordPress #docs team.

Please contact @sukafia, @softservenet, @tacitonic or @Prubhtej_9 with your ideas, suggestions and comments (if any).

Monthly Coffee Break Reminder (September 2020)

@sukafia provided the team with the schedule for the Monthly Coffee Break for September 2020.

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.” @sukafia or @chaion07 if you require further assistance.

Google Season of Docs

@tacitonic reported:

  • Working Repository has been transferred to the WordPress organization on 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/.
  • Almost done with the first section. You can read more about it here: https://github.com/WordPress/WordPress-Documentation-Style-Guide/tree/master/docs/2-document-guidelines (Overall status: one week ahead of schedule).
  • Waiting for a confirmation from the #docs team for a suitable location for the Style Guide on 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/ for a request that was made on the 15th of September

@dianamivelli reported:

  • Been reading HelpHub topics, making sure the titles are applicable, and suggesting new titles for some.
  • Raised the topic of identifying a consistent title style such as action+object for the title, when possible.
  • Further discussion is being done on a private Slack channel consisting folks from the #docs team that @estelaris had opened.

@estelaris added:

  • The Slack group includes both Technical Writers and all four mentors to discuss any topic that relates to both projects, as we will coincide in certain points and it is good to agree on the best approaches.
  • The big topic discussed this week was ‘Article Titles’. Removing Gerunds and adding an action+object title.
  • Also discussed the use of one-word titles.

The Technical Writers will be following the Handbook Grammar Guide as always. Thanks to @atachibana for sharing the link.

Open Floor

@bobbingwide asked if WordPress documentation could be kept up to date with the latest release? @estelaris answered that it would be really nice and the team is working hard to reach that goal. But since we had to migrate the articles from one site to another, we are taking the time to also update those articles. Another team is working on a new design for the pages. The Google Season of Docs Team is working on a new writing style guide and a new classification to implement a new navigation to documentation. There is also the Release Team who is working on adding documentation on the new releases. Not to mention the typos, broken links, small updates, etc that need constant upkeep.  With too many moving parts the team is working very hard and will reach our goal of having up-to-date, easy to find documentation soon.

@bobbingwide further asked, How committed is the Release Team to delivering the documentation for the new release concurrently with the new release? @joyously advised this question to be addressed in the Dev Chat and the editor in particular should be documented before being incorporated into coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress..

@bobbingwide also asked on the point of view of the docs team? @estelaris replied saying that the Release Team is very committed particularly to work on that and documentation needs to be ready before the public release.@mkaz added by saying there shouldn’t be a #docs team, that function should be a part of every feature development and those features shouldn’t be merged/released without documentation. @estelaris also shared the link to the 2020 WordPress Release Squad and another link to the WordPress 5.6 Release Planning @makz added by saying that it should be more integrated into the development of the features- if something doesn’t get merged without documentation, then you wouldn’t need a documentation squad for the release, by default it would be there.@justinahinon added async to the meeting by saying that one of the roles of the Release Documentation Team is to ensure that new things that come in the release receive proper documentation. So approximately 90% (estimation), new stuff in a release are documented by the date of the release. @estelaris invited @bobbingwide to attend the Dev Chats in the #core channel on Wednesdays at 8 PM UTC. @themiked added by saying that this may not be a priority for the Dev Team as there should be a docs representative for every release.

@tomjn asked if there is a document for how to contribute to docs that has all the things? @estelaris shared a link to the Docs Handbook. @mkaz also shared a link to the Block Editor Handbook. @jouisly suggested that the Handbook should be easier to discover.

@milana_cap suggested that we should make a list of the musicians in our team. She also shared her list and requested others who can play an instrument or into music to comment in this post.

#meeting-notes, #meetings