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/

A more recent onboarding session, recorded on 28th July 2023, can be found here: https://wordpress.tv/2023/08/01/jenni-mckinnon-milana-cap-wordpress-documentation-team-onboarding-july-2023/

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

Github related roles

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

Summary for Docs Team Meeting (02-Jul-2024)

Attendance

@milana_cap @atachibana @sagargurnani @anandau14 @sumitsingh @vishal4669 @voboghure @cold-iron-chef @estelaris (async) @mobarak (async)

Housekeeping

Find the complete Transcript of the meeting on Slack.

Upcoming Meeting

Project Checks

@vishal4669 had completed his first contribution for this issue: #1609 which is currently under review.

@milana_cap has been busy spending her time on WP-CLIWP-CLI WP-CLI is the Command Line Interface for WordPress, used to do administrative and development tasks in a programmatic way. The project page is http://wp-cli.org/ https://make.wordpress.org/cli/ article for CoreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. Dev Blog.

@atachibana has reviewed #1510 & #1511 and then closed #1616.

Open Floor

  1. @estelaris mentioned that we (docs team) are having lots of reports of broken images in our posts, the ones she checked are coming from images linked from 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/ which are hotlinks that break with time. She said that we need to find a better way of doing this.
    • To which @sagargurnani replied that we (docs team) never hotlink the GH issues, instead we download the screenshots from GH and upload it to the posts we are editing. And, he suggests that we need to be more careful while reviewing the tickets.
  2. @estelaris mentioned that the following articles need a review of the Font Library article for 6.5 because there are changes on 6.6 are needed to be added.
  3. @estelaris wants someone to review the following ticket (for simple Chinese language) before she approves it because it is a new way of implementation which was never followed before.

Agenda for Docs Team Biweekly Meeting (July 2, 2024)

The schedule of the next meeting is as follows:

When: Tuesday, 02-July-2024 14:00 UTC

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

Agenda:

1. Attendance.
2. Selection of a Note-taker and facilitator for the next docs team meeting (July 16, 2024).
3. Facilitator selection for the next monthly planning meeting (July 9, 2024).
4. Project check.
5. Open floor.

Please feel free to leave a comment to add to the Open floor discussion

Summary for Docs Team Discussion Meeting (18-Jun-2024)

Attendance

@milana_cap @atachibana @estelaris @anandau14 @sumitsingh @sagargurnani @themiked @calolan

Housekeeping

Find the complete Transcript of the meeting on Slack.

Upcoming Meeting 

Project Checks

@calolan is waiting on feedback on issue 1510 before moving forward to adjust her other tickets accordingly.

People who attended WCEU are working on tasks that surged from the meetings there.

Open Floor

@milana_cap Invited anyone who wants to volunteer to help documenting end user docs for 6.6. 
@JuanMa from release squad can guide with place where tasks live and what’s highest priority

@estelaris updates:

  • Continue working with the Spanish team to translate HelpHub
  • Write up the notes from the localization/translation meeting we had during WCEU (we/I/docs team have several tasks)
  • Write a proposal/discussion post for docs team regarding Matt’s request to change all documentation to “wiki”-style. I would like to invite other teams that write documentation (support, training, themes, plugins, developers) to find the best way to add this
  • Finish up the 6.5 HelpHub documentation
  • Help review anything from 6.6

@estelaris Won a Wapuu design at WCEU and had a Docapuu

@calolan asked for adding the task to the tickets. @estelaris and @milana_cap proposed to be more clear with the instructions on the tickets (example issue 1510)

@milana_cap updates:

There is an effort to utilise Playground for editing docs. It will look like this:

  • on the page there is an “Edit” button
  • you click the button and editor opens (in Playground)
  • you edit and hit another button “Submit” or something similar
  • edits are pending Docs team review
  • Docs team approve or reject

In the background, Playground will be connected 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/ for saving the content (making PRs and such). So the whole contributing experience promises to be more simple, without thinking about other platforms, accounts etc.

Agenda for Docs Team Biweekly Meeting (18-Jun-2024)

The next meeting is scheduled with the following details:

WhenTuesday, 18-May-2024 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. Design updates by @estelaris.
  6. Open floor.

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

Localization and translation of HelpHub during WCEU 2024

The team working on the localization and translation of end-user documentation (HelpHub) will meet again during 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/. at WCEU on Thursday 13 June at 12:30 UTC. Location will be announced at contributor day.

The agenda is as follows:

Goal: Create a plan of how to move forward with the localization/translation of documentation project

  1. Discussion: Cross-team communication
  2. Discussion: What does GlotPress need to move forward. GlotPress has a translation memory, but it’s not context-aware. This makes automated reuse of shorter strings harder.
  3. Discussion: Can we use GH as a docs issue tracker, in the same way global does it? Or can we take advantage of the global docs issue tracker and create labels for languages? How are other teams doing it? Spanish team started with this: https://github.com/orgs/WordPress/projects/195
  4. Request: What does 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. need to prepare Rosetta sites for the documentation page, First discussion: https://meta.trac.wordpress.org/ticket/7637

For background information, please read:

Future plans for HelpHub

Translation of End-user documentation project started at WordCamp Torrelodones (Spain)

Anyone interested in the project is welcome. If you are not attending WCEU, we will be taking live notes in #polyglots-multilingual-community on Slack

Props to @courane01, @javiercasares and @tobifjellner for reviewing the agenda.

X-post: Proposal: Learn WordPress Content Maintenance Process

X-comment from +make.wordpress.org/training: Comment on Proposal: Learn WordPress Content Maintenance Process

X-post: Training Team Update – June 2024

X-comment from +make.wordpress.org/updates: Comment on Training Team Update – June 2024

Agenda for Docs Team Biweekly Meeting (4-June-2024)

The next meeting is scheduled with the following details:

WhenTuesday, 4-June-2024 14:00 UTC

Where#docs channel on Slack

Agenda:

  1. Attendance.
  2. Note-taker and facilitator selection for the next docs team meeting.
    • Note. There will not be a Monthly Planning Meeting (triage meeting) on June 11, as the team will be on their way to WCEU.
  3. Project check.
  4. Estela’s (@estelaris) updates
  5. Open floor.

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

Agenda for Docs Team Biweekly Meeting (21-May-2024)

The next meeting is scheduled with the following details:

WhenTuesday, 21-May-2024 14:00 UTC

Where#docs channel on Slack

Agenda:

  1. Attendance.
  2. Note-taker and facilitator selection for the next docs team meeting.
    • Note. There will not be a Monthly Planning Meeting (triage meeting) on June 11, as the team will be on their way to WCEU.
  3. Project check.
  4. Estela’s (@estelaris) updates
  5. Open floor.

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

#agenda, #docs, #meetings

X-post: Recognizing Contributions and Acknowledging Challenges

X-comment from +make.wordpress.org/sustainability: Comment on Recognizing Contributions and Acknowledging Challenges