Summary of Docs Team Meeting April 19, 2022

Housekeeping

Review of the design for documentation 

The design team has reviewed the design. We are waiting on Josepha’s approval. The mobile version is not ready yet as there are a few items to be resolved. 

  • We now have 4 categories for the content and a submenu with the 4 categories, displayed at the top so users can easily navigate. 
  • The breadcrumbs are included as part of the left navigation (the blue square on the top left). The first 3 lines are the breadcrumbs, followed by the headings in the article. We also have another option (on the 3rd article example) where the breadcrumbs are horizontal, at the top of the TOC 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..

Please add your comments here or in the slack channel.

Discussion 1: @femkreations: How are we handling the Changelog section since some of the Changelog entries are long?

@milana_cap: suggests not to delete the Changelog as it’s a history of the WP docs.
@bph: The Changelog is also used for translation and some locales might be behind on the pages.
@ibdz: We can have 2 different font sizes- one for the parent <li> (date) and one for secondary level <li> (content) to keep it aesthetically pleasing.

It was decided to add pagination to the Changelog. It is accessible and we can limit the number of entries per page, keeping the newest entries on page one and the oldest on page 2.

Discussion 2: @milana_cap: Would the definition list be semantic markup for the Changelog?

 @mburridge suggests the details disclosure element

Discussion 3: @estelaris: What about the FAQs that are on some of the block articles? Are we going to keep them there or can we extract them and create a new FAQs section under resources?

@milana_cap: Thinks all FAQs should be in FAQs and articles that currently have them could link to them.
@atachibana: Suggests keeping it as is, to reduce the cost, and also create independent pages of the FAQ.
@ibdz: Thinks from the user’s point of view, it’s good to have the FAQ attached to the page.

Project updates

@milana_cap:

  • Closed a few more 5.9 block editor end-user issues.
  • All tracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. tickets are labeled for docs and GitHub project is ready.
  • We have a new channel #docs-firehose for getting 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/ updates so that we keep the #docs channel clean

@femkreations:

  • Triaging the Google Doc and creating the Tracker issues for 6.0 end-user documentation.
  • So far, 40 trackers have been added for 6.0 End User Documentation.
  • Will complete the triage by the end of the week.

@estelaris:

All the block editor articles listed in the inventory have been added to the new sitemap.

Open floor

@estelaris and @femkreations to review the following two pages: Block Editor and WordPress Editor to make sure they are not repetitive and if so, merge and delete one. @atachibana: Suggests renaming WordPress Editor to Classic Editor and keeping with TinyMCE.

@milana_cap gave a talk about Docs at WordCampWordCamp WordCamps are casual, locally-organized conferences covering everything related to WordPress. They're one of the places where the WordPress community comes together to teach one another what they’ve learned throughout the year and share the joy. Learn more. Athens in person.

@milana_cap to lead the Docs table at the Contributor DayContributor Day Contributor Days are standalone days, frequently held before or after WordCamps but they can also happen at any time. They are events where people get together to work on various areas of https://make.wordpress.org/ There are many teams that people can participate in, each with a different focus. https://2017.us.wordcamp.org/contributor-day/ https://make.wordpress.org/support/handbook/getting-started/getting-started-at-a-contributor-day/. for WCEU.

#meeting

Agenda for Docs Team Meeting 23 November 2021

Our next Team meeting is scheduled with the following details:

When: Tuesday, November 23, 2021, 14:00 UTC

Where: #docs channel on Slack.

Meeting Agenda

  1. Attendance
  2. Note-taker & Facilitator selection for Next Meeting
  3. Project Updates
  4. Revision of Projects that have been put on hold
  5. Open Floor

#agenda, #meeting, #meeting-agenda

Agenda for Docs Team Meeting April 26, 2021

The next meeting is scheduled with the following details:

When: Monday, April 26, 2021, 14:00 UTC

Where: #docs channel on Slack.

Meeting Agenda:

  1. Project Updates
  2. New Member Mentoring
  3. Unified Doc License
  4. Author Attribution to docs
  5. Discussion: Process gap between dev notes release stage and docs team writing about a feature
  6. ‘Meeting Day’ Adjustment
  7. April 2021 Coffee Break
  8. Open Floor

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

Thank you!

#agenda, #meeting, #meeting-agenda

Agenda for Docs Team Meeting December 14, 2020

The next meeting is scheduled with the following details:

When: Monday, December 14, 2020, 15:00 UTC

