Season of Docs: Technical Writer Exploration, May 11-June 8

It is with excitement that WordPress is officially participating in Google’s Season of Docs 2020.

From May 11-June 8, technical writers are welcome to review the proposed list of project ideas and ask questions related to proposal development. Mentors, thank you for being on hand to help think through project proposals related to our initial ideas or ones the writers may devise. Technical writer applications are due July 9th; We look forward to working with you!

What’s next?

Technical writers interested in working on one of our project ideas, please add your questions as a comment to this post.

Season of Docs Project List Idea

Below is a list of projects that are put forward for technical writing collaboration in this year’s Season of Docs.

As of a reminder of who is involved:

Projects

Project One: @kenshino

Project name: A full and renewed set of documentation style guide
Description:
We’ve written some style guides along the way but many of those applied to specific handbooks or projects we worked on.

That said, there is not a unified style guide nor is it actually complete.

We propose developing a new style guide while fixing up older ones or simply adopt a great existing one with compatible licenses.

Related material:

Project Two: @makewebbetter

Project Name: Most Popular Security Attacks

Description: There are plenty of security breaches issues reported. We plan to create documentation of some of the most common issues with suggested fixes so that users can learn and solve their issues.

Related material:

  • Link to the open sourceOpen Source Open Source denotes software for which the original source code is made freely available and may be redistributed and modified. Open Source **must be** delivered via a licensing model, see GPL. project that needs documentation – https://wordpress.org/support/article
  • Update existing documentation – https://wordpress.org/support/article/brute-force-attacks/
  • We can have documentation with two to three attacks issues, explain what effect they have on websites, how to prevent, and the fastest way to fix and protect your website.

Project Three: @kenshino

Project name: Tracking Doc Suggestions / Updates
Description: We do not have a unified tracking system for when a doc needs updates. People do it on MetaMeta Meta is a term that refers to the inside workings of a group. For us, this is the team that works on internal WordPress sites like WordCamp Central and Make WordPress. TracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. (which is really for code changes to 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/), report them 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/., and sometimes via Twitter. It’s impossible for people to know if a doc is going through updates or is simply outdated. Some projects use 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. for short term purposes. Some projects use 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/.

We really ought to have a unified tracking system so that we can track these requests and the work to fulfill such requests. And we need to create a process to utilize this system properly.

Related material: 
None at the moment. It’s new!

Project Four: @johnzenith

Project Name: WordPress Development Configuration Guide

Description: Code misconfiguration and setup can introduce security bridges and break security endpoints, thereby leaving the door open for malware infections and cryptographic attacks.
Creating a configuration guide or overview for developing in WordPress will be very useful. Some of these exist but are not organized or put together in a single place. For example, the configuration Guide will have several sections as files and directories, debugging, nonces, database, WordPress salt, constants, queries, global vars, htaccess, password, httpsHTTPS HTTPS is an acronym for Hyper Text Transfer Protocol Secure. HTTPS is the secure version of HTTP, the protocol over which data is sent between your browser and the website that you are connected to. The 'S' at the end of HTTPS stands for 'Secure'. It means all communications between your browser and the website are encrypted. This is especially helpful for protecting sensitive data like banking information., etc.

Related Material

Project Five: @asif2bd

Project Name: Curate Existing HelpHub Article To Create Pillar Contents
Description
: We are continuously creating more content in HelpHub, but basic questions like “Locally Host WordPress” or “How To Secure WordPress”, are answered with separate CPT and not one article to answer completely or links to existing content. While the current configuration is good for SEO, it is confusing for our users.
Related material:

  • Link to the open source project that needs documentation: https://wordpress.org/support/
  • I am proposing ‘Pillar Content” that will be curated collection of existing content that will direct guide users in finding more authenticated information. Like “How To Secure WordPress” will give precise guideline and will link and resources from following contents

Include links to similar documentation in other projects:

Project Six: @kenshino

