Summary for Docs Team Meeting April 19 2021

Attendance:

@crstauf@chaion07 , @tacitonic , @justinahinon , @atachibana , @estelaris , @bph @kmhazari, @stefanocassone , @engramium, @mkaz, @collinsmbaka, @milana_cap, @tomjn, @paaljoachim, @clorith, @annezazu, @kenshino, @themiked , @joyously, @ashiquzzaman,

Housekeeping:

Where#docs channel on Slack.
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/..

When: Monday, April 19, 2021, 14:00 UTC

Meeting Facilitator:  @ashiquzzaman
Meeting Note Taker: @kmhazari
Note Reviewer: @ashiquzzaman

Next Meeting: Monday, April 26, 2021, 14:00 UTC

Project Updates:

From @bph, 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 –

  • Getting ready for the 5.8 release.
  • Need volunteers to help with prep and writing.
  • She will create a post for the team blog to outline a plan proposal
  • This week she will check back with contributors work in progress and Need changes cards in 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. and see if there are blockers.
  • A Few 5.5, 5.6, and 5.7 residues to finish.
  • Please read the post by Josepha the final scope for 5.8 for the block editor

From @tacitonic, No substantial updates for the Style Guide, 21/28 articles have been completed in the Word list.

From @tjnowell, VVV project regarding 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/.

  • He’s liaising with @paaljoachim and @macgraphic to improve some coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. docs
  • VVV installation docs were heavily simplified over the weekend and uninstall instructions added, documenting these in handbooks is no longer necessary, a link will do
  • Adding a new site was overhauled with basic Trunk/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. env instructions
  • Changing instructions from installing to vagrant-local to vvv-local instead, lots of people think VVV and Vagrant are the same thing which is confusing, this should avoid some of that. Some .org docs will need updating


Team goals updates:

From @tacitonic,
For the Style Guide:
Priority: Completing the last remaining section.
Challenge: Parser inconsistencies.
Big Win: Style Guide was published.

From @justinahinon,
Restructuring of the block editor handbook:
Priority (for next quarter): Continue iterating on the current documentation
Challenge: The fact that the doc is synced on 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/ and parsed sometimes leads to challenges (redirections, syncing errors, live updates, etc..)
Big Win: The initial restructuring plan was completed.

From @atachibana, Content team completed 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. and classes 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 @paaljoachim,
As soon as the Code block is fixed in Learn. He plans to publish
Setting up a local WordPress Development Environment for Core and Testing a TracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. ticket or a Github PR.
He plans to create a Learn tutorial for VVV/Vagrant when he and Tom are finished with the VVV/Vagrant docs.


New Member Mentoring:

We have 16 members joining the #docs team since March 29, 2021. Please welcome the following Contributors 
@knutsp@Kim-Agape3.com@greduan@dirgha@Dulé@sebastienserre@Meghaa@Tyler Baldwin@Gaston Rubiolo@Amit Dudhat@Arnold W. K.@Vince@Sahil Mepani@igdeman@Chris Bell and @itowhid06

We have a Mentoring Team consisting of a few contributors in the #docs Team. One of the members from the Mentoring Team might reach out to you to assist you with your inquiries on contributing to the team. Thank you!


Google Season of Docs:

Update from @justinahinon, doc team applications have not been accepted for this year’s Season of Docs. He added some details and next steps to move forward as a short update on this post.


Unified Doc License page:

From @kenshino,
For the Unified Doc License page, he’s written a draft here. The doc team can use the text as written to make clear out intentions. The next 2 steps for this are sending the text to @chanthaboune so she can get the lawyers to review
Adding a link to the licensing page on the documentation page footers (or some other appropriate unified mechanism)

If there’s anything anyone like to add or comment, now is the time.


Author attribution to docs:

From @kenshino,

For Author attribution. The doc team should start recording and showing results. The team can start with DevHub (HelpHub has forums installed on the /support site so it’s a more complicated setup and should be tackled after some testing).

