Milana Cap 2:06 pm on September 25, 2023  

End-user docs repo – workflows and settings

As you may know, the Documentation team is starting a collaboration with other teams, mainly Polyglots, in translating complete end-user documentation (HelpHub). This documentation and its many translations will have a new place to live: 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 WordPress/documentation-end-user.

Before we start translating, we must move all existing docs to the repo. After that is done, all translations, as well as creating new documentation in English and updating the existing one, will happen in that same repository.

This means a lot of new contributors, new contributor roles, different workflows, and different processes… Rather than letting the mess dictate our repo settings and workflows, let’s try to use our experience with Issue Tracker and predict possible problems and needs.

For this purpose, a new GitHub project is created: End-user docs repo – workflows and settings.

As a starting point, let’s identify different user roles contributing to the end-user docs repo and what would make their contributions easier and more streamlined.

All the issues are created as user stories and are only concerned with a single problem.

At this point, there are the following settings in the project. These might be incomplete and/or wrong, which we will know in time.

Persona

  • First-time contributor
  • Experienced contributor
  • Repo maintainer
  • Issues coordinator
  • First-time reviewer
  • Experienced reviewer
  • Translator
  • Translation editor
  • Any contributor

The life cycle of an issue

  • Creating issue
  • Updating screenshots
  • Creating new documentation
  • Reviewing issue
  • Managing issue
  • Working on issue

Type of workflow

  • Automation
  • Manual
  • Template (issue and pull request)

The end result of this effort should give us the idea of the following:

  • How the issue/pull request is named – template
  • What is the structure of the issue/pull request
  • The list of labels with descriptions and explanations of when to use them
  • Automated tasks
  • The life cycle of the issue/pull request
  • Well-defined user roles and their responsibilities

Feel free to start adding new stories and keep in mind to focus on a single problem per issue.

Sagar Gurnani 7:41 pm on September 1, 2023
Tags: , ,   

Agenda for Docs Team Biweekly Meeting (05-Sep-2023)

The next meeting is scheduled with the following details:

When: Tuesday, 05-Sep-2023 14:00 UTC

Where: #docs channel on Slack

Agenda:

  1. Attendance.
  2. Note-taker and facilitator selection for the next docs team meeting.
  3. Facilitator selection for the next triage.
  4. Project check.
  5. Open floor.
    • Review of the latest docs redesign in Figma.
    • The proposal for documentation translation/localization.

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

#docs #meetings #agenda

Leonardus Nugraha 6:11 am on August 15, 2023
Tags: ,   

Agenda for Docs Team bi-weekly meeting August 15, 2023

The next meeting is scheduled with the following details:

When: Tuesday, 15 August 2023, 02:00 PM UTC

Where: #docs channel on Slack

Agenda:

  1. Attendance
  2. Upcoming meeting and Docs 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/. schedule
  3. Note-taker and facilitator selection for the next meeting
  4. Facilitator selection for the next triage meeting
  5. Project check
  6. Open floor

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

#agenda, #meetings

Jenni McKinnon 1:30 am on July 24, 2023
Tags: ,   

Online monthly Docs Team Contributor Day July 25, 2023

The Documentation Team holds an online, monthly Contributor Day on the fourth Tuesday of every month. Any one may join who wishes to contribute to the team and who follows the Code of Conduct.

The next Docs Team 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/.

The next monthly online Docs Team Contributor Day will be:

When: Tuesday, 25 July 2023, 1:00-4:00 PM UTC

Where: #docs channel on Slack, and on Zoom.

Please also see Contributor Day — 25 July, 2023 on 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/ for onboarding and other important details.

Onboarding on Zoom

In addition to the details in the GitHub issue for this Contributor Day, folks who are in need of onboarding can ask in 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/. or on the Zoom call. In Zoom, a breakout room will be started where contributors can be onboarded.

If at any time you have any questions, please feel free to ask in the #docs channel on Slack or in Zoom throughout the day.

After Contributor Day

Other than celebrating with some 🍪🍪🍪 after Contributor Day is over, please also comment on the corresponding GitHub issue with:

  1. 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/ profile username
  2. What you worked on and include links when possible.

Or, just comment anything (such as your WordPress.org username) to let the team know you attended.

#contributor-day, #docs

Femy Praseeth 2:48 pm on July 18, 2023
Tags: 6.3, ,   

Call for volunteers to help with 6.3 end-user documentation

