Onboarding to Documentation team

Here is some quick info you need in order to start contributing to Documentation team.

Accounts:

Places:

  • Blog – for meeting agendas and summaries (and anything related to Docs team).
  • Slack channel #docs – where meetings are happening (and all communication regarding the team itself).
  • GitHub repository – where issues for all documentation are reported, discussed and worked on.
  • Handbook – how to contribute to the Documentation team (it’s a bit out of date).
  • Style guide – for how to write WordPress documentation.

Meetings (alternating every week) on Tuesdays at 2PM UTC:

  • Regular meeting with agenda published on our blog.
  • Issues triage where we discuss issues from the GitHubGitHub GitHub is a website that offers online implementation of git repositories that 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/ repository.

Live onboarding sessions

We recorded 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 these sessions.

Overview

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

End user documentation

Developer documentation

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

Developer documentation – Common APIs handbook

Developer documentation – Code reference handbook

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

Developer documentation – Themes handbook

Contributor documentation – Documentation team handbook

If you have any questions or you’d like to have an “in more detail” session, feel free to leave the comment below.

DevHub getting a new look

With all the redesign happening in WP.org, it is now time for Developers documentation. The design team has started with a new look but need feedback from documentation users.

Developers documentation is composed of handbooks and articles. At this time, the handbooks will not be redesigned.

What we need feedback on?

  • Compare and review the landing page. Changes include:
    • First 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. links the handbooks under Developer Reference
    • The second block splits the Code Reference into New and updated in 6.x version and the Common APIs handbook TOC
    • The link to Dashicons was removed since they have been deprecated. Do they still need to be linked under Resources? Or shall the link move to somewhere else?
    • Does this navigation make sense?

Other sections that need review

  • Breadcrumbs have been moved to the blue ribbon
  • User contributed notes
  • User contributed notes feedback form
  • Styling in the code block (highlighting the title and keeping the code background white)
  • The general Add note/feedback form
  • The changelog at the bottom of the page will be expandable

Feel free to leave your comments in the Figma file or in this post.

#devhub

Summary of Docs Team Meeting: 15 November 2022

Housekeeping

Attendance: @joen, @estelaris, @javier, @samanthaxmunoz, @jaedm97, @bph, @kartiks16, @atachibana, @emmaht, @webcommsat@milana_cap, @mburridge
Where: #docs channel 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/.. Find the complete transcript of the meeting on Slack.
Agenda: https://make.wordpress.org/docs/2022/11/14/13791/
Meeting Facilitator: @estelaris,
Note Taker: @mburridge
Next Meeting Facilitator (in two weeks): TBD
Next Triage Meeting Facilitator (next week): @milana_cap

There was some initial confusion over the start time this week and some attendees didn’t join until the end of the meeting.

Project updates

 Screenshots for a few issues related to WP6.1 were done at WC Italia 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/..

Update for the End Use Docs:
6.1 Closed 10 issues, more to new reviewed this week. We have about 39 To do if anyone wants to pick up.
6.0 Closed 4 issues more to be reviewed this week. We have 10 To do items

The menu 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. is ready for review.

@milana_cap will work on onboarding docs this week.

HelpHub Design

The design team is reviewing the design for HelpHub because the general template for WP.org has recently been changed.

Two members of the design team (@joen and @javier) were in attendance to help answer any questions that other attendees might have regarding the proposed design.

The Figma design for HelpHub was shared:

  • The change log has a new placement, at the end of the article after the feedback form. The reason for this is to make the change log a collapsible item and being the last item, once opened it won’t interfere with the flow of the article
  • @femkreations asked: “Who gets notified when the feedback form is submitted? Would it be more helpful to have a link to  GitHubGitHub GitHub is a website that offers online implementation of git repositories that 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/ where folks can create an issue if they find something wrong in the Docs?”
  • TOC’s will not be collapsible on mobile
  • The “Back to top” link will be placed under the TOC, like Vercel does with their documentation: https://vercel.com/docs/concepts/git

There was praise for the design from those in attendance.

Please note: The HelpHub Figma will be closed today so we can start preparing a final version for the developers, so today is the last chance to add your comments.