Recommended 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 – authorship, Beyond the ability to denote multiple authors, it also has the ability to do so via CLICLI Command Line Interface. Terminal (Bash) in Mac, Command Prompt in Windows, or WP-CLI for WordPress. (not just UIUI UI is an acronym for User Interface - the layout of the page the user interacts with. Think ‘how are they doing that’ and less about what they are doing.), so in the ideal case (with some custom dev) we can integrate that with the RESTPlain setup so 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/, official function/hook docs when synchronized from GitGit Git is a free and open source distributed version control system designed to handle everything from small to very large projects with speed and efficiency. Git is easy to learn and has a tiny footprint with lightning fast performance. Most modern plugin and theme development is being done with this version control system. https://git-scm.com/. / SVNSVN Apache Subversion (often abbreviated SVN, after its command name svn) is a software versioning and revision control system. Software developers use Subversion to maintain current and historical versions of files such as source code, web pages, and documentation. Its goal is to be a mostly compatible successor to the widely used Concurrent Versions System (CVS). WordPress core and the wordpress.org released code are all centrally managed through SVN. https://subversion.apache.org/. can attribute authors via CLI. There’s obviously more to talk about and this is likely a project in itself.


April Coffee Break:

Due to both @chaion07 and @Sunday Ukafia not being available for the past few weeks. The coffee break for March wasn’t commenced, they 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/. ask for hosts if interested in April.


Process gap between dev notes release stage:

@clorith requests the doc team to make it ready before dev notes, dev notes usually land around the Release CandidateRelease Candidate A beta version of software with the potential to be a final product, which is ready to release unless significant bugs emerge., which only gives 2-3 weeks. Even if screenshots may need updating near the end, the concepts should land before RCRelease Candidate A beta version of software with the potential to be a final product, which is ready to release unless significant bugs emerge., when the merge deadline is met. This is to help the support team to make support easier for them.

@estelaris raised the issue to Josepha but haven’t got an update yet.

@mkaz also agreed, getting features being released in a major version should be documented to coincide with the release, there are numerous tickets open to address.


Open Floor/Q&A:

From @mkaz, A short update for block editor handbook discussion, looks like consensus the “block editor” name covers all editors since they all are block editors. So next steps are to build out a good landing page with FSE docs with a focus on what is going out in WP 5.8 as decided here.

@estelaris stated it’s best to continue the discussion about this topic and post a P2 explaining the gap and any solutions the doc team suggests. She also commented on the issue with @Matt said he is willing to support the work of the docs team (on the HelpHub front). She stated the doc team need to raise the importance of end-user documentation, within the release squad, there is never a plan for writing end-user documentation

@milana_cap thinks, one of the ways could be having lists explaining new features in bullets after which the doc team can go and ask more questions if needed deeper explanation. But what the doc can’t know and would need for sure is what the feature is about, why is it important, what problem it solves.

@clorith mentioned, as soon as a feature proposal is accepted, work is started on the features that are already marked as “final”. Then once the merge deadline hits, start documenting the concepts and how the feature works in broader terms. This means once you reach RC, all that should be missing is screenshots and maybe a few adjustments for labels, and the documents can be published.

By publishing at the same time as RC goes live, Dev can help both the Doc and Support team, since they can get familiar with the material, but also users who are willing to test the RC can find information on the features, to know what is there that they can test

@bph agrees that the release team only considered Dev Notes, not end-user documentation. The docs team is fairly new and still doesn’t have enough people around to scale up the operation. With her work on Gutenberg Times, she’s in a unique position to keep up-to-date on the development and learn early when features arrive and how to get a task list going.

With the help of @geheren the team has a good system in place. What’s missing are the contributors to update existing pages, write the new pages, and are proficient enough in the new features to guide the users on exploring the new features. Most contributors who are new to the feature need guides themselves unless they have a certain curiosity and explore each feature deeper.

@geheren and @bph will review all the changes from the plugin (Gutenberg 9.9 – 10.7) release notes to see how the existing page needs updates. Update the Trello cards of existing pages and also review the template page editor and the new blocks to determine an outline 

#meeting-notes