Chloe Bringmann 8:36 pm on May 12, 2020  

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.

Chloe Bringmann 1:55 pm on May 1, 2020  

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

Tim O'Haver 5:15 pm on June 23, 2020
Tags: ,   

Summary of Docs Team Meeting for June 22, 2020

Attendance

@Ataurr @bph @chaion07 @collinsmbaka @estelaris @FahimMurshed @ibdz @joyously @Kenshino @Leslie @MakeWebBetter @manthanadmane @mekalekahi @milana_cap @PiyushChetwani @Prubhtej @saiftheboss7 @sasiddiqui @softservenet @sukafia @tacitonic @themiked @timohaver (23 people attending)

Agenda

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

Note-taker: @timohaver

Notes Reviewed by: @chaion07 

Facilitator: @chaion07

Facilitator for Next Meeting: @Kenshino

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

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

Project Updates

Prior to the meeting, @atachibana reported 1006/1070 (94%) completed 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. He recognized @stevenlinx for their collaboration processing complex cases, and @obt28 for work on 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 completed the first meeting 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 team. The team meets again next Monday (1400 UTC) in the #meta-helphub channel. 

Categorization Project, Alterations Workflow

@estelaris has a draft post in-progress. She expects to finish it no later than Wednesday, and requested discussion and feedback as comments on the post.

External Linking Policy: Trusted Sources

@milana_cap authored a detailed post on this topic. She has been fielding questions, and this is helping to shape some early ideas about workflows. More participation is better. Everyone is invited to contribute ideas and questions as comments on the post. For updates, follow the #external-linking-policy tag.

New Member Mentor Training

@sukafia reported that 63 new members have joined the docs channel this month. The New Member Mentoring team has made follow up contact with all the new members. @sukafia thanked @tacitonic @Prubhtej, and @softservenet for their contributions to the team effort.

Monthly Coffee Breaks/Zoom Sessions

The June Coffee Break is set for this Thursday (June 25) at 1500 UTC.

Open Floor

@joyously referred to a question previously asked about the licensing “of the various docs: what is it and where is it stated”, inquiring if it was ever resolved or posted. @Kenshino answered that all docs in question were GPLv2, with permission to multi-license as-needed. He offered to create a page for the sake of clarity. The exchanges that followed weighed the merits of adding licensing content to post and page footers vs. creating a page. 

@joyously is finding the new order of DevHub sections to be less useful than the prior version. She cited a closed ticket that resulted in the change. @Kenshino is pursuing a response from @atachibana.

@manthanadmane and @softservenet inquired about creating a dedicated 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/. channel for new member mentoring. @Kenshino asked to address the question at the next weekly meeting.

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.

#agenda, #meetings

Estela Rueda 2:29 pm on June 22, 2020  

Exploration of a new classification for user documentation

Background

While working on a new design for HelpHub or documentation 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/, we discovered that the implementation of a menu or a table of contents was difficult because the articles were included in several categories.

Documentation is maintained manually by contributors and it is being moved from the old Codex. The structure is 17 years old and as WordPress develops and grows, the categories that worked 5 or 10 years ago are not necessarily the same that work now.

In order to continue with the design of documentation, we need to define a documentation structure that is clear and fulfills the user’s needs.

Problems with the actual categorization

The issues below affect the way users consult the articles in the documentation section.

  • There is a lack of definition of user personas. 
  • Search is not user-friendly because navigation is not clear, making article discoverability challenging. 
  • Inside a categoryCategory The 'category' taxonomy lets you group posts / content together that share a common bond. Categories are pre-defined and broad ranging. with several pages, articles jump order, making navigation confusing.
  • Some titles are not descriptive enough or use only one word.

What are we looking for

It is important to define first what the goal is for the documentation structure in order to define the categories. Envisioning what our ideal documentation section should look like:

  • It should be easy to navigate: a user should understand where they are.
  • Categories should be broken into subcategories to ease mobile navigation.
  • Categories should be descriptive enough to quickly answer the question: “where does this article go?”
  • It should be reliable: if an article is not found where it should be, it means that the article simply doesn’t exist
  • Titles should be descriptive enough for any type of user to understand what the article is about.
  • Maintenance or updating of the articles should be easy with a clear documentation structure
  • The structure should allow the incorporation of new categories or subcategories as the software develops.

The docs team worked on creating some stories that can help us verify if the proposed solution will work. You can find the complete list of stories here:

  • If I am new to WordPress, how do I know if it is the right CMS for my project?
  • If I am a blogger who receives many comments, is my data secure in WordPress?
  • If I am not a developer, can I still create a website and add my own branding?
  • If I am a business owner, can I sell products in WordPress?
  • If I am a website designer, where can I find information about new releases and upcoming features?

What documentation looks like now

So far, there are 171 articles being moved from Codex into HelpHub. Separately there are new articles being written about 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, so far 40 articles have been added and there are plans for more.

In the image below, we can see a snapshot of how articles are included in several categories. At the moment, the articles were arranged in alphabetical order because the articles jump order while scrolling through the pages:

