Summary for Docs Team Meeting on 09 November 2020

Attendance

@crs1138, @chaion07, @leogermani, @atachibana, @tacitonic, @stefanocassone, @justinahinon, @veralee, @crstauf, @kafleg, @harishanker, @FahimMurshed, @sukafia, @mehbubrashid, @estelaris, @kenshino

Thanks to @leogermani for facilitating the meeting.

Housekeeping
Project Updates

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 Code Reference: @stevenlinkx and @collinsmbaka continued migrating and re-routing Codex to Code Reference: 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. 124 of 355 (34.9% < – 30.4%). @atachibana edited each method of information of the class references. @dd32 added a redirect to every page. No change in 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 until the external linking and the obsolete docs gets resolved.

Meeting Times

Due to the general confusion with the time-zones on the current Doodle, @kenshino will create a new Doodle and @crs1138 will notify all contributors who already voted on the original Doodle about the need to vote again.

New Member Mentoring

There are 5 new members joining #docs in the week between 2 and 9 November 2020.

Monthly coffee break (November 2020)

@estelaris will run the next monthly coffee break which will be on the Thursday 19 November 2020. The time for the coffee break should be Asia friendly and will be specified later on.

Google Season of Docs 2020

@tacitonic is currently working on the Punctuation section and updates the progress in the README file on the daily bases.

@dmivelli has finished reviewing the discoverability project and submitted a long list of typos and grammar errors that @estelaris will be fixing this week. There are also many titles that must be changed.

Docs Handbook and facilitating collaboration

@leogermani and @themiked rewrote a couple of pages but there is still more work to be done. As an example @leogermani pointed out the Projects page that could reflect more precisely what’s going on in their team. They also worked on the Workflow page. @leogermani suggests an idea to add a “report an issue” button to the pages to make it easier for people who want to collaborate to find their way.

@estelaris confirmed that this kind of button will be part of the new design of the articles template.

@themiked will add a link to the Reporting an issue page to the bottom of every plugin handbook page.

Deprecated Links

@themiked wrote down a document regarding the deprecated links and is asking for some feedback.

#meeting-notes, #meetings, #summary

Docs Team Coffee Break November Update!

Hello Folks,

As we inch closer to a second wave of COVID, it has become more important than ever to stand next to our fellow contributors. The idea of having a monthly informal discussion in the form of a ‘Virtual Coffee Break’ experience is something we are finding rather helpful while trying to maintain proper social distancing. Even though we would hope for majority of our fellow contributors to join in and support the same concept it may not always be the case. Understanding this, the team came up with the idea of rotation in the timing to serve multiple time zones. Additionally, we expect to write a dedicated p2 post with the information covering the Docs Team Coffee Break.

October Coffee Break Summary

Coffee Break began with a smile!

The October Coffee Break took place on the 29th instant with a EU-friendly timing which saw the presence of 7 contributors from the Global Documentation Team. Kudos to @sukafia for facilitating it. @chaion07 @crs1138, @tacitonic & @thisisyeasin were among the ones who joined in.

November Coffee Break Reminder

The next Coffee Break for Docs Team is scheduled for 19 November, Thursday at 10 AM UTC. @estelaris will be facilitating this month’s Coffee Break. The details for joining the Zoom call are as follows:

The details will also be posted in #docs channel on the day. If you wish to get a calendar invite then please 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.” @estelaris, @sukafia or @chaion07.

#coffee-break, #meeting

Summary for Docs Team Meeting on 02 November 2020

Attendance

@chaion07 @atachibana @veralee @softservenet @harishanker @leogermani @kafleg @hellofromtonya @FahimMurshed @crstauf @kenshino @tacitonic @estelaris

Thanks to @chaion07 for facilitating the meeting.

Housekeeping
Project Updates

@bph posted an update asynchronous to the meeting.

  • The team will be working on the “Sprint for BEE-docs” during November 25 – 27, 2020. Details will follow. If interested, please leave a comment on the digital check-in post.

@atachibana informed about adding dropped information of Codex to code Reference and re-routing:

  • 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.: 108 of 355 (30.4% < – 25.4%)
  • He also spoke on editing method information of each class’ references.
  • He also thanked @stevenlinx and @collinsmbaka for their contribution. 

@milana_cap previously published a p2 post on HelpHub.

Meeting Times

