Tim O'Haver 1:42 am on June 11, 2020
Tags: ,   

Summary for Docs Team Meeting: 8 June 2020

Attendance

@atachibana @bph @chaion07 @cguntur @collinsmbaka @estelaris @Femy @ibdz @kmeze @MakeWebBetter @manthanadmane @marcio-zebedeu @mkaz @Prubhtej @rbest @Ruchit @Sunday @tacitonic @timohaver @tomf
(20 people attending) 

Agenda

For reference, you may view the meeting agenda post for 6-8-20.

Note-taker: @timohaver

Notes Reviewed by: @collinsmbaka

Facilitator: @chaion07

Facilitator for Next Meeting: @collinsmbaka

Follow the docs team meeting on the WordPress.org Slack workspace by joining the # docs channel.

Project Updates

@atachibana expressed thanks to all WCEU contributors, reporting more progress for the re-routing of Codex to Code Reference for Functions: now 987 of 1070 (92.2%) complete. 

@bph extended a welcome to all new contributors to 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. Following a strong response from WCEU 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/., she is still catching up to reviewing new work. Half the work on the new contributor list has been published. The team also added more editors to make updates and correct errors. Going forward, she is transitioning team communication to the #meta-helphub channel.

@mkaz is seeking feedback for a draft version of the Create a Block tutorial in 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/ developer documentation.

Categorization Project, Alterations Workflow, User Stories

@estelaris will write a 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 on current journey mapping on documentation. 

New Member Mentor Training

@Sunday plans to resume new contributor sessions next week, after a two week pause due to WCEU. @tomf reports that the mentoring team has been noting all the new docs team arrivals and has plans to reach out.

WCEU Contributor Day Wrap Up

This will come from @zzap who was not available for this week’s meeting. 

Monthly Coffee Breaks/Zoom sessions

@chaion07 asked everyone to participate in @Sunday‘s Doodle (online poll) to help determine the best prospective meeting times. @tomf suggested that perhaps the meeting time should alternate monthly, if there isn’t a time that is practical for everyone.

Open Floor 

Based on recent reporting about Instagram, @bph raised a copyright concern relating to the use of embed blocks. She asked for feedback for adding a general disclaimer to embed blocks’ documentation.

Please feel welcome to suggest meeting notes 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.

#meetings, #summary

Ahmed Chaion 7:53 am on June 8, 2020
Tags: ,   

Agenda for Docs Team Meeting June 08, 2020

The next meeting is scheduled with the following details:

When: Monday, June 8, 2020, 15:00 UTC

Where: #docs channel on Slack.

Meeting Agenda

  1. Attendance
  2. Note-taker & Facilitator selection (for Next Meeting)
  3. Project Updates
  4. Categorization Project, Alterations Workflow, User Stories
  5. New Member Mentor Training
  6. WCEU 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/. Wrap Up
  7. Monthly Coffee Breaks/Zoom sessions
  8. Open Floor

“Good code is its own best documentation. As you’re about to add a comment, ask yourself, ‘How can I improve the code so that this comment isn’t needed?’ Improve the code and then document it to make it even clearer.” 

~ Steve McConnell

#agenda, #meetings

leogermani 12:56 pm on June 4, 2020  

Welcome post to the Code Reference

Hi! Welcome to the WCEU 2020 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/.!

So you’re interested in contribute to the Developer documentation? That’s great! We definitely need help!

This post is a quick introduction on how to contribute to the code reference.

First, read this

If you haven’t done it already, check this page so you can the basics of what we do and get started setting up the basic accounts and tools you need: New Contributos on a Contributor day. This page is a MUST READ.

Now, let’s do it!

Open these tabs

These are two links you will always have opened in your browser:

  • Editing Code Reference – This page has the general guidelines to editing the articles and also have detailed instructions on how to redirect articles from Codex to DevHub
  • Migration spreadsheet – This is the spreadsheet where we keep track of all the functions, classes and 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. that need to be migrated. Here’s where you will pick stuff to work on most of the time.

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. process

After choosing a function/hook to work on, we will:

  • check if all the information that is in codex is already in devHub
  • If it’s not, add it to DevHub (at this point you will need access to edit devHub pages)
  • Once everything is in place, we can retire the page on codex and redirect it to devHub

The structure of an article

The documentation for code reference, including hooks, are separated in 3 parts:

#1 Inline Docs

This is the hook/function name, the parameters it accepts, the value it returns, etc. This is parsed from the source code. If we spot errors there (or room for improvement) we have to open a tracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. ticket and submit a patch to the WordPress coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. (instructions here https://make.wordpress.org/docs/handbook/code-reference/inline-documentation/#how-to-open-new-document-ticket)

#2 More Information (aka Explanation)

This is a room for some additional text to explain what the hook is for and how to use it. This is edited via the DevHub admin panel. Many hooks/functions don’t need this, because they are very simple and the explanation in the Inline docs are enough. We can have one or few examples here if it’s really necessary (often it is), but we are favoring leaving the examples for the User Contributed Notes.

For more complex functions, this section might be broken in several subsections. Feel free to add headings (H3 or lower) to the the content and it will be automatically added to the Table of Contents of the article.

This section is not mandatory. Some very simple functions/hooks might not need this. Just the inline docs and an example in the comments might be enough.

#3 User Contributed Notes (aka comments)

this is a space open for contributions. Anyone can leave a comment with examples. There are some of us in the team who moderate it so we only get good examples there. When moving from codex to devHub, we often move the examples to this section, just adding a note that this was migrated from codex)

