Summary for Docs Team Meeting 1 July 2019

Attendance

@leogermani @atachibana @milana_cap @felipeelia @audrasjb @estelaris @felipeloureirosantos @chrisvanpatten @fitehal @howdy_mcgee @rahuldsarker @kenshino

Content MigrationMigration Moving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. from Codex to HelpHub & DevHub

@atachibana reported many HelpHub pages were modified during 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/.. The next goal is redirecting of DevHub. the current worksheet is available: https://docs.google.com/spreadsheets/d/15hpEbbnuWJZ0DJafyCeG3CFRMtSxX1gY-RObrrjzzdw/edit#gid=0 (open “New Status” tab for overall stats).

There is some instructions about editing this spreadsheet in Docs Team Handbook: https://make.wordpress.org/docs/handbook/code-reference/editing-articles/. Anyone is welcome to join the project.

@leogermani took a try to make sure WP_Query was ready to be redirected. Some missing sections and parameters were added, along with lots of other adjustments.

@leogermani reporte 2 remaining issues on this document:

  1. some of the h3 titles are not automatically added to the Table of Content.
  2. He didn’t create the links to the related Actions/Filters. We have to check if we can add links to them in devhub since they are far more incomplete there.

These issues are not blockers, so @atachibana is going to redirect it.

@kenshino asked if there is statistics of how many DevHub articles are redirected VS how many need redirection.

@atachibana said that we have the number of Functions: 167 of 901 (18.5%) was redirected. But we don’t have the number of 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./Filters.

@atachibana is going to modify the handbook to set high priority to redirecting.

HelpHub development

@milana_cap listed the current opened 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/. tickets:

Waiting for merge:

  • https://meta.trac.wordpress.org/ticket/4491
  • https://meta.trac.wordpress.org/ticket/4492 (patch added today)

Waiting for code:

  • https://meta.trac.wordpress.org/ticket/4493

@milana_cap is trying to figure out the best way for contributing to helphub dev by sharing GitHubGitHub GitHub is a website that offers online implementation of git repositories that 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/ and Trac code in local. Developers who want to help out with phase 1.5 can pingPing The act of sending a very small amount of data to an end point. Ping is used in computer science to illicit a response from a target server to test it’s connection. Ping is also a term used by Slack users to @ someone or send them a direct message (DM). Users might say something along the lines of “Ping me when the meeting starts.” Milana directly.

@estelaris is going to add needs-design keyword to those tickets.

@kenshino asked if any estimates to when we’ll finish Phase 1.5 dev.

@milana_cap said there are few issues that need decisions. A couple require the actual developer work (not just small CSSCSS CSS is an acronym for cascading style sheets. This is what controls the design or look and feel of a site. tweaks) with decisions made and very slow progress. September would be latest. @kenshino: Also remember @milana_cap and @clorith are dev leads so if it’s a development question, they can make decisions.

Inline Docs

Last week we talked about making sure we have mapped out some ideas for @juliobox to pick up the management of the specific area in Code Reference (“More Info” section).

@kenshino also had a chat with the previous Docs Lead and one of the creators of DevHub, that area was really meant to house the extraordinary amount of examples and information of WP_Query. So using it as a curated content space isn’t out of the norm.

Centralised 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. Handbook on DevHub

@coffee2code has created that and called it the Common API Handbook. It’s not visible on the front end but when you go to wp-admin, we can see the custom post typeCustom Post Type WordPress can hold and display many different types of content. A single item of such a content is generally called a post, although post is also a specific post type. Custom Post Types gives your site the ability to have templated posts, to simplify the concept..

@atachibana do mark out the pages you’d like to move from the other handbooks to the Common API handbook.

Who’s in the Docs Team

Last update from Docs Team Leads:

  • HelpHub Development Lead: @milana_cap, @clorith
  • HelpHub Developers: @felipeelia @ajitbohra @audrasjb @carl-alberto @kafleg @Pieter @tomf @mukesh27 @wevans (from this list of interested developers)
  • Content Lead: @atachibana
  • User Notes (DevHub) Curator
  • Theme Handbook Lead
  • 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 Lead
  • More Info (DevHub) Curator: @juliobox
  • Regular Contributor: @aurooba, @leogermani
  • Design Lead: @ibdz, @estelaris

Open Floor

@leogermani asked if there are any previous discussion on migrating the Explanations for the Filters/Actions from the Codex to devhub. For example: https://codex.wordpress.org/Plugin_API/Filter_Reference/posts_join. In devhub there is only the basics and no description: https://developer.wordpress.org/reference/hooks/posts_join/

@kenshino: stated one needs to submit a coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. ticket to add in that straight to the 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. https://www.php.net/manual/en/preface.php. 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. in the code (that’s how we parse in the Code reference pages).

@leogermani asked if “Centralised API Handbook on DevHub” discussion is related to this topic opened by @atachibana ? (See also: https://make.wordpress.org/docs/2019/05/19/proposal-wordpress-developer-handbook-for-common-topics/). @kenshino answered it’s exactly the same thing.

About HelpHub Internationalization:

Locales that are ready to begin with HelpHub internationalization are invited to open a Meta Trac ticket. At this moment, some of them have already opened a ticket: 4523 (pt_BR), 4571 (Serbian), 4572 (pt_ES), 4573 (nl_NL), 4574 (fr_FR) and 4575 (ja).

@kenshino added it would be good to comment on https://make.wordpress.org/meta/2019/06/20/helphub-handbooks-localisation/ as well so that others can see which locales are joining.