The team is still awaiting responses to the Doodle link from everyone for the meeting time as many parts of the world have already begun adjusting to the Daylight Saving Times. Please cast your preferences using the Doodle link.

New Member Mentoring

@tacitonic informed the team that we didn’t have any new member joining #docs this week.

Monthly Coffee Break

7 people joined in the Monthly Coffee Break for October 2020 with an EU-friendly timing. A few snaps from the meeting were shared with the team. Thanks to @sukafia for facilitating it including @tacitonic, @crs1138, @chaion07, @thisisyeasin and others who joined.

The next Coffee Break will take place on the 26th of November (tentative). More info will be shared as we draw closer to the date. Please 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.” @sukafia or @chaion07 if you require further assistance.

Google Season of Docs

@tacitonic & @diana did not have anything new to add for this week.

@estelaris suggested that a meeting is scheduled for everyone involved in the GSoD project to take part in.

Open Floor

@joyously brought up this question, a few weeks ago: What to do with articles/pages that contain information that is no longer relevant or deprecated

@leogermani suggested adding a deprecation notice at the top of the page and link to relevant up to date content.

@themiked will write a p2 post covering different aspects of the topic discussed.

#meeting-notes, #meetings, #summary

Summary for Docs Team Meeting on 16 November 2020

Attendance

@chaion07 @kenshino @tomford @collinsmbaka @leogermani @obt28 @tacitonic @mkaz @atachibana @FahimMurshed @Veralee @hellofromtonya @justinahinon @estelaris @themiked @paaljoachim

Housekeeping

Agenda: https://make.wordpress.org/docs/2020/11/16/agenda-for-docs-team-meeting-november-16-2020
Notetaker: @justinahinon
Next Meeting: 23 November 2020
Find the meeting transcript here

Project updates

@atachibana gave an update of 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:

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.: 153 of 355 (43.1% < – 33.8%). They’re also editing each method information of class references.

@bph mentionned prior to the meeting they’ll post asynchronously a digital check-in for the documentation team.

@justinahinon posted a follow up of 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 restructuring proposal.

Meeting times

@kenshino mentionned the Doodle for the documentation team meeting time. Please fill it if you haven’t yet.

New Member Mentoring

There were no update for this item.

Coffee Break November

The next coffee break will take place on the 19th of this month at 10am UTC. Here is the link if you want to add it to your calendar: https://us02web.zoom.us/j/83074914582?pwd=RlJkMkdnbzdKODZYbENzeUpXWGF2QT09.

If you want a Google Invite for the coffee break, you can also send a private message to @estelaris 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/..

You can also find all the details in this 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: https://make.wordpress.org/docs/2020/11/16/docs-team-coffee-break-november-update.

Google Season of Docs 2020

@tacitonic made some updates about the progress on this project:

On the reclassification front, the team is still reviewing articles for content errors but have already finalized the title change. More details are in this spreadsheet: https://docs.google.com/spreadsheets/d/1_Ea2yeF5Rfy_YDk7pBRJ4rdljhMjygXFqBq8gWwhbaE/edit?usp=sharing.

The team also discussed the big problems with titles which is the use of gerunds (words ending in ‘ing, as in working, reading, etc). This discussion can be found here.

Docs Handbook and facilitating collaboration

@themiked shared last week some updates on legacy docs which @kenshino is reviewing.

@paaljoachim asked if there have been any talks about refreshing the design. As using bigger fonts gives more space and better readability.

#meeting-notes, #meetings, #summary

Follow up on Gutenberg developer documentation restructuring proposal

The proposal to restructure 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/’s developer documentation was discussed a few weeks ago during the weekly JavaScriptJavaScript JavaScript or JS is an object-oriented computer programming language commonly used to create interactive effects within web browsers. WordPress makes extensive use of JS for a better user experience. While PHP is executed on the server, JS executes within a user’s browser. https://www.javascript.com/. office hours (rollback to the discussion here, meeting notes here).

We agreed that it makes sense to clearly identify stakeholders and use cases of the documentation before any action is taken.

This information has been collected in this Google Docs document.

The main stakeholders identified are:

  • Site developers: people who create WordPress sites with custom themes and plugins.
  • Site builders: people who create sites with primarily a page builder, or a theme that includes a page builder.
  • Theme Authors: Developers of WordPress themes, hosted on the official theme directory or elsewhere.
  • 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 authors: WordPress plugin developers.
  • WordPress Core contributorsCore Contributors Core contributors are those who have worked on a release of WordPress, by creating the functions or finding and patching bugs. These contributions are done through Trac. https://core.trac.wordpress.org.: People who contribute to the coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. of WordPress, to Gutenberg, etc…
  • Content creators: People who create content on WordPress sites.