Project name: Improve Existing Development Documentation and Handbooks
Description:
 We have a lot of developer documentation. CoreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress.’s documentation is mostly automated.

However handbooks that describe how one would create a theme, make a 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, use the REST APIREST API The REST API is an acronym for the RESTful Application Program Interface (API) that uses HTTP requests to GET, PUT, POST and DELETE data. It is how the front end of an application (think “phone app” or “website”) can communicate with the data store (think “database” or “file system”) https://developer.wordpress.org/rest-api/. or automate things via the CLICLI Command Line Interface. Terminal (Bash) in Mac, Command Prompt in Windows, or WP-CLI for WordPress. do not receive updated documentation. In turn, this requires that all handbook maintainers know all the changes in each core releaseRelease A release is the distribution of the final version of an application. A software release may be either public or private and generally constitutes the initial or new generation of a new or upgraded application. A release is preceded by the distribution of alpha and then beta versions of the software. to be able to write something useful.

In some cases, the handbooks are updated but don’t provide enough examples for new developers to get started. We would like to close these gaps.

Related material:

Project Seven: @estelaris

Project Name: Improving article discoverability

Description: During the design process, it was discovered that categories are not used to classify documentation articles and an article may have more than two categories instead of using tags to related articles. This makes it difficult for users to search, as they can click on a categoryCategory The 'category' taxonomy lets you group posts / content together that share a common bond. Categories are pre-defined and broad ranging. > article, and hit the return button only to find themselves in an entirely different category. Another issue is the titles which in some cases do not properly describe what the article is about.

Related material:

Project Eight: @milana_cap

Project Name: Extending Block Editor

Description: Documentation on developing on top of Block Editor is, depending on the topic, either scarce, outdated, or non-existent. Considering that Block Editor is a significant language leap for WordPress developers, I think the project itself would benefit from having detailed documentation in a form of guides or tutorials, on how to utilize and extend core functionality and what the best practices are.

Related material:

  • Link to the open source project that needs documentation – https://developer.wordpress.org/block-editor/
  • Updates to an existing documentation set – https://developer.wordpress.org/block-editor/tutorials/
  • Features that need documenting: creating custom blocks (basic webpack setup, what plugins are used and why), using editor’s components in custom blocks, using core blocks in custom blocks, using data stores, using all the 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., block settings, plugin sidebars, RichText format types etc. Really, everything.
  • Link to similar documentation in other projects – https://www.gatsbyjs.org/tutorial/

Project Nine: @marcio-zebedeu

Project Name: Write your first WordPress Theme

Description:
It is not enough to say that creating a WordPress theme is easy if we do not show it in practice in the documentation. Currently we have a good article on how to start with WordPress, I believe we could do more to make the theme development manual better, as it does not provide a kind of tutorial that really ends with the creation of a functional theme.

  • Related Material:
  • Link to the open source project that needs documentation: https://wordpress.org/support/article
  • Updates to existing documentation:
  • https://developer.wordpress.org/themes/getting-started
  • It can be divided into stages: Creating a htmlHTML HTML is an acronym for Hyper Text Markup Language. It is a markup language that is used in the development of web pages and websites. template, adding simple styles, separating those from html files and finally converting to one of the templates for the WordPress theme

Docs team meeting summary for August 3, 2020

Attendance

@tacitonic @sukafia @justinahinon @estelaris @zzap @crstauf @kulsumsiddique @atachibana @thisisyeasin @timohaver @khushbu1983 @lvg2013 @collinsmbaka @wpza @themiked @joyously @casiepa

Meeting agenda: https://make.wordpress.org/docs/2020/08/03/agenda-for-docs-team-meeting-august-3-2020

Meeting transcript 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/.: https://wordpress.slack.com/archives/C02RP4WU5/p1596466811112700

Meeting facilitator: @tacitonic

Notetaker: @justinahinon

Facilitator for the next meeting: @timohaver

Project updates

