Jon (Kenshino) 5:21 pm on December 2, 2020  

New Meeting Time & Holiday Planning

Hello all,

We have the results of the doodle we did to find a better meeting timing – 14:00 UTC.

We are aiming to start the new meeting timing in the new year.

The Documentation Team is also looking to take a break for the holidays. The last meeting for 2020 will be on 14 December. We’ll then start fresh 11 January 2021.

If you have any worries or thoughts, please feel free to comment!

Justin Ahinon 1:32 pm on January 25, 2021
Tags: ,   

X-post: Block Editor Handbook: restructuring project update (25 January)

X-comment from +make.wordpress.org/core: Comment on Block Editor Handbook: restructuring project update (25 January)

Ahmed Chaion 1:03 pm on January 25, 2021
Tags: ,   

Agenda for Docs Team Meeting January 25, 2021

The next meeting is scheduled with the following details:

When: Monday, January 25, 2021, 14:00 UTC

Where: #docs channel on Slack.

Meeting Agenda

  1. Team Goals for Q1 2021
  2. Project Updates
  3. New Member Mentoring
  4. Monthly Coffee Break Announcement (January 2021)
  5. Google Season of Docs
  6. Open Floor

Please feel free to suggest agenda items by commenting on this post or raise during open floor. Thank you!

#agenda, #meetings

Collins Mbaka 8:24 am on January 25, 2021
Tags: ,   

Summary for Docs Team Meeting on 18 January 2021

Attendance

@atachibana @justinahinon @chaion07 @estelaris @rashid @paaljoachim @tacitonic @snilesh @pradeepdotco @collinsmbaka @thisisyeasin @nahidsharifkomol

Thanks to @justinahinon for facilitating the meeting

Note Taker and Next Meeting facilitator

Agenda: https://make.wordpress.org/docs/?p=11003
Notetaker: @collinsmbaka
Facilitator for the next meeting: @chaion07
Next Meeting: 25 January 2021
Find the complete Transcript of the meeting on Slack

Project Updates

@atachibana reported that the Content team is 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.: 285 of 355 (80.3% from 78.3%). Big Thanks to @stevenlinx as always.

@justinahinon reported on 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 restructuring project. He reported that they are working on the handbook homepage, which is in good progress and the new version will be done in the next few days. @PaalJoachim also reported on the work being done to improve the local development environment for docs with @johnbillion and @justinahinon. he shared a drafted update and his plans to further discuss with the coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. dev team on 20th of January 2021.

@tacitonic reported his update for the Style Guide as follows;

  • I finished the Linking section this week – except for the External Linking document. That is on hold until the policy is finalized.
  • Started the Developer content section.
  • I encourage team members to review and discuss articles in the discussion tab on the repo.

    • @estelaris reported on her work on the documentation redesign; she shared a list of what she has done so far.

    Monthly Coffee Break for January 2021

    The date for this month’s Coffee Break has not been officially fixed and announced but should fall in on the 28th of January, 2021.

    Open floor

    @estelaris has been following up on the redirect links and mentioned that @sergeybiryukov is going to try to fix it for 5.7 as it needs to be fixed in core. Here is the link to the update

    @chaion07 mentioned he isn’t sure but would 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.” the #meta team for the weekly meetings calendar to be updated.

    #meeting-notes

    Justin Ahinon 6:24 am on January 25, 2021
    Tags: ,   

    X-post: Block Editor Handbook: restructuring project update (15 January)

    X-comment from +make.wordpress.org/core: Comment on Block Editor Handbook: restructuring project update (15 January)

    Ahmed Chaion 3:08 pm on January 18, 2021
    Tags: , ,   

    Summary for Docs Team Meeting on 11 January 2021

    Attendance

    @milana_cap, @estelaris, @paaljoachim, @atachibana, @tacitonic, @shitalmarakana @chaion07, @bph, @justinahinon, @aurangajeb, @themiked

    Thanks to @milana_cap for Facilitating the Meeting.

    Notetaker & Facilitator Selection
    Project Updates
    • 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 by @themiked: Minimal changes, need to ratify the external linking policy document. According to Mike, all previous owners have just made changes as appropriate without asking, and nobody noticed.
    • Design for Documentation by @estelaris: Planning on finishing the design for documentation in the first quarter. Need to gather the final results from the reclassification project, other requirements I picked up from diverse meetings and put together my recommendation for final design. You will see a few discussion posts before the design proposal, aimed between the last week of March- first week of April.
    • BEE-Docs by @bph: Caught up on our articles to make them current with 5.5 and started working on 5.6 updates and create new pages. Started to open up the feedback for more pages. Definitely need instructions, how we would like to handle things. The team is now working via 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., Google Docs. Kudos to all who keep working away on the to-do lists. The ‘Thanksgiving Sprint’ which was a great way to get a lot of things done and connect with contributors, especially new ones. This will definitely be repeated and hopefully can be an ongoing team exercise. Kudos to @geheren for taking up a quite a few pages and work on them.Challenges: We don’t yet have a fluid system on keeping pace with the rapid development 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/ and for adoption of FSE for 2021 the team needs help from the coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress.-editor team to at least have a rough draft of documentation coming from the developers, that we can follow and extend for End-User.
    • External Linking Policy by @milana_cap: Finally made some visible progress even though it was rather slow at the beginning
    • Google Season of Docs by @estelaris: One project finished and another is due to finish by Q1 2021 by @tacitonic. He finished the lengthiest section in the style guide – the Formatting section, started writing a spinoff section on Linking and encouraged team members to review and discuss articles in discussion tab 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/.
    Goals for Next Quarter

    Milana thinks that The Team can start with some rough ideas where each project should be in March. Not just projects but processes as well. Plugin Handbook should finish the second phase: https://make.wordpress.org/docs/2020/12/01/external-linking-policy-1st-review-of-plugin-developer-handbook/ The main idea here is to think about direction for each project and some sort of measurable progress at the end of each period.

    It’s Birgit’s first year on the team, so she’s not sure what’s the ‘usual’ process is. On Community team, there is a post asking for suggestions from the whole community, like the wishlist for the new release and then the team organizes the suggestions and translate them to goal statements, and picks their priorities.

    Estela points out the goals for Design: Documentation design proposal – Q1

    • 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/. new requests – Week 03
    • P2 new classification – Week 05
    • P2 on final navigation – Week 07
    • P2 on templates draft – Week 10
    • P2 proposal new design for documentation – Week 13
    Open Floor

    @estelaris feared to collaborate with the #meta team but at the same time is planning to annoy them until they reply. @bph mentioned that #Meta team is working on a Pattern Directory that is exciting for a lot of us.

    @tacitonic was looking at ways to insert an icon inline to indicate that a link is going to an external site. Reference: https://developers.google.com/style/cross-references#out-page

    #meeting-notes, #meetings, #summary

    Justin Ahinon 1:50 am on January 18, 2021
    Tags: ,   

    Agenda for Docs Team Meeting January 18, 2021

    The next meeting is scheduled with the following details:

    When: Monday, January 25, 2021, 14:00 UTC