DevHub Design

The Figma design for DevHub was shared:

  • The design team needs a lot of feedback, please add your comments to the design on Figma
  • A key consideration is what content goes on the landing page
  • The handbooks will most likely get the same general updates done to the team handbook

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. post for Improving DevHub Code References was shared.

There was also praise for the DevHub design from those in attendance.

Please note: The Figma file for DevHub will be open for the rest of this week for comment, please review the design and add your comments,

Open Floor

There was a question about Documentation Contributor badges on the .org profiles of contributors. We were assured that @milana_cap keeps track of contributions and has it in hand.

If you feel your contribution has not been acknowledged see here.

#docs#meetings#summary

The next meeting is scheduled with the following details:

When: Tuesday, 15 November, 2022, 04:00 PM GMT+1

Where: #docs channel on Slack

Agenda:

  1. Attendance
  2. Note-taker & Facilitator selection for Next Meeting
  3. Projects checks
  4. Alterations on HelpHub design pages to sync with new WP.org template
    • Changelog is a collapsible item
    • Changelog and Feedback form switched placement
    • Adding descriptions to categories & subcategories on landing page, will affect mobile length
    • Adding description to articles in categoryCategory The 'category' taxonomy lets you group posts / content together that share a common bond. Categories are pre-defined and broad ranging. page (no description on subcategory) – will affect mobile length
    • Article content switch sides, long content to the left and article TOC to the right
    • Figma i1 vs i4
  5. First iteration for DevHub new design
    • Content review (landing page: what goes, what stays?)
    • Improvements only to articles not inside handbooks
    • Design in general
  6. Open floor

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

#agenda, #meetings

Summary of Docs Team Meeting November 1, 2022

Housekeeping

Attendance: @milana_cap, @chaion07, @atachibana, @nielslange, @kafleg, @leonnugraha, @lucp, Malcolm, @femkreations, @colorful-tones, @dpknauss, @bph, and @estelaris
Where: #docs channel 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/.. Find the complete transcript of the meeting on Slack.
Agenda: n/a
Meeting Facilitator: @milana_cap,
Note Taker: @nielslange
Next Meeting Facilitator (in two weeks): @femkreations
Next Triage Meeting Facilitator (next week): TBD