A better view of the list can be found here.

Example scenario

Let’s review an example from the image above where the articles jump order inside a category with multiple pages.

In the video below, we are looking at the category Getting Started. A session was recorded following the Next Page link at the bottom of the page and then returned to the first page following the Previous Page link. The first page at the beginning has different articles than the first page that we returned to.

What it is like on a computer

The first page begins with the following list of articles:

  • Appearance Menus Screen
  • Backing Up Your WordPress Files
  • Pages Add New Screen
  • New to WordPress – Where to Start
  • Administering Your Blog
  • Resetting Your Password
  • Creating a Search Page
  • Managing Plugins

We navigated to the last page via the Next Page link at the bottom of the page and then returned to the first page, using the Previous Page link.

When arriving to the first page, the list of articles is different from what we have above:

  • Comments in WordPress
  • phpMyAdmin
  • Creating a Static Front PageStatic Front Page A WordPress website can have a dynamic blog-like front page, or a “static front page” which is used to show customized content. Typically this is the first page you see when you visit a site url, like wordpress.org for example.
  • Users Your Profile Screen
  • Update Services
  • Settings Writing Screen
  • Administration Screens
  • Giving WordPress Its Own Directory
  • Settings Reading Screen
  • Dashboard Screen

What it is like on mobile

On mobile, the situation is the same. 

Looking into the future

Target audience

As mentioned before, the end-user of documentation is not well defined but the existing documentation can shed some  light into identifying who the users are.

Who is the content intended for? 

From the stories written, we can identify some groups, but we have not explored the many user personas that access the documentation. Here are some examples:

  • New users looking for a CMS to build a website.
  • Bloggers/website designers that want to customize a site.
  • Content creators looking for content to write tutorials/posts.
  • WordPress consultants that provide services to their clients.
  • Others?

Type of content

In order to define a navigation structure that suits the project and allows for growth, we need to explore information pillars. Pillars shouldn’t be more than 4 or 5, as these can be split into categories and subcategories to form a logical navigation structure. These are suggestions for information pillars:

  • WP basics – overview, features, history, glossary, semantics, contributing.
  • Technical documentation: installation guides, requirements, best practices, technical how-to, security, troubleshooting.
  • Support documentation – dashboard structure, user permissions, screens, media screens.
  • Project related documentation – customization, themes & plugins, design how-to’s (blocks)

Relation to time and development

There are articles that have been superseded by new development and are either no longer relevant to the software itself or must be updated. We need to include 4 buckets where we should add articles:

  • No longer relevant or valid
  • Need update
  • Convert from Codex as is
  • Create new documentation

Next Steps? 

The docs team will continue working on defining the user personas, as well as the information pillars.

We plan on having a proposal on documentation structure that includes clear navigation and new classification, by the end of the summer.

If you would like to contribute to the project, leave your comments. Comments will be discussed during the #docs team meetings on Mondays at 15:00 UTC

Ahmed Chaion 1:04 pm on June 20, 2020
Tags: ,   

Agenda for Docs Team Meeting June 22, 2020

The next meeting is scheduled with the following details:

When: Monday, June 22, 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
  5. External Linking Policy– Trusted Sources
  6. New Member Mentor Training
  7. Monthly Coffee Breaks/Zoom sessions
  8. Open Floor

“All the details of life and the quirks and the friendships can be laid out for us, but the mystery of the writing will remain. No amount of documentation, however fascinating, can take us there.”

~ V. S. Naipaul

#agenda, #meetings

Milana Cap 4:06 pm on June 15, 2020  

Summary for Docs Team Meeting: 15 June 2020

Attendance

@collinsmbaka @atachibana @kenshino @bph @chaion07 @tacitonic @MakeWebBetter @timohaver @saiftheboss7 @lvg2013 @sasiddiqui @manthanadmane @audrasjb @fierevere @kmeze @immeet94 @fahimmurshed @pratikchauhan @themiked @nullbyte @joyously @crstauf @milana_cap

Meeting transcript: https://wordpress.slack.com/archives/C02RP4WU5/p1592233201335300

Next meeting

Facilitator: @chaion07

Date: Monday, June 22, 2020, 15:00 UTC

Project Updates

Categorization Project, Alterations Workflow

@estelaris couldn’t make it to the meeting due to health issues. Get well soon Estela <3

Google Season of Docs

For all the GSoC potential tech writers, @kenshino will be replying to any open questions end of this week if mentors don’t get a chance to, it’s highly recommended for all mentors to make direct and public replies so that other scan read and benefit from it too. There are two posts with questions/comments from potential tech writers – https://make.wordpress.org/docs/2020/05/12/season-of-docs-technical-writer-exploration-may-11-june-8/ and https://make.wordpress.org/docs/2020/05/01/season-of-docs-project-list-idea/

External Linking Policy – Trusted Sources

