Digital check-in for Block-editor end user documentation (🐝 docs) team

After a series of weekly chat meetings in 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 #meta-helphub, we are testing “digital check-ins” for information and task coordination in September. Chat meetings will only take place every other week. 

For new contributors, here is the outline and all the links necessary: Getting started as a new contributors.

The Google sheet also has an “Experienced Contributors” tab and gives us an overview of what people are editing and what is on our priority list.

The source of truth for our ongoing work is the Trello board with the columns “Need changes /New Pages” and “Work in Progress”.

A few meetings ago I outlined a possible workflow for experienced contributors in slack and I will publish it on the make blog later this week as proposal with a request for input. 

The next Slack-chat meeting for 🐝-docs team will be September 14 at 14:00 UTC in the #meta-helphub channel. Feel free to post questions and comments between meeting there as well.

And now for our Digital Check-in for this week:
Please share the following in the comments:

  • What did you work on last week?
  • What would you like to work on this week?
  • What are your blockers (things that stand in your way of your work) ?

Summary for Docs Team Meeting 13th January 2020

Facilitator & Attendance

Facilitator: @leogermani

Attendance: @bph, @atachibana, @milana_cap, @kartiks16, @kenshino, @audrasjb, @pbrocks, @WPZA, @aurooba, @ibdz, @nullbyte, @estelaris, @felipeelia, @tomf, @felipeloureirosantos, @marcio-zebedeu

Note-taker: @kartiks16

Next week Facilitator: @felipeelia

Transcript

https://wordpress.slack.com/archives/C02RP4WU5/p1578926826044300

Discussion on the Docs team organization in general Workflows

We added current workflows to this trello card -> https://trello.com/c/GNXYppYS/44-workflows | If anyone wants access they can approach @milana_cap

For now, we have a few workflows defined. We are missing on reporting an issue: 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/ for developers handbook | any dev handbook | docs team handbook | HelpHub content

@milana_cap will add workflow of reporting the issue in tracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. and link to coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. handbook for contributing.

@leogermani will add info on DevHub

For Gutenberg dev handbook we have a workflow defined by @pbrocks

Badges

@milana_cap started the discussion in p2 https://make.wordpress.org/docs/2020/01/08/documentation-team-profile-badges/, all are requested to share their thoughts.

Docs Team Handbook
Workflows and badges pages:

Once we have all those things defined we can add those pages to docs team handbook

HelpHub
Progress of the survey :

@atachibana is working on the progress

Helphub Localization

We have it here: https://make.wordpress.org/docs/handbook/helphub/translating-helphub/

@felipeloureirosantos suggested that they don’t have updates there so far as well. There will be in the next weeks.

We have 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 #meta-helphub as a contact point between our team and the 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. team to get updates on this and speak with them about this issue.

@felipeelia mentioned here is a meta ticket for that too. https://meta.trac.wordpress.org/ticket/2082 @milana_cap will bring some more information on this in the next meeting. @kenshino suggested bringing @netweb to share thoughts

General topics

