Milana Cap 8:00 am on June 13, 2022  

Live onboarding sessions for the Documentation team

We are organising onboarding sessions for everyone interested in getting started with the Documentation team. We know that our “Getting started” documentation is out of date and getting involved can be very confusing and frustrating so we hope to ease the process with live sessions via Zoom.

Sessions will be short, 10-20 minutes, covering one documentation project at a time. All sessions will be recorded and published at WordPress.tv. This means that you can watch them over and over again, at your own leisure. If you want to actively participate in sessions and ask questions, you are very much welcome to do so.

All sessions will happen via Zoom. You do not need zoom.us account, browser is enough. You may choose to turn your camera and mic on or off, whichever works best for you.

Overview

Wednesday, June 15, 2022, 1:30PM UTC

Recording: https://wordpress.tv/2022/06/21/milana-cap-overview-onboarding-for-wordpress-documentation-team/

End user documentation

Wednesday, June 15, 2022, 2PM UTC

Recording: https://wordpress.tv/2022/06/21/milana-cap-end-user-documentation-onboarding-for-wordpress-documentation-team/

Developer documentation – 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

Wednesday, June 15, 2022, 4PM UTC

Recording: https://wordpress.tv/2022/06/21/milana-cap-developer-documentation-plugin-handbook-onboarding-for-wordpress-documentation-team/

Developer documentation – Common APIs handbook

Thursday, June 16, 2022, 2PM UTC

Recording: https://wordpress.tv/2022/06/21/milana-cap-developer-documentation-common-apis-handbook-onboarding-for-wordpress-documentation-team/

Developer documentation – Code reference handbook

Thursday, June 16, 2022, 2:30PM UTC

Recording: https://wordpress.tv/2022/06/21/milana-cap-developer-documentation-code-reference-handbook-onboarding-for-wordpress-documentation-team/

Contributor documentation – Documentation team handbook

Thursday, June 16, 2022, 3PM UTC

Recording: https://wordpress.tv/2022/06/21/milana-cap-contributor-documentation-documentation-team-handbook-onboarding-for-wordpress-documentation-tea/

Developer documentation – 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 handbook

Wednesday, June 22, 2022, 5PM UTC

Zoom meeting

Developer documentation – Themes handbook

Wednesday, June 22, 2022, 5:30PM UTC

Zoom meeting

If you have any questions but can’t attend any of the sessions, feel free to post them in the comments below.

Estela Rueda 2:48 pm on June 28, 2022
Tags:   

Summary of Docs Team Biweekly Meeting June 21, 2022

Housekeeping

Open Floor

Docs Onboarding Videos

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. Documentation Comments

@lucp and @milana_cap:

5.9 Issues for HelpHub

@femkreations:

  • Issues with WordPress version 5.9 for the HelpHub are being worked on.
  • Later, the issues will be merged into the 6.0 project.
  • A lot of images don’t have ALT text and this needs to be emphasized for adding screenshots to HelpHub articles.
  • @milana_cap noted that ALT text is mentioned in the docs team Handbook.
  • A list will be added for this to the GitHub Issue Template for resolving on WordCampWordCamp WordCamps are casual, locally-organized conferences covering everything related to WordPress. They're one of the places where the WordPress community comes together to teach one another what they’ve learned throughout the year and share the joy. Learn more. contributor days.
  • An extra phase in the content review process will be added to address this issue.

@milana_cap will add a link to the list on the Leading a Contribution Day Handbook page.

Props to @ninianepress for writing the notes.

Femy Praseeth 9:08 pm on June 8, 2022
Tags:   

Summary of Docs Team Meeting June 7, 2022

Housekeeping

Project Updates

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

@milana_cap:

  • We had a packed WCEU contributor Day for the Docs team. We worked on various issues mostly 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 end user ones.
  • @bph and @leogermani helped out in co-leading and onboarding.

New block editor end-user rep

  • We have a new block editor end-user docs rep – @femkreations 
  • @milana_cap will be moving to other projects such as improving the onboarding process, updating the related docs, recording videos, and doing live onboarding sessions.

Docs design updates:

@estelaris:

  • The design for the Docs is almost done.
  • @estelaris will also add design elements for warnings and notes that @femkreations asked for. 
  • Each section of 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/ will have a similar look with a different color palette. This will make it easy to know what we are looking at.
  • The look and feel of Devhub will be the same as Helphub.
  • The landing page for documentation will now include everything:
    • The last section in the landing page design (under Developers) will replace https://developer.wordpress.org/
  • At some point, DevHub will also go through a site map review, as she did for HelpHub.
  • We’ll also have some kind of automated linking to the Learn platform, like a widgetWidget A WordPress Widget is a small block that performs a specific function. You can add these widgets in sidebars also known as widget-ready areas on your web page. WordPress widgets were originally created to provide a simple and easy-to-use way of giving design and structure control of the WordPress theme to the user. in the sidebarSidebar A sidebar in WordPress is referred to a widget-ready area used by WordPress themes to display information that is not a part of the main content. It is not always a vertical column on the side. It can be a horizontal rectangle below or above the content area, footer, header, or any where in the theme..