@atachibana made an update about the re-routing of Codex to Code Reference. 1054 of 1070 Function pages have already been completed. Also, @stevenlinx and @collinsmbaka are working on complexed cases with opened tickets. After it is released, WordPress 5.5 will merge the fixes on documents into the Code Reference.

@tacitonic mentionned that There is no update for the BEEDocs team for this week. This will be discussed in another meeting next monday.

@estelaris shared the progress on the categorization project and if is it chosen or not for Season of Docs. She proposed to include asif2bd’s pillar content proposals as part of the categorization proposal. The reason for that is the content can be included as part as categorization. Also, the marketing team is still giving some feedback on the related p2 post. This could help in having some guidelines in the naming for pillars and categories.

@themiked shared the current Plugins Handbook status. The pages organization proposed can be found here. He also expressed the interest to have a glossary that automatically finds and links terms that should be defined in the handbook.

External Linking Policy

@milana_cap mentionned that the team has now a new approach, that can be found in this document. Everyone is welcomed to add comments and feedbacks. This will be discussed again during the next meeting.

Milana is also requesting a correction in the latest Month of WordPress post as the docs team has not banned the use of commercial links in the documentation articles. This is a discussion that is still happening.

New Member Mentoring

@sukafia shared the new members in Docs team stats. For the month of July, 37 new members joined the #docs channel on Slack. These members were reached out to by the mentorship team. Only one member has already joined the channel for the month of August.

All members are welcomed to contact includes @sukafia, @tacitonic, @tomf and @prubhtej to learn more about the Doc team.

Monthly Coffee Break (August 2020)

@sukafia linked to some nice pics from the last monthly coffee break. You can find them here and here. Many members also mentionned how useful this coffee break was; allowing to learn about people with which we are contributing.

The next Monthly Coffee Break will take place at the end of August, hopefully in Asia friendly time. The team is also open to rotating the time to make it favourable to people in different time zone to attend.

Google Season of Docs 2020

@timohaver said that all the Season of Docs proposals were scored by the mentors last week. The top three proposals have been submitted to Google.

Open Floor

@joyously asked if all the references to Codex URLs have already changed to the new format. She is wondering about links external to the Codex that point to it, because there were a bunch in code and are not elsewhere 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/.

#meeting-notes

Agenda for Docs Team Meeting August 3, 2020

The next meeting is scheduled with the following details:

When: Monday, August 3, 2020, 15:00 UTC

Where: #docs channel on Slack.

Meeting Agenda

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

#agenda, #meetings

Summary for Docs Team Meeting: July 27, 2020

Attendance

@atachibana @marcio-zebedeu @sukafia @milana_cap @chaion07 @bph @ibdz @collinsmbaka @estelaris @crstauf  @themiked @kenshino @prubhtej @tacitonic @lvg2013 @softservenet @b-07 @glorialchemica @khushbu1983 @kafleg @fierevere @mohitmishra @darkog

Agenda

You can find the Agenda here.

Notetaker: @b-07

Notes Reviewed by: @collinsmbaka and @tacitonic

Facilitator: @tacitonic

Facilitator for Next Meeting: @tacitonic

Follow the meeting on the Slack channel for Docs

Project Updates

@atachibana: For re-routing of Codex to Code Reference, 1049 of 1070 (98.0% <- 97.1%) Function pages have been completed.

@stevenlinx & @collinsmbaka are processing complex cases with opened tickets.

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 (BEEDocs):

@collinsmbaka: Published issuu, crowdsignal, and reverbnation blocks & reviewed the 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. board.

@tacitonic: Arranged the task list spreadsheet priority-wise, got in touch with the contributors who have claimed blocks but are not worked upon.

@bph: Started looking at WordPress.comWordPress.com An online implementation of WordPress code that lets you immediately access a new WordPress environment to publish your content. WordPress.com is a private company owned by Automattic that hosts the largest multisite in the world. This is arguably the best place to start blogging if you have never touched WordPress before. https://wordpress.com/ documentation to see what can be ‘harvested’, reviewed contributors documents, in the works and already published, with @atachibana worked on Block Directory documentation, started on a third worksheet in our spreadsheet with WordPress 5.5 and more task listing: BlockPattern, Image Editing, Block Directory.