Where: #docs channel on Slack.

Meeting Agenda

  1. Project Updates
  2. Meeting Times & Holiday Planning Announcement
  3. New Member Mentoring
  4. Monthly Coffee Break December 2020
  5. Google Season of Docs 2020
  6. Discussion: Clarification about the use of GPLGPL GPL is an acronym for GNU Public License. It is the standard license WordPress uses for Open Source licensing https://wordpress.org/about/license/. The GPL is a ‘copyleft’ license https://www.gnu.org/licenses/copyleft.en.html. This means that derivative work can only be distributed under the same license terms. This is in distinction to permissive free software licenses, of which the BSD license and the MIT License are widely used examples. by WordPress plugins and themes
  7. Open Floor

#agenda, #meeting

Docs Team Coffee Break November Update!

Hello Folks,

As we inch closer to a second wave of COVID, it has become more important than ever to stand next to our fellow contributors. The idea of having a monthly informal discussion in the form of a ‘Virtual Coffee Break’ experience is something we are finding rather helpful while trying to maintain proper social distancing. Even though we would hope for majority of our fellow contributors to join in and support the same concept it may not always be the case. Understanding this, the team came up with the idea of rotation in the timing to serve multiple time zones. Additionally, we expect to write a dedicated p2 post with the information covering the Docs Team Coffee Break.

October Coffee Break Summary

Coffee Break began with a smile!

The October Coffee Break took place on the 29th instant with a EU-friendly timing which saw the presence of 7 contributors from the Global Documentation Team. Kudos to @sukafia for facilitating it. @chaion07 @crs1138, @tacitonic & @thisisyeasin were among the ones who joined in.

November Coffee Break Reminder

The next Coffee Break for Docs Team is scheduled for 19 November, Thursday at 10 AM UTC. @estelaris will be facilitating this month’s Coffee Break. The details for joining the Zoom call are as follows:

The details will also be posted in #docs channel on the day. If you wish to get a calendar invite then 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.” @estelaris, @sukafia or @chaion07.

#coffee-break, #meeting

Agenda for Docs Team Meeting October 12, 2020

The next meeting is scheduled with the following details:

When: Monday, October 12, 2020, 15:00 UTC

Where: #docs channel on Slack.

Meeting Agenda

  1. Project Updates
  2. External Linking Policy
  3. Docs Videos
  4. Q3 Update
  5. New Member Mentoring
  6. Monthly Coffee Break Reminder (October 2020)
  7. Google Season of Docs 2020
  8. Meeting Times
  9. Open Floor

#agenda, #meeting

Summary for Docs Team Meeting: October 5, 2020

Facilitator of the meeting : @justinahinon

Attendance

@justinahinon @crstauf @chaion07 @ibdz @atachibana @bph @tacitonic @softservenet @sukafia @diana @cbringmann @estelaris @collinsmbaka @themiked @kulsumsiddique

Agenda

You can find the Agenda here.

Notetaker: @kulsumsiddique

Notes Reviewed by: @collinsmbakaand @tacitonic

Facilitator for Next Meeting: @chaion07

Follow the meeting on the Slack channel for Docs

Project Updates

@atachibana: We are migrating and re-routing Codex to Code Reference, and processed:
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.: 62 of 355 (17.5% < – 14.4%) by @stevenlinx and @collinsmbaka .
He also did some housekeeping of Classes references.

External Linking Policy

Update from @themiked, here are the points that will need to be addressed regarding external linking policy

  • list all 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 handbook external links
  • define safe 5-10 links
  • remove the rest
Docs videos

@zzap shared earlier today the progress on “How-To” videos with a new one that has been recorded. @milana_cap finally recorded and uploaded contributing “how to” video for setting up local HelpHub instance. She have also added all the commands and URLs below video for easy copy/paste.

New Member Mentor Training

The Docs new-member Mentorship Team invites six newest member in the team.

Monthly Coffee Break

@sukafia is planning for a coffee break on Thursday 29th October 2020 in the European time zone and the meeting will be scheduled at zoom.

Google Season of Docs 2020

@tacitonic has shared the following update;