URLURL A specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org for the documentation:

@milana_cap and @estelaris:

  • There are two items on the menu under support: documentation and forums.
  • The URL for documentation is wordpress.org/support which makes no sense.
  • The URL for the documentation needs to be more obvious. e.g. docs.wordpress.org
  • Support is not a place where developers look for docs.
  • Support means interaction, docs are information.
  • Support needs to go to the support forums and not to documentation.
  • @estelaris to discuss this with Josepha 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 and start the implementation soon.

Moving the Action and FilterFilter Filters are one of the two types of Hooks https://codex.wordpress.org/Plugin_API/Hooks. They provide a way for functions to modify data of other functions. They are the counterpart to Actions. Unlike Actions, filters are meant to work in an isolated manner, and should never have side effects such as affecting global variables and output. reference pages from Codex to DevHub

  • @psykro raised the question about moving the Action Reference and Filter Reference pages from the Codex to DevHub.
  • He will open new GH tickets for each one, to allow for further discussion there.
  • It will be moved into the Common 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..
  • The order of firing will be updated and new 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. will be added.

Open floor

Coffee and chat

  • We are bringing back the zoom hangouts for coffee and chat.
  • It’s a 30 min hangout, once a month.
  • @estelaris will set up a doodle for the summer dates – June-August where folks can vote for the time/date.

Onboarding sessions

For anyone interested in starting to help with the docs

#meetings

Estela Rueda 9:08 am on June 7, 2022
Tags: ,   

Agenda for docs team bi-weekly meeting 7 June 2022

The next meeting is scheduled with the following details:

When: Tuesday, June 7, 2022, 04:00 PM GMT+2

Where: #docs channel on Slack

Agenda

  1. Attendance
  2. Note-taker & Facilitator selection for Next Meeting
  3. Projects checks
  4. Open floor

If there’s anything you’d like to discuss on the open floor, please leave the comment below.

#agenda, #meetings

Angela Jin 4:01 pm on May 26, 2022
Tags: ,   

X-post: Announcement: Incident Response Training

X-comment from +make.wordpress.org/updates: Comment on Announcement: Incident Response Training

Femy Praseeth 12:08 am on May 26, 2022
Tags:   

Summary of Docs Team Meeting May 24, 2022

Housekeeping

Discussions

Here are the updates and discussions from the Docs meeting held on May 24th.

#meetings

JuanMa Garrido 10:57 am on May 11, 2022  

Summary of Docs Team Meeting May 10, 2022

Housekeeping

Project Updates

  •  @milana_cap shares the status of docs regarding WordPress 6.0
    • last week we had RC1 out, all Dev Notes and Field Guide are published
    • we’re moving on to updating end user and dev docs – anyone wants to help just 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.” me
  • @juanmaguitar asked about a list of Projects related to Docs
    • The list is here but it’s probably a bit outdated
  •  @milana_cap shares that besides 6.0 she has created two new projects in the Docs repo:
  • @femkreations shares:
    • she completed triaging the google doc and created trackers for 6.0 end-user documentation,
    • she reviewed the google doc with help of @milana_cap on a video call and @bph (async) for clarifications.
    • she also reviewed the WP 6.0 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. post and About Page (draft)  for the HelpHub updates required and updated the trackers.
  •  @milana_cap shares she’s working on getting more people making code examples for code reference

Open Floor

#meeting

Femy Praseeth 2:29 am on April 22, 2022
Tags:   

Summary of Docs Team Meeting April 19, 2022

Housekeeping

Review of the design for documentation 

The design team has reviewed the design. We are waiting on Josepha’s approval. The mobile version is not ready yet as there are a few items to be resolved. 

  • We now have 4 categories for the content and a submenu with the 4 categories, displayed at the top so users can easily navigate. 
  • The breadcrumbs are included as part of the left navigation (the blue square on the top left). The first 3 lines are the breadcrumbs, followed by the headings in the article. We also have another option (on the 3rd article example) where the breadcrumbs are horizontal, at the top of the TOC 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..

Please add your comments here or in the slack channel.

Discussion 1: @femkreations: How are we handling the Changelog section since some of the Changelog entries are long?