@khushbu1983: Published articles reviewed by @tacitonic from spreadsheet.

External Linking Policy

@milana_cap reported that she didn’t manage to do anything new on this agenda. But she’ll be sharing Google docs soon with this so we all can comment and join the discussion. She also mentioned that the team is trying to change the strategy because it’s impossible to label websites as “commercial” and “personal” only. So they’ll focus on the license, which has to be compatible with 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. 2+.

New Member Mentor Training

@Prubhtej provided a new member update: 4 new members joined docs last week; docs has added 33 new members for July. @sukafia mentioned that most of the new members joined last week came from other teams to ask specific questions. @softservenett has written a post for the docs channel extension: https://make.wordpress.org/docs/2020/07/20/proposal-for-docs-channel-extension/

Monthly Coffee Break

The July Coffee Break is set for this Thursday (July 30) at 1500 UTC.

Google Season of Docs 2020

@kenshino reported that they’re still evaluating proposals. The deadline for evaluating the proposals is 28th July. 

Open Floor

@bph mentioned that the next Block Editor Enduser documentation team meeting will be on August 10. 

@themiked mentioned that he’s concerned about the way of doing the ‘keep the content promotion free’ part. He also mentioned that defining content and promotion is going to be a challenge and he’s looking forward to seeing the first draft. 

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-notes, #meetings, #notes

Agenda for Docs Team Meeting July 27, 2020

The next meeting is scheduled with the following details:

When: Monday, July 27, 2020, 15:00 UTC

Where: #docs channel on Slack.

Meeting Agenda

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

#agenda, #meetings

Summary of Docs Team Meeting for July 20, 2020

Attendance

@atachibana, @bph, @burhandodhy, @chaion07, @collinsmbaka, @crstauf, @daverick, @deadpool76, @estelaris, @FahimMurshed, @ibdz, @kartiks16, @Kenshino, @Leslie, @manthanadmane, @mkaz, @mohitmishra, @nullbyte, @Prubhtej, @ramiy, @saiftheboss7, @sasiddiqui, @sncoker, @softservenet, @tacitonic, @themiked, @timohaver, @williampatton (28 people attending)

Meeting MetaMeta Meta is a term that refers to the inside workings of a group. For us, this is the team that works on internal WordPress sites like WordCamp Central and Make WordPress.

Meeting Agenda: https://make.wordpress.org/docs/2020/07/20/agenda-for-docs-team-meeting-july-20-2020/

Meeting Transcript: https://wordpress.slack.com/archives/C02RP4WU5/p1595257204344100

Meeting Facilitator: @chaion07

Meeting Notes by: @timohaver

Facilitator for Next Meeting: @tacitonic

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

Project Updates

@atachibana reported that almost all work is complete for the migration and re-routing of Codex to Code Reference for Functions. @stevenlinx and @collinsmbaka are working through the more complex cases that remain. 

@bph itemized the many activities of the Block Editor End-user documentation team (BEE-docs). The team is balancing ongoing work for WordPress 5.4 with preparations for 5.5.

@mkaz published his Create a Block tutorial in the Block Editor Handbook

External Linking Policy

With @milana_cap unavailable, @Kenshino proposed deferring this agenda item to the next meeting. @chaion07 asked everyone to comment on the recent posts relating to this topic

Google Season of Docs 2020

@Kenshino reported that @cbringmann is working with Season of Docs mentors to review GSOD proposals.

New Member Mentor Training

@Prubhtej provided a new member update: seven new members joined docs last week; docs has added 29 new members for July.

@softservenet published a post proposing additional Slack channels for new member engagement.

Monthly Coffee Break

@chaion07 promised there will be a Doodle up soon with APAC-friendly options for choosing a day and time. He estimated that the next Coffee Break will happen in the last week of July.

Open Floor