Update from @dianamivelli;

  • I noted more recommendations for Help Hub topics to reflect new topic title format (action+object)
  • Reached out to @tacitonic on #docs team to find out the correct Help Hub topic title capitalization style (sentence case vs. title case) @tacitonic, thanks for the speedy response :blush:
  • Contacted @estelaris and @timohaver to verify next steps are inline with project plan.
  • Added weekly status section 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/ repository to keep notes on weekly progress.
  • Added our project master doc to GitGit Git is a free and open source distributed version control system designed to handle everything from small to very large projects with speed and efficiency. Git is easy to learn and has a tiny footprint with lightning fast performance. Most modern plugin and theme development is being done with this version control system. https://git-scm.com/. (still learning how to use Git effectively)
Open Floor

@estelaris suggested that Possessive should be WordPress’. All words ending in s will only have an ‘ at the end. @tacitonic and @dianamivelli agreed to it.

#docs, #meeting, #meeting-notes, #notes

Agenda for Docs Team Meeting October 05, 2020

The next meeting is scheduled with the following details:

When: Monday, October 05, 2020, 15:00 UTC

Where: #docs channel 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/..

Meeting agenda

  1. Project Updates
  2. External Linking Policy
  3. Docs Videos
  4. New Member Mentoring
  5. Monthly Coffee Break Update (October 2020)
  6. Google Season of Docs 2020
  7. Open Floor

#agenda, #meeting

Summary for Docs Team Meeting: August 17, 2020

Attendance

@wpza @tacitonic @sumand @timohaver @milana_cap @b-07 @kulsumsiddique @atachibana @tomf @prubhtej_9 @sukafia @kafleg @kenshino @bizanimesh @bph @tomjn @farhadul Islam @collinsmbaka @ibdz @chalon07 @crstauf @leslie @justinahinon @cguntur @themlked @estelaris @cbringmann

Agenda

You can find the Agenda here.

Notetaker: @kulsumsiddique

Notes Reviewed by: @collinsmbaka and @tacitonic

Facilitator: @tacitonic

Facilitator for Next Meeting: @chaion07

Follow the meeting on the Slack channel for Docs

Project Updates

@atachibana: Joined Class & Hook migrationMigration Moving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. & rerouting project lead by @leogermani. Classes: 8 of 43 (14.0% <- 4.7%) & 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.: 17 of 355 (4.8% <- 4.5%)

@bph:

Update on docs

  • we are making headway in updating pages to 5.5
  • had a short 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. training todoy in our meeting, and answered a few questions
  • Haven’t consolidated all spreadsheets yet, will do so this week
  • Tried to get PRs from the 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/ 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/ repository labeled “UserDocumentation” into the #meta-helphub channel so we can be aware and add them to our trello cards

@justinahinon: Posted the proposal on the team p2 last week for a new better structured Gutenberg developer documentation.

External Linking Policy

@milana_cap saw new comments in the doc but didn’t have any time to answer and include them in the proposal. @kenshino suggested having a zoom call on this. @milana_cap has a concern for hosting the videos for review, @estelaris suggested hosting in G drive

New Member Mentor Training

@tacitonic said that 8 People have joined #docs in the past week and a total of 11 people have joined #docs in the month of August. There were limited response the past week from new members after @tacitonic reached out to them personally.

Monthly Coffee Break

@sukafia have scheduled the next Coffee Break on Aug 27, 2020 01:00 PM Universal Time UTC.

Zoom Link : https://us02web.zoom.us/j/81398073676?pwd=aWE1NmZ1NUxhV2hmWDhRMXZTNnRqZz09

Google Season of Docs 2020

Two people got selected @tacitonic and @diana Mivelli. Two mentors will get allocated at the following projects

  • Improve Article Discoverability in WordPress HelpHub Documentation
  • A Full and Renewed Set of Documentation Style Guide

@timohaver and @diana Mivelli will work on Article Discoverability. @estelaris thinks that both the projects will get merged at some point. As a style guide @estelaris will contribute to article discoverability, so we should be able to all work together in both projects

Open Floor

@tomf raised a query regarding WordCamps are not funding any kind of multi-day events (even digital ones) and no longer funding any swag too.

@wpza proposed to remove the WordPress branding + using your own Dashboard styles. Which is when you go to Users > Edit (single user) > Select a theme, a chance for WP devs to upload their own theme for toolbar colours, branding, etc.

Please feel welcome to suggest revisionsRevisions The WordPress revisions system stores a record of each saved draft or published update. The revision system allows you to see what changes were made in each revision by dragging a slider (or using the Next/Previous buttons). The display indicates what has changed in each revision. in the comments.


#docs, #meeting, #meeting-notes, #notes