Where: #docs channel on Slack.

    Meeting Agenda

    1. Housekeeping
    2. Project Updates
    3. New Member Mentoring
    4. Monthly Coffee Break January 2021
    5. Open Floor

    #agenda, #meetings

    Estela Rueda 11:54 am on January 11, 2021  

    Agenda for Docs team meeting 11 January 2021

    The next meeting is scheduled with the following details:

    When: Monday, 11 January 2021 14:00 PM UTC

    Where: #docs channel on Slack.

    Meeting Agenda

    1. Housekeeping (note-taker, next meeting facilitator)
    2. Discussion: Previous quarter and plan for future goals
    3. Open Floor

    #agenda, #meeting

    Estela Rueda 1:47 pm on December 17, 2020
    Tags: ,   

    Summary for Docs team on December 07, 2020

    Attendance

    @chaion07, @bph, @paaljoachim, @atachibana, @mkaz, @tacitonic, @estelaris, @tjnowell, @fahimmurshed, @kenshino, @joyously,

    Thanks to @chaion07 for facilitating the meeting.

    Housekeeping

    Project updates

    • @atachibana reported that the contents team continued migrating and re-routing Codex to Code Reference, and in this week we processed: 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.: 224 of 355 (63.1 % from 56.1% the last week) by @stevenlinx and @Mathew McCabe
    • External Linking Policy – there was a lack of input from the team on the post but we have a deadline so for the first review of 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 we have two reviewers (even though we are aiming for 3) – @themiked and myself. I’ve already done the one for “undoubtedly allowed” links. @themiked please do yours this week if you can so that we can start applying results and keep the deadline by the end of this year.
    • GSoD Documentation Style Guide – I’m working on manifest.jsonJSON JSON, or JavaScript Object Notation, is a minimal, readable format for structuring data. It is used primarily to transmit data between a server and web application, as an alternative to XML. file which is needed for parsing 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/ markdown files to our very new Style Guide Handbook. Once I finish it, I’ll 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.” some good people from 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. to run it for the first time. Really looking forward to seeing this one.
    • We are asking all #docs team members to read the above post about External Linking Policy. We need your decisions and votes. As it is now, this will be a “two persons” decision.

    :bee: -docs update
    We have still three orphan pages on our to-do-list for 5.6

    • Updates: Image 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. page
    • new page: Image Editing features
    • Updates to Latest Posts
    • New contributor @incapit works on their first page.
    • Another new contributor will be on-boarded this week.
    • Experienced contributors are progressing in their work. @newyorkerlaura, @cguntur @bizanimesh, @collinsmbaka @geheren

    New meeting time and holiday break announcement

    The team chose to change the weekly meeting time to 14:00 UTC and this is the last meeting of the year 2020. We will reconvene again on 11 January 2021 at 14:00 UTC.

    Monthly Coffee Break December 2020

    After some discussion, we decided to skip the coffee break this month as it is too tight between the holidays and the State of the WordState of the Word This is the annual report given by Matt Mullenweg, founder of WordPress at WordCamp US. It looks at what we’ve done, what we’re doing, and the future of WordPress. https://wordpress.tv/tag/state-of-the-word/..

    Google Season of Docs

    Style Guide by @tacitonic

    • @milana_cap started with the manifest file for the Style Guide.
    • I’m currently writing the Formatting section.

    Classification project by @dmivelli

    • I’ve reviewed the New Classification Recs tab on our worksheet.
    • I created new columns with subcategory suggestions for WP overview and Technical docs.
    • I’m still working on the Technical docs column.
    • I’ll continue this week and check in on progress by next weekend.
    • Link to the spreadsheet. We ask that peeps do not change anything, but feel free to add comments.
    • Also, the final reports by mentors and technical writer were submitted to Google last week.

    There was a discussion as to what language (American English) is the basis of the style guide and there will be a focus on internationalizing the language. Also, the discussion area in GH is open, feel free to leave your comments there.

    Discussion: Clarification about the use of GPLGPL GPL is an acronym for GNU Public License. It is the standard license WordPress uses for Open Source licensing https://wordpress.org/about/license/. The GPL is a ‘copyleft’ license https://www.gnu.org/licenses/copyleft.en.html. This means that derivative work can only be distributed under the same license terms. This is in distinction to permissive free software licenses, of which the BSD license and the MIT License are widely used examples. by WordPress plugins and themes

    There was a discussion previous to the meeting on Slack. The conclusion is to point docs to the license page. @themiked clarified that the license question asked a few weeks back was mashed out and the license page for the plugin handbook was updated to include a link to the general WP license page and suggested the same approach is taken for the theme handbook.

    #meeting-notes

    theMikeD 12:28 am on December 17, 2020  

    What to do with old/obsolete documentation

    While recently reviewing the content of the plugins handbook, I discovered some content that is no longer current (specifically, this page that deals with the term splitting fix that happened four years ago as part of the automatic upgrade process for 4.2).

    After some discussion with the documentation team it became clear we lack a unified way to identify which documentation is obsolete, and what to do about it when it is. As a result, old docs end up hanging around in a position of implied accuracy, potentially adding to confusion.

    To begin with, we need to answer these questions:

    1. What is considered obsolete? Is it even possible to come up with a general rule for this?
    2. Who decides if a page is obsolete?
    3. What do we do about it? (see below)

    Once the obsolete docs are identified, we need to decide what to do with them:

    A. Do nothing (this is here for completeness’ sake. This is not a valid path forward.)
    B. Delete them
    C. Leave them in place and mark them as obsolete as of a specific WP version or date
    D. Move them to an “archive” or “legacy” section and mark them as obsolete as of a specific WP version

    Depending on the decision this will require some or all of the following:

    a. standardized markup to appear at the top of a page, to clearly identify that this entire page is considered legacy (hopefully via a shortcodeShortcode A shortcode is a placeholder used within a WordPress post, page, or widget to insert a form or function generated by a plugin in a specific location on your site.)
    b. standardized markup to clearly identify a specific section of a page that is is considered legacy
    c. a place in each handbook for legacy documents, along with markup to clearly identify them as such

    I suggest the following

    1. The identification of a page or page partial that should be discussed can be put forward by anyone
    2. The “owner” of the handbook (or whatever) along with anyone else of interest can discuss the validity of the content in question and determine if it should be adjusted.
    3. If it has been determined that the content is no longer relevant, the correct action (one of B. C. or D.) can take place.

    I realize this may seem like navel gazing but if we can at least come up with a general consensus on how to handle this situation, it will provide a starting point.

    Ahmed Chaion 1:16 pm on December 14, 2020
    Tags: ,   

    Agenda for Docs Team Meeting December 14, 2020

    The next meeting is scheduled with the following details:

    When: Monday, December 14, 2020, 15:00 UTC

    Where: #docs channel on Slack.

    Meeting Agenda

    1. Project Updates
    2. Meeting Times & Holiday Planning Announcement
    3. New Member Mentoring
    4. Monthly Coffee Break December 2020
    5. Google Season of Docs 2020
    6. Discussion: Clarification about the use of GPLGPL GPL is an acronym for GNU Public License. It is the standard license WordPress uses for Open Source licensing https://wordpress.org/about/license/. The GPL is a ‘copyleft’ license https://www.gnu.org/licenses/copyleft.en.html. This means that derivative work can only be distributed under the same license terms. This is in distinction to permissive free software licenses, of which the BSD license and the MIT License are widely used examples. by WordPress plugins and themes
    7. Open Floor

    #agenda, #meeting