On behalf of the Marketing team, @nullbyte asked how to go about publishing a FAQ for WordPress 5.5 on HelpHub and DevHub.


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.

#meeting-notes, #meetings, #notes

Proposal for #docs Channel Extension

*this is a cumulative doc/proposal from the Docs Onboard Team

Purpose

To create an area away from the high traffic active postings in the main channel that new and existing Contributors can go for assistance and support. Members can also ask a quick question in the new channel. This would declutter the existing #docs channel from error reports and questions, while distinguishing it exclusively for docs related discussions.

The idea is to is to have a combination of:

-On Demand Lists (ie: /newcontributor-tasks, /specific-itemlinks, /handbook-sections)

 *returns info we setup

—>> using Slackbot for the lists

-Live in Channel Support (General Operating/Convention QA, Orientation Hub)

Naming

Some ideas for possible naming convention:

#docs-help

#docs-support

—————————————

Reason

At this point, we’ve been direct messaging people and working with them one on one to get started, but this would allow us to have a hub to do so, while information supplied to others could also be of benefit as reference.

Presently, we’ve noticed (especially in the case of new contributors), they tend to get overwhelmed and also intimidated by asking for information in the channel.  We’re also duplicating quite a bit of human effort in the case where we have potential solutions to make this process more efficient.

Agenda for Docs Team Meeting July 20, 2020

The next meeting is scheduled with the following details:

When: Monday, July 20, 2020, 15:00 UTC

Where: #docs channel on Slack.

Meeting Agenda

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

Successful people have Successful habits!

Unsuccessful people don’t!

Collected

#agenda, #meetings

Summary for Docs Team Meeting : July 14, 2020

Attendance: @crstauf, @chaion07, @collinsmbaka, @prubhtej, @milana_cap, @atachibana, @timohaver, @glorialchemica, @saiftheboss7, @tacitonic@tomf, @bph, @MakeWebBetter, @cristiano.zanca, @sasiddiqui, @mkaz@theMikeD, @Kenshino, @Manik, @sukafia, @estelaris@manthanadmane, @Rakib, @thisisyeasin, @khushbu1983

Agenda: For reference, you may view the meeting agenda post for 7-13-2020 

Note-taker: @prubhtej

Notes Reviewed by: @chaion07

Facilitator: @tacitonic

Facilitator for Next Meeting: @chaion07

Follow the docs team meeting on the Making WordPress Slack Channel for Documentation

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

@atachibana reported that for 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 Reference for Functions, 1033 of 1070 (96.5% <- 95.5%) pages have been completed. He thanked @stevenlinx for the contribution with open tickets. He also mentioned that we have to wait until version 5.5 releaseRelease A release is the distribution of the final version of an application. A software release may be either public or private and generally constitutes the initial or new generation of a new or upgraded application. A release is preceded by the distribution of alpha and then beta versions of the software. and enhancement of document fixes to Code Reference for 100%.

@makewebbetter offered to volunteer for working on migrating 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..

@bph updated on the Bee-Docs (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):

  • Bee-Docs Meeting Participants: @collinsmbaka @tacitonic @khushbu1983 @manthanadmane @MakeWebBetter  
  • @tacitonic has been reviewing posts with new contributors.
  • We are looking at WordPress.comWordPress.com An online implementation of WordPress code that lets you immediately access a new WordPress environment to publish your content. WordPress.com is a private company owned by Automattic that hosts the largest multisite in the world. This is arguably the best place to start blogging if you have never touched WordPress before. https://wordpress.com/ to fill gaps in 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/ documentation
  • The 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. board finds more usage now that we have more team members on board.
  • @collinsmbaka will connect with the coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress.-editors regarding plans for Hulu and Photobucket embeds blocks, if they are abandoned or if we should file issues for them.
  • WordPress 5.5 is coming fast now. 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/ 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 versions 8.5 and lower will come to core. Including the import button for external images. So we can keep drafting and collaborating on Google Docs and copy/paste for publishing. The button appears on each image block, and just needs click to get the image into the media library of wordpress.org
  • Also shared the betaBeta A pre-release of software that is given out to a large group of users to trial under real conditions. Beta versions have gone through alpha testing in-house and are generally fairly close in look, feel and function to the final product; however, design changes often occur as part of the process.-tester plugin with the team in case they want to do some peek preview. We’ll keep and eye out for the denotes, too.
  • good news/bad news: We ran out of tasks for new contributors:
  • Homework for next week for all:  thinking about new tasks for  new contributors early wins. 