Project updates

  • @nielslange fixed broken code formats of the theme-related docs (see https://github.com/WordPress/Documentation-Issue-Tracker/issues/531).
  • @femkreations worked on WordPress 6.1 pages (see https://wordpress.slack.com/archives/C02RP4WU5/p1667311973175699).
  • @colorful-tones created a Trac ticket related to Block Patterns (see [#6556: Consider allowing Make teams to create block patterns](https://meta.trac.wordpress.org/ticket/6556) ).
  • @leonnugraha is planning to work on [HelpHub Remove redundant block name from “settings” panels · Issue #513 · WordPress/Documentation-Issue-Tracker · GitHub](https://github.com/WordPress/Documentation-Issue-Tracker/issues/513).
  • @femkreations mentioned that 44 pages of [6.1](https://github.com/orgs/WordPress/projects/45/views/2) and 14 pages of [6.0](https://github.com/orgs/WordPress/projects/28/views/11) have the status `Todo` if all issues for 6.0 should be moved to 6.1. @milana_cap then raised the question if the issues can be merge theme seamlessly.
  • @nielslange mentioned that a few issues of 6.0, that are in `Todo` should be in `Ready for Review` and volunteered moving the corresponding issues to the correct column.
  • @milana_cap mentioned that the [Yoast Contributor Day](https://yoast.com/about-us/events/yoast-contributor-day-november-2022/) will take place on November 3rd, 2022.
  • @estelaris mentioned that @ninianepress finished adding terms to the docs glossary project in GitHub (see https://wordpress.slack.com/archives/C02RP4WU5/p1667313612480669 and https://github.com/orgs/WordPress/projects/20/views/1).

Open Floor

  • @nielslange asked about how to follow-up after working on a doc and `Save it for later`. @milana_cap suggested to 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 corresponding team lead.
  • @milana_cap mentioned that she saw the docs team small, then big, then small and now growing again and that she’s very happy with the current documentarians that are very dedicated.
  • @estelaris and @milana_cap had a brief discussion about the Handbook’s Glossary and @estelaris mentioned the link to [WordPress Glossary update](https://github.com/orgs/WordPress/projects/20/views/1).

#docs, #meetings, #summary

The Documentation team Contributor Day summary

On October 25th Documentation team held its first online 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 10 hours we had opportunity to work on a lot of backlog tasks, to put faces on well known names and to meet and onboard new contributors.

The Documentation team, WordPress community, more than 40% of the internet and all its consumers thank to all who participated. You make the bits flow through ports and you, heroes of the open sourceOpen Source Open Source denotes software for which the original source code is made freely available and may be redistributed and modified. Open Source **must be** delivered via a licensing model, see GPL., just wrote a piece of history.

Contributors

@femkreations, @estelaris, @colorful-tones, @samanthaxmunoz, @leonnugraha, @ninianepress, @barn2support, @nullbyte, @ivahyael, @saurabhshukla, @gwmorteza, @vadatiertebat, @tahmidulkarim, @nielslange, @wigno, @ninthcoder, @poena, @jhimross, @kraftner

Progress

Here are some stats of work being done:

We also onboarded several new contributors and look forward to continue working with them. Hopefully, this Contributor Day was the first of many to come.

To be continued..

X-post: WordPress.org Redesign Update

X-comment from +make.wordpress.org/meta: Comment on WordPress.org Redesign Update

New design for HelpHub in WordPress.org

The end-user documentation or HelpHub will go through a transformation, both in the design and the site map. 

The refinements in the template will improve the user experience while searching for information. These improvements include one landing page for end-user and developers documentation that will be called Documentation. This is the entry port to both HelpHub and DevHub. Although this article focuses on HelpHub, there will be changes for DevHub in the future.

Showing the look of the new end-user documentation landing page showing the 4 categories and subcategories under each in two columns. There are links to developers documentation and the forums at the bottom of the page.

Better search

The new site map includes 4 main categories and subcategories under each. This will improve search and allow new articles to be added into the existing categories without creating a ‘miscellaneous’ categoryCategory The 'category' taxonomy lets you group posts / content together that share a common bond. Categories are pre-defined and broad ranging..

New site map showing categories and subcategories

New features

Documentation will have a new 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.. The team is dropping the word ‘Support’ and replacing it with ‘Documentation’. This area of the website will contain reference information rather than be a place where users interact with the Support team as described in the Renaming WordPress.org Support to Documentation.

The new header for end-user documentation replaces the word Support for Documentation

A changelog was added to keep historic information on each article. The user will have a better idea of how recent the information is.

Example of changelog

Other features that will help searching are the breadcrumbs, a new documentation submenu to the categories, a more prominent table of content and, a highlighted link to Support Forums.

Example showing placement for breadcrumbs table of contents and documentation search box, including the Support Forums block.

Another new feature was the retirement of the hash character at the end of the headlines as they were an accessibilityAccessibility Accessibility (commonly shortened to a11y) refers to the design of products, devices, services, or environments for people with disabilities. The concept of accessible design ensures both “direct access” (i.e. unassisted) and “indirect access” meaning compatibility with a person’s assistive technology (for example, computer screen readers). (https://en.wikipedia.org/wiki/Accessibility) issue and caused visual noise. The hash has been replaced by a link icon.

Appearance phases for the headlines

Documentation on mobile

The mobile version offers faster access to the specific topic in the article by using accordions to navigate long articles on mobile. The breadcrumbs, search and table of contents will remain at the top of the article.

Example of a documentation article on mobile.

The design

The design follows the style set by the News redesign. It is cleaner, jazzier and the new template opens the canvas to improve readability. Using also the same typography connects this design to the redesign of WordPress.

The color palette is simple and muted so as to not interfere with the multiple videos and screenshots used within the articles.

The work started at WCEU 2019 Contributors Day in Berlin. The following articles describe the work previously done.

Props to @milana_cap, @kenshino, and @atachibana for their direction on this project.

Props to @tobiasfeistmantl, @fmellitzer, @davidvie, @majaloncar, @pendraq, @igorel, @nobnob, @marcio-zebedeu, @chaion07, @netpassprodsr, @bph, @timohaver, @dmivelli, who contributed to the reclassification project.

Props to @melchoyce, @karmatosed, and @beafialho for their design guidance.

Props to @webcommsat and @marybaum for reviewing and editing help of this article.

#docs, #helphub

The first ever Documentation team Contributor Day – 25th October, 2022

On 25th October 2022 the Documentation team will organise an online, standalone 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/.. Primary goal is to catch up with a lot of tasks in team’s backlog but also an opportunity for all contributors to meet, collaborate in real time and help onboard all new contributors who need any kind of help.

If you are a first time contributor or just want to attend in order to see if documentation is for you, we have all the info you might need gathered on this link. Don’t worry if something is unclear, just show up and we’ll explain everything.

If you are experienced documentation contributor, you know you’ll need your own cookies and everything else is 10 hours of pure fun. Take a look at this GitHub issue for the list of tasks we have for the day.

Regardless of your experience level, we would like to have a record of everyone attending the Contributor Day, even if it’s just a short visit. For that purpose we’d kindly ask you to reply to this issue with your 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/ username.

Contributor Day info:

If you have any questions or suggestions, please post them in the comments below. Otherwise, see you on Tuesday 🍪🍪🍪

Summary of Docs Team Meeting October 11, 2022

Housekeeping

Attendance: @ninianepress @femkreations @milana_cap @colorful-tones @atachibana @estelaris @samanthaxmunoz @mayankgupta @webcommsat @bph
Where: #docs channel 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/.. Find the complete transcript of the meeting on Slack.
Agenda: https://make.wordpress.org/docs/2022/10/10/agenda-for-docs-team-bi-weekly-october-11-2022/
Meeting Facilitator: @ninianepress
Note Taker: @samanthaxmunoz
Next Meeting Facilitator (in two weeks): @estelaris
Next Triage Meeting Facilitator (next week): @ninianepress

Project Updates

It was a busy week for the 6.1 release cycle – many dev notes are published and some are still in review.

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. 1 is ready today as reported by @milana_cap.

@samanthaxmunoz has been working on a 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. pattern for Block Documentation and the pattern is ready for review before it is added and documented – see Issue #474.

@femkreations reviewed 333 closed PRs in 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/ from 13.1 through 14.1 with the User Documentation label and created 78 issues in GitHub for 6.1 User Documentation.

@femkreations also reviewed the About page draft and listed top priority tasks for the November 1st release. There are 25 items to do that ideally will be completed before the release of WordPress 6.1. The list is pinned to the #docs Slack channel.

Reclassification of End User Documentation

The reclassification of end user documentation has been finalized and there are now articles ready for content review.

In summary, the goal of the reclassification project is to re-organize the end user documentation and remove “too technical” content from end user documentation and/or merge it into developer docs.

An inventory of technical parts from end user documentation can be found here.

Related, 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/ Support is being renamed to Documentation – more information about that is available here, “Renaming WordPress.org Support to Documentation”.

Equal priority should be given to WordPress 6.1 documentation and the reclassification project.

Process in Project Boards Discussion

The team discussed the process for documentation project boards at length. As it stands there are only 2 columns, “In Progress” and “Review”, which are not clear and were discussed last week.

Various ideas were suggested about how to organize the project boards including separating into “new documentation” and “existing documentation”.

A consideration is that during Contributor Days often issues get screenshots and content updates in the comments of the issue, but the articles are not updated or assigned.

New columns have been added with temporary names such as “Text in progress” and “Screenshots in progress” but will likely continue to be refined.

The discussion will continue asynchronously or during the next meeting.

Open Floor

An Online Contributors Day for the Docs Team was discussed and will take place on October 25th starting at 10 am UTC.

@mayankgupta mentioned that DesktopServer has been discontinued yet is referenced in several documentation articles and has created an issue where mentions of DesktopServer are being noted.

#docs, #meetings, #summary

X-post: Renaming WordPress.org Support to Documentation

X-post from +make.wordpress.org/meta: Renaming WordPress.org Support to Documentation