@milana_cap: suggests not to delete the Changelog as it’s a history of the WP docs.
@bph: The Changelog is also used for translation and some locales might be behind on the pages.
@ibdz: We can have 2 different font sizes- one for the parent <li> (date) and one for secondary level <li> (content) to keep it aesthetically pleasing.

It was decided to add pagination to the Changelog. It is accessible and we can limit the number of entries per page, keeping the newest entries on page one and the oldest on page 2.

Discussion 2: @milana_cap: Would the definition list be semantic markup for the Changelog?

 @mburridge suggests the details disclosure element

Discussion 3: @estelaris: What about the FAQs that are on some of the block articles? Are we going to keep them there or can we extract them and create a new FAQs section under resources?

@milana_cap: Thinks all FAQs should be in FAQs and articles that currently have them could link to them.
@atachibana: Suggests keeping it as is, to reduce the cost, and also create independent pages of the FAQ.
@ibdz: Thinks from the user’s point of view, it’s good to have the FAQ attached to the page.

Project updates

@milana_cap:

  • Closed a few more 5.9 block editor end-user issues.
  • All tracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. tickets are labeled for docs and GitHub project is ready.
  • We have a new channel #docs-firehose for getting 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/ updates so that we keep the #docs channel clean

@femkreations:

  • Triaging the Google Doc and creating the Tracker issues for 6.0 end-user documentation.
  • So far, 40 trackers have been added for 6.0 End User Documentation.
  • Will complete the triage by the end of the week.

@estelaris:

All the block editor articles listed in the inventory have been added to the new sitemap.

Open floor

@estelaris and @femkreations to review the following two pages: Block Editor and WordPress Editor to make sure they are not repetitive and if so, merge and delete one. @atachibana: Suggests renaming WordPress Editor to Classic Editor and keeping with TinyMCE.

@milana_cap gave a talk about Docs at WordCampWordCamp WordCamps are casual, locally-organized conferences covering everything related to WordPress. They're one of the places where the WordPress community comes together to teach one another what they’ve learned throughout the year and share the joy. Learn more. Athens in person.

@milana_cap to lead the Docs table at the 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/. for WCEU.

#meeting

Estela Rueda 1:25 pm on April 18, 2022  

Agenda for docs team bi-weekly meeting 19 April 2022

The next meeting is scheduled with the following details:

When: Tuesday, April 19, 2022, 04:00 PM GMT+2

Where: #docs channel on Slack

Agenda

  1. Attendance
  2. Note-taker & Facilitator selection for Next Meeting
  3. Review of the design for documentation. We should have one more review before presenting the final design for approval
  4. Projects checks
  5. Open floor

If there’s anything you’d like to discuss on the open floor, please leave the comment below.

Femy Praseeth 12:31 am on April 6, 2022
Tags:   

Summary of Docs team meeting Apr 5, 2022

Housekeeping

Project updates

WordPress 6.0 End User Documentation 

@bph created a list of changes coming to WordPress 6.0 that would need End-User Documentation. She is waiting for the 13.0 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 release happening on Friday 4/8 and the walk-through before completing the list and setting priorities. Currently, some of the sections are not fully curated and some PRs might not be user-facing. She hopes to have the list completed by Monday, April 11th.

@milana_cap to start creating GitHub issues in the tracker repo from the list, once the list of changes is finalized. She also created 2 priority levels for the tasks: High and Medium.

@estelaris noted: Contributors who work on End-User Documentation need to follow the style guide such as using sentence case for headings and adding the word ‘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.’ to the title and URLURL A specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org for all the block pages.

@bph to start wrangling PR authors for their Dev Notes for the release and the Field guide.

@bph/@milana_cap to go through all TracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. tickets to collect all DevNotes, dev and end-user docs. They will also update the Contributors-wanted post and share the post on the internet.

Other updates

@estelaris: Work on the HelpHub is progressing well. The 301 redirects issue will be fixed for wordpress.org and will be on the list of features for the next release. HelpHub sitemap has been approved by Josepha and the Docs team.

@estelaris is currently working on the HelpHub design. The Docs team reviewed the first draft in the meeting. Once the design is approved by the design team, it will be shared. And the next step will be to redirect articles (changing titles/URLs/merging articles, etc).

@milana_cap: recorded onboarding session. She will upload it to wordpress.tv after she edits out a section. She did some work on triaging Trac tickets for 6.0 docs. She also reviewed quite a few block editor end-user issues.

@femkreations: Added more new pages to the Block Editor End-User Docs for the missing block pages for the 5.9 release.

@themiked: Updated a plugin handbook page.

#meetings