The Bee-Docs team meets each Monday at 14:00 UTC in the #meta-helphub channel over Slack.

@Prubhtej_9 reported that he completed the Scribd block editor documentation earlier that week & thanked @tacitonic for reviewing the doc.

@christiano.zanca reported that @glorialchemica started testing italian helphub translation. The Italian Team is providing support to this ticket to onboard more contributors.

Categorization Project

@estelaris reminded that we can still leave comments on the p2 post and this agenda item will be on hold until the finalization of Technical Writers for this project on the Season of Docs.

@bph suggested that we might need to review how block editor end user documentation is presented. It’s kind of buried, and probably needs a separate entrance and TOC.

External Linking Policy

We’ve witnessed vivid discussion on this agenda item.

@milana_cap proposed the following:

  • Anyone with a WordPress.org username can propose the link (as equivalent to anyone with a WordPress.org account can edit Codex). We could have a Google form or airtable or something similar. They need to fill out following fields (all mandatory):
  • External link
  • Placement link at wp.org (where this external link should be added to)
  • Short description (why this link is a good fit)
  • WordPress.org username
  • Consent (“I read the external linking policy rules…” checkbox)

If the proposed domain name appears to not follow the rules 3 times, the domain name gets on the “banned” list.

Review Process:

To make the review process less confusing, we can prepare the set of questions to which all answers have to be “yes” in order to allow a link.

  • 3 members of docs team completes a review (to avoid bias)
  • The review results are published on #docs team blog
  • domain name gets 5 links approved get the “trusted” status and we add them to the public list of trusted resources
  • If one allowed external link gets changed after being approved in a way that is against the rules, all links from that domain get removed, domain name loses its “trusted” status (with possibility to land on “banned” list perhaps?)

The Rules: (Brainstorming Ideas)

  • The content (article/tutorial) must not include any plugin, theme, service (hosting and similar) that is not bundled with WordPress clean install (which can be downloaded at WordPress.org)
  • The content, in its entirety or parts, must not be behind the payment or any sort of compensation from the reader (like, share etc)
  • The page where the content is can not contain visible ads for paid products and services (link in menu is OK but banners are not)

@kenshino suggested When people submit links, one of 2 things can happen

  • The link is added directly
  • The content is copied because it’s really good and they get attributed

The discussion centered from trusted links to commercial blogs, tutorials, promoting products, banners, attribution and even 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. licensing.

The entire conversation can be found here: https://wordpress.slack.com/archives/C02RP4WU5/p1594653710205500 

We request input from everyone. There are many aspects to policy making. Please join the conversation on the respective p2 post on commercial blogs and  trusted sources.

New Member Mentor Training

@Prubhtej_9 reported that for the month of July 22 new members had joined & 13 new members had joined #docs in the past week.

Due to the unavailability of @sukafia & @tomf the discussion on #docs-help channel was postponed to next week.

Monthly coffee break

@chaion07 reported that he’s still in the process of writing a p2 post, which he had volunteered for. @sukafia is assisting with the p2 post.

Google Season of Docs

@Kenshino(jon) suggested that the ‘Documentation Team’ badge be given to the selected Technical Writers and Mentors for Google Season of Docs. He also mentioned that @ChloéBringmann along with the Mentors are finalizing the selection of the Technical Writers which needs to be reviewed by Google as well.

Open Floor

@tacitonic reported that @Lucila Stancatohad contacted him regarding the following matter:https://wordpress.slack.com/archives/C02RP4WU5/p1594123868113500