The Docs team needs your help to update and revise the End User Documentation (HelpHub) for the upcoming WordPress 6.3 release, expected on August 8th, 2023.

You can find a list of all the tasks in the 6.3 project board in the Documentation’s repo on 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/.

The tasks have been sorted into medium priority tasks and high priority tasks. The team plans to complete the high priority tasks by the 6.3 scheduled release date.

How you can help

If you are new to the Docs team, you can select from the list of good first issues.

If you are new to contributing to WordPress, you can review this onboarding post with training videos and links to help you get started.

Once a task is assigned to you, the following two videos show how to help with updating the existing articles in End User Documentation (HelpHub).

Video onboarding to End User documentation

Video showing how to help with updating the existing articles on GitHub (referencing 6.2 in this video)

Once you complete the updates for the task, add a comment to the issue you worked on, noting that you have made the changes, and tag the Docs team (@femkreations, @Leonardus-Nugraha or @jennimckinnon). Someone from the Docs team will review the updates and add the content to the article. 

If you have questions or need help, ask in the docs channel on the Make WordPress 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/. or directly in the GitHub issue itself.

If your meetupMeetup All local/regional gatherings that are officially a part of the WordPress world but are not WordCamps are organized through https://www.meetup.com/. A meetup is typically a chance for local WordPress users to get together and share new ideas and seek help from one another. Searching for ‘WordPress’ on meetup.com will help you find options in your area. or company can give 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. of time to help, do include the Release co-leads for 6.3 documentation in your message: (Slack IDs) @Femy, @Leonardus Nugraha, @611shabnam.

Resources

If you need a test site with WordPress 6.3 pre-installed, you can use this app provided by InstaWP to spin up a new temporary website set. It is preloaded with Theme Test data and other pre-configuration, ready to go. This new site will be available to use for four hours. After that, if you need another test site to contribute to docs, you can visit the link again and create a new temporary site.


Props to @leonnugraha for reviewing this article.

#6-3, #docs, #helphub

Leonardus Nugraha 3:26 am on June 23, 2023  

Summary for Docs Team meeting, June 20, 2023

Attendance

@ninianepress @leonnugraha @milana_cap @atachibana @estelaris @stevenlinx @jominney @sagargurnani @cold-iron-chef @611shabnam @emmaht @pekkakortelainen @sumitsingh @fahimmurshed @krupalpanchal @geisthanen @kenshino

Housekeeping

Find the complete Transcript of the meeting on Slack.

The next Docs Team 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/.

The next meeting schedule will be dedicated to the online Docs Team Contributor Day with the following details:

When: Tuesday, June 27, 2023, 1:00-4:00 PM UTC

Where: #docs channel on Slack, and Zoom.

Upcoming meeting

The next Docs Team meeting will be a regular bi-weekly meeting held on July 4, 2023. @leonnugraha will be the facilitator, and @sagargurnani will be the note-taker.

Project checks