For each of these stakeholders, the nature of the expectations are different. Theme developers or contributors to WordPress want to be able to alter the way 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 works, its structure or presentation; while site builders and content creators expectations will be best met by the user documentation for the block editor.

Next Steps

The major use cases that emerge from all those in the document mentioned above are:

  • Update/alter the 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. or the structure of the editor and its elements
  • Create blocks for the block editor
  • Create block patterns
  • Programmatically modify or trigger the functioning of the block editor and its elements

The next steps to move forward could be to propose a structure around these major use cases.

You can do this as a comment to this article. This will also be on the agenda for the next JavaScript office hours.

#block-editor, #developer-documentation

Digital Check-in for 🐝-docs team week November 2, 2020

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) ?

Documentation Update Sprint to bring pages to 5.5 /5.6 version

We still have quite a few pagess 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. Editor documentation that are still on 5.0 – 5.4 version. Let’s do an update spring on November 25, 26 and 27, 2020. Please let me know in the comments if you’d like to participate.

This week is release week:

  • WordPress 5.6 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. 3 is scheduled for November 2. You can get a preview of the upcoming version via the WordPress Beta Tester plugin
  • 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 RCRelease Candidate A beta version of software with the potential to be a final product, which is ready to release unless significant bugs emerge. 9.3 will also be published later today (Nov 2). Some commits will be backported to WordPresss 5.6
  • Gutenberg plugin 9.3 release is scheduled for November 4th.

Our reading list for this week:

Contributor Links

Looking forward to ‘seeing’ many of you at the next 🐝 docs Slack meeting on November 9, 2020 at 13:00 UTC <- changed the meeting time an hour earlier on Monday. Where we will discuss among other things, above mentioned “Update Sprint”

HelpHub Feedback Section – new feature for contributors

At Docs team, we are putting a lot of effort into onboarding process and helping contributors to get started. One of those efforts is a “Feedback Section” for HelpHub (end user documentation).

Feedback section is resembling the User Contributed Notes section at DevHubCode Reference, so this is a comment section but with a difference of HelpHub’ Feedback Section not being publicly visible.

What is it for?

Feedback section is meant to help contributors report issues such as typos, out of date info, missing facts etc. Even though this feedback is not publicly visible, it is not anonymous. The contributor has to be logged in to send feedback. If logged out, visitor will see the message “Please log in to leave the feedback”.

Where is this feedback visible then?

This feature is enabled on HelpHub and all Rosetta sites with HelpHub enabled.

All the feedback can be found in dashboard’ comments section. It doesn’t really matter if you approve them or not so you can use this status system as a sort of tracking issues system.

We hope this will reduce the gap between new or passing by contributors and the team; and mimic the ease of contributing at Codex.

Complete discussion and the code can be found here: https://meta.trac.wordpress.org/ticket/4915

Digital Check-in for 🐝-docs team week October 19

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) ?

This week is release week:

  • WordPress 5.6 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. 1 is schedule for October 20, which starts the beta/rc release testing phase. You can get a preview of the upcoming version via the WordPress Beta Tester plugin
  • 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 RCRelease Candidate A beta version of software with the potential to be a final product, which is ready to release unless significant bugs emerge. 9.2 will be published later today (Oct 19) and that is the version that will be merged into WordPress 5.6 coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress..
  • Gutenberg plugin 9.2 release is scheduled for October 21.

Our reading list for this week:

Contributor Links

Looking forward to ‘seeing’ many of you at the next 🐝 docs Slack meeting on October 26, 2020 at 14:00 UTC

Digital Checking 🐝-Docs team for the week of October 5, 2020

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) ?

Our reading list for this week:

Contributor Links

Looking forward to ‘seeing’ many of you at the next 🐝 docs Slack meeting on October 12, 2020 at 14:00 UTC

Digital check-in for Block-editor end user documentation (🐝 docs) team (9/21/2020)

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) ?

Links

Looking forward to ‘seeing’ many of you at the next 🐝 docs 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/. meeting on September 28, 2020 at 14:00 UTC