@joyously brought the topic of Custom Fields article in HelpHub (https://wordpress.org/support/article/custom-fields/), which is missing some information on how to diplay the custom fields (original codex article: http://web.archive.org/web/20160301204600/https://codex.wordpress.org/Using_Custom_Fields)

@Kenshino (Jon) and others argue that this is end-user docs and should not have this kind of information. It should have a link instead.

@felipeelia suggests to link it to: https://developer.wordpress.org/plugins/metadata/rendering-post-metadata/

@leogermani will make the edits on this topic

Remove paragraph of BitNami in the multisiteMultisite Multisite is a WordPress feature which allows users to create a network of sites on a single WordPress installation. Available since WordPress version 3.0, Multisite is a continuation of WPMU or WordPress Multiuser project. WordPress MultiUser project was discontinued and its features were included into WordPress core.https://codex.wordpress.org/Create_A_Network. considerations article

Topic brought by @René Hermenau. The pege mentioned is https://wordpress.org/support/article/before-you-create-a-network/. Everyone agreed to remove it. @atachibana will do it.

Improve docs on Multisite

Also a topic that @René Hermenau suggested, make it clearer that Multisite is a choice that brings more complexity to the installation. A quick discussion came up on how to show pros and cons so people can make a informed decision. @nullbyte would be volunteering it.

Plugins Handbook i18n

@Pascal might be able to help.

Specific headers, this kind of stuff needs to be there, @milana_cap will do that.

DevHub

Updates from @atachibana : We redirected 314 of 1069 (29.4 %) of Code Reference’s Functions part

Open Floor

@bph shared that we made progress on the meta-trac ticket. https://meta.trac.wordpress.org/ticket/4915 feel free to comment,

@bph asked should the documentation for Gutenberg End User have a section for features only available in the pluginPlugin A plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the WordPress.org Plugin Directory https://wordpress.org/plugins/ or can be cost-based plugin from a third-party? They are future features for Core, so it might make sense to have future features/changes. to which @leogermani responded as long as it’s clear that it’s not available in core yet, and @kenshino mentioned it should only feature Core info

@kenshino shared few small things i.e. He started a thread in the Advanced WordPress Facebook group, https://www.facebook.com/groups/advancedwp/permalink/2868239546571574/ if you are in the group. Some interesting comments so far. It is noticed that many people still don’t know that we’ve stopped updating Codex. We ought to talk about WC Asia Contributor Day and plan properly for it very soon.

@leogermani mentioned In the headerHeader The header of your site is typically the first thing people will experience. The masthead or header art located across the top of your page is part of the look and feel of your website. It can influence a visitor’s opinion about your content and you/ your organization’s brand. It may also look different on different screen sizes. of our page on make.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//docs we have, under “Want to get involved” a phrase that says “the many Contributor handbooks” linking to our handbook. Shouldn’t it just say “Documentation team handbook”? Also, he thinks the contents of the header should also be subject to a review now that we are reviewing everything and to which @milana_cap & @kenshino suggested that we will alter it.

#meetings, #summary

Summary for HelpHub meeting 11 March 2019

Attendance

@milana_cap @atachibana @daveryan @iviolini @kartiks16 @jessecowens @softservenet @dinamiko @nullbyte @kafleg @kenshino @audrasjb attended

Development (Phase 1.5)

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/ -> TracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/.: @milana_cap is collating issues that need moving towards Trac. We’re making sure that issues related to the portions of HelpHub that are committed 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/ are tracked on Meta.Trac as patches would have to be provided there.

We also now have a proper 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 #meta-helphub to discuss HelpHub development.

A regular bug scrub (perhaps once per month) will likely be planned and @milana_cap & @clorith will work out an appropriate time.

The GitHub repository will still be used for Phase 2 (working out code pieces that are not yet committed to WordPress.org) and the staging environmentStaging Environment A staging environment is a non-production copy of your site. This is a private place to build the site -- design, copy, and code -- until your client approves it for production or live. Sometimes used in addition to, or as a Development Environment. wp-helphub.com will accommodate all code staging work. The repository has also been transferred to the WordPress Team – with the original team keeping autonomy on the repository.

Content (Phase 1.5)

We’re still working on migrating all WordPress version articles from Codex to HelpHub. So far about 90% of the articles have been migrated (props to @atachibana @kartikshukla @jarretc @subrataemfluence and @audrasjb)

The coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. team has already been using HelpHub to publish release notes since WordPress 5.0

Progress is being tracked via this Google Sheet – while migrationMigration Moving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. is mostly done, @atachibana and team are working on the review and publishing process.

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 Docs

@milana_cap, @clorith and a great team of volunteers helped copy over the block editor docs contributed from the peeps at Automattic (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/).

Existing docs that refer to classic editor will be cloned and new block editor docs will be created and prefixed with -block-editor

  • https://wordpress.org/support/article/pages-add-new-screen/ will refer to the old way of adding new pages
  • https://wordpress.org/support/article/pages-add-new-screen-block-editor will refer to the post WordPress 5.0 way of adding new pages

The old docs will be kept and the new docs will be linked straight from HelpHub’s homepage.

@daveryan will be working alongside @atachibana to determine if there are any more key block editor (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/) docs to be written. (Basically we should be providing enough information to help people get to learn the block editor)

The new block editor user docs are available here – https://wordpress.org/support/category/block-editor/

Design

@iviolini is taking some time to get familiar with the needs of HelpHub. The WordPress versions require a proper archive page and that will likely be one of the first tasks to be worked on.

Localisation Plan

We’re still working out the technical aspects of the plan. But as it seems, the Community Team requires very similar work done to their Community Handbooks.

So we’re looking at a combined tech approach across Docs, 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., Polyglots and Community Teams. (We have some peeps from Multilingual Press who are going to chime in too)

@milana_cap is trying to convene a Zoom call to get all related parties together and an appropriate time is being decided on this Doodle. Do fill it in if you’re interested – particularly if you are able to provide technical expertise and time to work our the issues.

You can read what went on in the meeting via Slack logs.


Summary for Docs Team Meeting 18 February 2019

Attendees: @atachibana @milana_cap @subrataemfluence @joyously @Pixelateddwarf

Codex Deprecation (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.

@atachibana

  • On going: Status is here: https://docs.google.com/spreadsheets/d/1PeHj7pSFLcdMbIC41JJdzEkl12TJT3mwWyzQv2mi01U/edit#gid=554277336
  • @subrataemfluence migrated & set transfer tab of 23 Version Pages.

DevHub

No update.

HelpHub Development

@milana_cap

  • HelpHub repository was moved under the WordPress org
    https://github.com/WordPress/HelpHub
  • #meta-helphub, the dedicated channel for HelpHub development was created
  • @jrf fixed Travis Settings error

Inline Docs

No updates.

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/ Handbook

@atachibana will prepare the plan of Gutenberg user docs.

Open Floor

@joyously asked about internationalization of 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. update page
https://wordpress.org/support/update-php/
@dd32 explained it at #polyglots to translators:
It can be translated at
https://translate.wordpress.org/projects/meta/forums/fr/default?filters%5Bterm%5D=update-php
and it will be
https://fr.wordpress.org/support/update-php/
in case of French. Other languages are the same.

@subrataemfluence mentioned about the lacking of complete examples about Gutenberg development. After this meeting, @mkaz posted
“We are working on improving navigation in the handbook, but there is a tutorial section which has a few complete examples
https://wordpress.org/gutenberg/handbook/designers-developers/developers/tutorials/”