We need to specify the criteria for becoming labeled as “trusted source” in order to avoid misuse. Dedicated p2 post is a place for posting all your thoughts and questions on the subject. Follow #external-linking-policy tag for updates.

New Member Mentor Training

@sukafia wan’t available for the meeting. @tacitonic reported that the Mentorship team (@sukafia, @tacitonic, @softservenet) is regularly messaging and assisting new members. Since past week over 60 new members have been contacted.

Monthly Coffee Breaks/Zoom Sessions

The Doodle is still up for everyone to vote for the next meeting time:
https://doodle.com/poll/ds3dadnzzcwdz63k

Open Floor

@joyously reported that Documentation team’s help is needed in forum’s topic: https://wordpress.org/support/topic/database-erd/

@audrasjb proposed documentation for Auto-update feature and re-organising Site Health documentation. There is a Trac ticket for improving support for site health issues on HelpHub. @audrasjb volunteered to work on drafts. @milana_cap volunteered to review the drafts.

Milana Cap 2:35 pm on June 15, 2020
Tags:   

External Linking Policy – Trusted Sources

We have been discussing policy for external links 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 for a while now. It has been decided that, considering the benefits for the users of the documentation, we should allow linking to trusted sources when these sources are explaining the matter in more detail and/or with high quality use case examples.

In order to avoid all possible misuses of the “trusted source” label, we need to clearly define what kind of sources can be considered as trusted. Of course, it is not possible to keep an eye on each linked source all the time and we don’t want to make this at cost of our members workload. This is why the accent is on trusted.

Ideally, we will have a list of domain names which would be automatically allowed on wordpress.org. All the other domains will be automatically removed. That should sort out the workload of Documentation team members.

Also, Documentation team can and will change the criteria if a need for such an action arises. Documentation team owes to no individual or company to list them as “trusted source”. This is initiative to help people who are using the documentation in their quest for the information and guidance.

Let the discussion start. If you have an idea what would be appropriate requirement for “trusted source” label, please let us know in comments below. Thank you.

#external-linking-policy

MakeWebBetter 2:05 pm on June 15, 2020
Tags:   

Agenda for Docs Team Meeting June 15, 2020

Agenda for Docs Team Meeting June 15, 2020

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

Where: #docs channel on Slack.

Meeting Agenda

  • Attendance
  • Note-taker & Facilitator selection for Next Meeting
  • Project Updates
  • Categorization Project, Alterations Workflow, User Stories
  • Google Season Of Docs
  • New Member Mentor Training
  • External Linking Policy
  • Monthly Coffee Breaks/Zoom sessions
  • Open Floor.

Everything’s impossible until somebody does it.

– Batman

#agenda

Milana Cap 11:55 am on June 15, 2020
Tags: , , wceu2020   

WCEU 2020 Contributor Day Wrap Up

For the very first online 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. Europe 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/. Documentation team had two virtual Zoom rooms, one for end user documentation, facilitated by @bph, and the other for developer documentation, facilitated by @leogermani.

We had total of 4 new contributors, evenly distributed in our Zoom rooms.

The most interest went 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. This work is under review.

Work on redirecting Functions code reference from Codex to DevHub is nearing its completeness: 92.2%.

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 Developer Handbook was reviewed for content that is not limited to plugins development, during which page about HTTPHTTP HTTP is an acronym for Hyper Text Transfer Protocol. HTTP is the underlying protocol used by the World Wide Web and this protocol defines how messages are formatted and transmitted, and what actions Web servers and browsers should take in response to various commands. APIAPI An API or Application Programming Interface is a software intermediary that allows programs to interact with each other and share data in limited, clearly defined ways. has been split into several sections and planned to be moved to Common APIs Handbook.

Block Editor developer documentation will soon be enriched with a tutorial on Creating a block. This tutorial is meant for all junior and PHPPHP PHP (recursive acronym for PHP: Hypertext Preprocessor) is a widely-used open source general-purpose scripting language that is especially suited for web development and can be embedded into HTML. http://php.net/manual/en/intro-whatis.php. developers trying to bridge development practices before Block Editor and new ways of building with WordPress.

A warm welcome to @kmeze, @femkreations, @peteringersoll and @lvg2013. Thank you for joining Documentation team.

Also, huge thanks to all new and more experienced contributors and team members who joined us during WCEU 2020 Contributor Day: @kenshino, @atachibana, @sukafia, @bph, @leogermani, @mkaz, @estelaris, @tacitonic, @cguntur, @makewebbetter, @chaion07, @softservenet, @bobbingwide, @kartiks16, @fierevere, @garrett-eclipse, @saiftheboss7, @wernerm274, @JeremyG, @Glauber Silva, @Lev N, @Taha Qureshi, @ruchitshah.

I apologise if I missed someone or if your username at 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 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/ is not the same and I couldn’t find the latter. Let me know in comments and I’ll add or modify it.

Thank you everyone and hope to see you all in person at some other Contributor Day(s) where we can share the cookies and hugs. Until then stay safe and take care of yourselves.

#contributor-day, #wceu, #wceu2020

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!