Editing

  1. Choose the article you want to work on
  2. Put your name on the spreadsheet so people know you’re working on it
  3. Check the page on codex and on DevHub and make sure all the information in codex is present in the new page on DevHub. See the previous section on the article structure to decide where each part of the content should be moved to
  4. Once you think it’s ready ask a friend to review it
  5. Looks good? Redirect the article in codex, so it points to the new DevHub page

Things to keep in mind:

  • There must be at least one example, either in the More Information section or in the Comments
  • You don’t have to copy everything as it is. You can improve things if you like
  • Codex is not the source of absolute truth. There are outdated information and even wrong information. Please check!
  • When writing code examples, please follow the Coding Standards

Nice, where should I start?

I’ve selected some easy and advanced hooks/functions here to help you get started:

https://docs.google.com/spreadsheets/d/1MOs9x-wdD6QnFY8VoNOnWwazGPkhuwZy_jCK_5fBYds/edit#gid=0

But feel free to navigate the Migration Code Reference spreadsheet and choose anything that is not migrated yet!

Collins Mbaka 2:28 pm on June 3, 2020
Tags: ,   

Summary for Docs Team Meeting: 1 June 2020

Attendance

@makewebbetter @atachibana @milana_cap @chaion07 @bph @ibdz @collinsmbaka @estelaris @timohaver @kenshino @prubhtej @tacitonic @leslie @kartiks16 @newyorkerlaura @sukafia @WPZA @ataurr @manthanadmane @thisisyeasin @audrasjb @mkaz @chetansatasiya @sovstack @tomf @kulsumsiddique @themiked @leogermani @sasiddiqui

Agenda

You can find the Agenda here.

Notetaker: @collinsmbaka

Notes Reviewed by @makewebbetter

Facilitator: @makewebbetter

Facilitator for Next Meeting: @chaion07

Follow the meeting on the Slack channel for Docs

Project Updates

@bph reported that completed tasks from contributors will be published this week. She also urged the contributors to switch over to the experience contributors worksheet and look at the tasks there. She also reported that for contributors day, there will be +/- 16 new contributor tasks and 15 experienced tasks for the 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.

@themiked reported that 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 conversion and editing continues.

@sukafia reported 61 new members joined for the month.

WCEU Online Contributors Day

@milana_cap shared a list of facilitators for Contributors Day

  • @leogermani  for DevHub (developer docs)
  • @Sukafia  for onboarding and everything regarding new contributors
  • @bph for block editor end user docs
  • @atachibana for HelpHub (general end-user docs) as long as his time zone allows (Japan)

She also shared the schedule for Contributors Day

Schedule

New Member Mentor Training

@sukafia reported that Office hour was held on 28 May 2020 for new contributors and members interested in being part of contributors day. Also that 61 new members joined for May and 75 for April and March.

He also reported that they have engaged (Messaged) everyone that joined during the month of May.

External Linking Policy

@milana_cap reported that a decision has been made, and external links from trusted sources will be allowed. She also mentioned that work needs to be done on logistics and criteria of what is a trusted source.

Monthly Coffee Breaks/Zoom sessions

@sukafia shared a doodle link for everyone to vote on the date and time they find convenient for the monthly coffee breaks, encouraging more members to vote.

User Feedback: Poll on Meeting Time & Day for Docs Team

@makewebbetter mentioned as regards the poll, the majority of the responses are yes. So the meeting time will remain the same.

Open floor

@sukafia mentioned that if you’re new to the team and don’t know where to get started. The mentorship team (@sukafia, @tacitonic, @prubhtej, @tomf, @netpassprodsr) are always available to guide. @makewebbetter also mentioned that he is also available for help over 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/..

Please feel free to suggest any changes to the meeting notes by mentioning in comments!

#meetings, #summary

MakeWebBetter 6:08 am on May 30, 2020
Tags: ,   

Agenda for Docs Team Meeting June 1, 2020

Agenda for Docs Team Meeting June 1, 2020

When: Monday, June 1 2020, 15:00 UTC

Where: #docs channel on Slack.

Meeting Agenda

The training is nothing! The will is everything! The will to act.

– Henri Ducard in Batman Begins

#agenda, #meetings

Collins Mbaka 1:25 pm on May 27, 2020
Tags: ,   

Summary for Docs Team Meeting: 25 May 2020

Attendance

@makewebbetter @atachibana @milana_cap @chaion07 @bph @ibdz @collinsmbaka @nobnob @estelaris @crstauf @timohaver @immeet94 @kenshino @prubhtej @tacitonic @leslie @kartiks16 @pratikchauhan @cristianozanca @kulsumsiddique @newyorkerlaura @sukafia