@chaion07 offered to make a specific Meeting Summary and Meeting Agenda Document Template in Google Docs so that anyone as a New Contributor can find a direct guideline to assist with the Note taking process & requested to write a p2 post for the same.

@kenshino(jon) also reported that he had shut down the wp-helphub.com server.

#meeting-notes, #meetings

Agenda for Docs Team Meeting July 13, 2020

The next meeting is scheduled with the following details:

When: Monday, July 13, 2020, 15:00 UTC

Where: #docs channel on Slack.

Meeting Agenda

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

#agenda, #meetings

Summary for Docs Team Meeting on 06th July 2020

Attendance

@makz, @chaion07, @sukafia, @atachibana, @milana_cap, @tacitonic, @yui, @cristiano.zanca, @softservenet, @Prubhtej_9, @kemze, @glorialchemica, @collinsmbaka, @marcio-zebedu, @stefanocassone, @estelaris, @jubayerjoy, @khushbu.desai, @christiano.zancoo.

Find the Agenda of the Meeting here.

Thanks to @chaion07 for Facilitating the Meeting.

Notetaker & Facilitator Selection

Notetaker: @chaion07

Facilitator for the next meeting: @tacitonic

Next Meeting will be held on: 13 July 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

@atachibana informed 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. of Codex that 1022 out of 1070 pages had been completed. Currently the project is 95.5% completed which is a 0.70% improvement from last week. He also thanked @stevenlinx for processing complex cases with Open Tickets.

@christiano.zanca informed that the Italian team started translation of HelpHub. Currently Google Docs is being used as the base for checking and then publishing it.

@mkaz is continuing to work on 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. Tutorial. Currently working on the developer’s environment portion through PR 23953 and more.

@tacitonic currently reviewing The Bee-Docs tasks as @collibnsmbaka and @khushbu.desai are publishing the final drafts on embed blocks. The Bee-Docs Meetings are held every Mondays at 14:00 UTC in #meta-helphub under the supervision of @bph as always.

@Prubhtej_9 is contributing to the Scribd block editor documentation including a few of the handbooks this week & had a small discussion with the Rest APIREST API The REST API is an acronym for the RESTful Application Program Interface (API) that uses HTTP requests to GET, PUT, POST and DELETE data. It is how the front end of an application (think “phone app” or “website”) can communicate with the data store (think “database” or “file system”) https://developer.wordpress.org/rest-api/. team regarding their inputs for improving the Rest API handbook.

Categorization Project

@estlaris reminds everyone that we are looking forward to comments on the p2 post that she wrote earlier. @milana_cap is looking into the comment left by @annezazu previously that focuses on the Github issue.

Google Season of Docs

Requesting everyone to interact using the p2 post dedicated to Technical Writers as the deadline is close to hand.

External Linking Policy

You can join the conversation by visiting the p2 post related to this topic. We are expecting input from everyone.

New Member Mentoring Team

@softservenet reported that the New Member Mentor Training Team met recently to discuss support capabilities for new members.

@sukafia reported that the Mentoring Team is actively reaching out and checking up on new members. The team is ensuring that every member gets a Welcome Message and is provided with links to helpful resources and guidance relevant to #docs. 7 new members have joined since last week, raising the numbers for this month to 75. The Team is considering to write a p2 post on the proposal for a dedicated channel on Making WordPress Slack so that this can be discussed with the #meta team.

You can contact @sukafia, @softservenet, @tacitonic or @Prubhtej_9 with your ideas, suggestions and comments.

Monthly Coffee Break (July 2020)

@chaion07 is writing a p2 post covering the monthly summary piece (with the assistance of @sukafia). The new Doodle for the coffee break will be shared in the channel soon. Since it’s not Asian and some timezone friendly, we’ll have to be rotating the time. We will try to rotate the timing in such a manner to suit as many geo-location as possible to gain maximum audience.

#meeting-notes, #meetings