@milana_cap completed 4 out of 5 issues assigned during the last triage (#838, #818, #428, and #498)

@sagargurnani contributed to #498

@atachibana closed #739 and #744

@leonnugraha worked on the Dev Notes tracking issue for WordPress 6.3 release

@cold-iron-chef added screenshots and videos for #282 and #694

@estelaris started looking into the review of mobile end-user documentation and planning to start gathering end-user documentation for the WordPress Playground.

@611shabnam reviewed #825 and #672, and worked on #687

@pekkakortelainen reviewed #469

@jominney completed #715 and updated 11 docs related to the ticket.

Zoom onboarding session and Contributor Mentorship Program

@ninianepress is setting up an onboarding Zoom call and is still open for new contributors who want to join. The session will be a live onboarding training and live Q&A.

She’s currently collecting information on who would like to attend the event to determine the session time. If you’re interested, you can contact her on Slack or comment in the Slack thread.

@milana_cap proposed the idea of having an onboarding cycle every one or two months. In addition, @jominney pointed out the Contributor Mentorship Program, which the Docs Team is picked to be one of the teams for the project pilot.

If you would like to learn more about the Contributor Mentorship Program, read this Community Team blog post.

New 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/ Project feature

@stevenlinx informed the team about the new feature in GitHub for creating a project template.

This feature streamlines the tedious project board creation process that the Docs Team does and uses for every WordPress release. @stevenlinx has created a template for the WordPress release project board called WP X.Y Documentation Template, and it was also used for the creation of the WP 6.3 project board.

Open floor

@estelaris brought up a discussion about the team dashboard and stats related to the WCEU’s Q&A session and what the Docs Team would like to measure.

@pekkakortelainen suggested having a graph to visualize the amount of opened and closed issues.

@ninianepress suggested the following points:

  • How many issues are open
  • How many issues have been closed
  • How many new ones have been created in the last month
  • The rate at which new issues are open
  • The rate at which issues are closed

@milana_cap suggested that we can track the number of tasks that the team does:

  • Updated articles
  • Updated screenshots
  • Reviewed articles
  • Run meetings
  • Written agendas
  • Written summaries
  • Onboarding sessions
  • Time for a fully onboarded contributor

The discussion for the team stats will be continued on Docs Team Contributor Day and the next meeting if necessary.

#docs, #meetings, #summary

Jenni McKinnon 12:45 am on June 19, 2023
Tags: ,   

Agenda for Docs Team bi-weekly meeting June 20, 2023

The next meeting is scheduled with the following details:

When: Tuesday, 20 June 2023, 02:00 PM UTC

Where: #docs channel on Slack

Agenda:

  1. Attendance
  2. Note-taker and facilitator selection for next meeting
  3. Facilitator selection for next triage meeting
  4. Project checks
  5. Extra onboarding sessions on Zoom
  6. Open floor

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

#agenda, #meetings

Jenni McKinnon 1:44 pm on May 16, 2023
Tags: ,   

Agenda for Docs Team bi-weekly meeting May 16, 2023

The next meeting is scheduled with the following details:

When: Tuesday, 16 May 2023, 02:00 PM UTC

Where: #docs channel on Slack

Agenda:

  1. Attendance
  2. Note-taker and facilitator selection for next meeting
  3. Facilitator selection for next triage meeting
  4. Projects checks
  5. URLURL A specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org changes
  6. Open floor

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

#agenda, #meetings

Estela Rueda 2:11 pm on April 10, 2023
Tags:   

Introducing the Advanced Administration handbook

During the recategorization of the documentation, the team removed several articles that were developer-focused or included a lot of developer-jargon. All these articles are now part of the Advanced Administration Handbook and will be removed from /documentation/devhub/.

The redirects have been applied as indicated in issue #59. Some articles have been merged to provide better explanations. Although, the maintenance is still ongoing, most of the articles have been updated.

Please report any issues to the documentation GitHub issue tracker.

Props to @ryelle and @javiercasares for working on this issue.

#docs

Femy Praseeth 10:12 pm on March 15, 2023
Tags: 6.2, ,   

Call for volunteers to help with 6.2 end user documentation

The Docs team needs your help to update and revise the End User Documentation (HelpHub) for the upcoming WordPress 6.2 release, expected on March 28, 2023.

You can find a list of all the tasks in the 6.2 project board in the Documentation’s repo on 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/.

The tasks have been sorted into medium priority tasks and high priority tasks. The team plans to complete the high priority tasks by the 6.2 scheduled release date.

How you can help

If you are new to the Docs team, you can select from the list of good first issues.

If you are new to contributing to WordPress, you can review this onboarding post with training videos and links to help you get started.

Based on what you are interested in, review the medium priority tasks, high priority tasks or good first issues.

Mention in a comment on the GitHub issue you would like to work on and someone on the Docs team will assign it to you.

Once a task is assigned to you, the following two videos show how to help with updating the existing articles in End User Documentation (HelpHub).

Video onboarding to End User documentation

Video showing how to help with updating the existing articles on GitHub

If you have questions or need help, ask in the docs channel on the Make WordPress 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/. or directly in the GitHub issue itself. If your meetupMeetup All local/regional gatherings that are officially a part of the WordPress world but are not WordCamps are organized through https://www.meetup.com/. A meetup is typically a chance for local WordPress users to get together and share new ideas and seek help from one another. Searching for ‘WordPress’ on meetup.com will help you find options in your area. or firm can give 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. of time to help, do include the Release co-leads for 6.2 documentation in your message: (Slack IDs) @bph, @zzap, @Femy, and @abhanonstopnewsuk.

Resources

If you need a test site with WordPress 6.2 pre-installed, you can use this app provided by InstaWP to spin up a new temporary website set. It is preloaded with Theme Test data and other pre-configuration, ready to go. This new site will be available to use for four hours. After that, if you need another test site to contribute to docs, you can visit the link again and create a new temporary site.


Props to @bph @webcommsat @milana_cap for collaborating and reviewing this article.

#6-2, #docs, #helphub