Agenda

You can find the Agenda here.

Notetaker: @collinsmbaka

Notes Reviewed by: @makewebbetter

Facilitated by: @chaion07

Facilitator for Next Meeting: @makewebbetter

Follow the meeting on the Slack channel for Docs

Projects Updates

@atachibana reported that the re-routing of the Codex page to Code Reference functions, 959 out of 1064 (89.7%) have been completed and the remaining functions are associated with tickets or comments and are awaiting approval.

He thanked @collinsmbaka and @stevenlinx for their contributions.

@bph reported that they have 7 contributors working on 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, @makewebbetter @tacitonic @cguntur have submitted pages awaiting review.

While @dschargel @leslie @jackF @newyorkerlaura are working on the blocks they claimed.

WCEU Online Contributors Day

@milana_cap emphasized that all team reps should create lists with easy and not so easy actionable tasks for WCEU 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/.. @bph reported that she is working on a list of not so easy actionable tasks this week.

New Member Mentor Training

@sukafia reported that they will be taking advantage of WCEU Contributors Day to help onboard new members. He also announced that there will be office hours on Thursday 28th May at 15:00 – 16:00 UTC and encouraged all new members to join in so they can get the necessary guidance. 

@sukafia also called for new volunteers for the mentorship team, as they will be needing extra hands.

External Linking Policy

@milana_cap reported that they have decided to make a whitelist of allowed external resources and that a decision on what would be considered trusted and how to deal with existing links (and try to avoid removing them manually) is not yet made.

@milana_cap mentioned that applying the whitelist should be automated. She also mentioned that she will create a p2 post for everyone to share their opinions and questions as comments.

Monthly Coffee Breaks/Zoom sessions

@sukafia shared a doodle link for everyone to vote on the date and time they find convenient for the monthly coffee breaks.

Open floor

@kenshino suggested that there should be a check to see if the current meeting time is the best meeting time for the most number of people.

After deliberations and suggestions from team members, @kenshino concluded that it is best to ask if the current meeting time is convenient for most people and that someone should write a p2 post asking “If the current time is convenient or not” @chaion07 volunteered to work on that.

@kenshino also mentioned that many mentors including himself are receiving lots of messages from Technical Writers and that it will be more beneficial if all queries being answered in one place. So for this, he requested that please all Technical Writers should put all queries either on Season of Docs: Technical Writer Exploration or here in #docs

Please feel free to suggest any changes to the meeting notes by mentioning in comments!

#meetings, #summary

Ahmed Chaion 3:55 pm on May 26, 2020  

Meeting Time and Day for WP.Org Global Docs Team

The Make WordPress Teams have a defined structure and a set of procedures. The Meeting plays a vital role in the operation of the individual Make WordPress Teams. These Meetings are scheduled well ahead and has gone through a lot of thinking and consideration before being announced and put on the Official Meeting Calendar. The sole objective of maintaining the Meeting Calendar is not to have meeting times happen simultaneously and creating scope for individual contributors to attend multiple meetings if they want to.

The Weekly Meeting takes place each Mondays at 15:00 UTC. Recently during an Weekly Meeting @kenshino the Official Team RepTeam Rep A Team Rep is a person who represents the Make WordPress team to the rest of the project, make sure issues are raised and addressed as needed, and coordinates cross-team efforts. for Docs posed the question

“The current schedule for the Weekly Meeting- Is it convenient or not.”

On that thought we request each and every member of the Docs Team to please respond to following poll options:

  1. Yes
  2. No (Please add suggestions for a better timing)

Please comment below with your response. Very important for us to remember that you need to add a suggestion in the comment below.

Thank you!

Ahmed Chaion 11:37 am on May 25, 2020
Tags: ,   

Agenda for Docs Team Meeting May 25, 2020

The next meeting is scheduled with the following details:

When: Monday, May 25, 2020, 15:00 UTC

Where: #docs channel on Slack.

Meeting Agenda

  1. Attendance
  2. Note-taker & Facilitator selection for Next Meeting
  3. Project Updates
  4. Categorization Project, Alterations Workflow, User Stories
  5. WCEU Online Contributors Day
  6. New Member Mentor Training
  7. External Linking Policy
  8. Monthly Coffee Breaks/Zoom sessions
  9. Open Floor.

“Good code is its own best documentation.”

~ Steve McConnell

#agenda, #meetings

#agenda, #meetings

Timi Wahalahti 6:43 pm on May 21, 2020
Tags: ,   

X-post: WCEU 2020 Online Contributor Day: All that team facilitators and experienced Contributors need to know

X-post from +make.wordpress.org/updates: WCEU 2020 Online Contributor Day: All that team facilitators and experienced Contributors need to know

Birgit Pauli-Haack 8:37 pm on May 20, 2020
Tags: ,   

X-post: Ways to keep up with Full Site Editing (FSE)

X-comment from +make.wordpress.org/core: Comment on Ways to keep up with Full Site Editing (FSE)