Milana Cap 8:00 am on June 13, 2022  

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.

Sagar Gurnani 7:37 am on July 23, 2024  

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

Attendance

@milana_cap @leonnugraha @sagargurnani @atachibana @calolan @estelaris @lumiblog @khokansardar

Housekeeping

Find the complete Transcript of the meeting on Slack.

Upcoming Meeting

Note: On July 30, 2024 at 14:00 UTC (the 5th Tuesday of the week) will be the 2nd monthly 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/..

Project Checks

@leonnugraha did a content review and updated the WordPress version page (#1653) and labelled some untagged issues in our repo.

@milana_cap is working 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.

@calolan had updated and screenshots and the videos for the 6.5 version to tickets #1503, #1504, #1512 and #1513.

@atachibana had updated the “Keyboard Shortcut” page as per the new 6.6 features (#1617).

Estela’s Updates

    1. She would be posting the notes for the translation and localization meeting in Team Updates.
    2. She needs to confirm an item with 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 that, at the beginning of July, all Rosetta sites were moved to the new template, thus 3 sites (the only ones she could identify) lost their link to the Codex in their language so she needs to know what happened to all of that information.
    3. She is going through the issues from 6.5, updating articles and closing them.
    Leonardus Nugraha 3:46 am on July 18, 2024
    Tags: ,   

    Online monthly Docs Team Contributor Day July 23 & 30, 2024

    The Documentation Team holds an online, monthly Contributor Day on the fourth Tuesday of every month, but a little special this month, we’ll do it twice! The focus for this month is to help with the WordPress 6.6 end-user documentation.

    Anyone who wishes to contribute to the team and who follows the Code of Conduct may join.

    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, July 23, 2024, 1:00-4:00 PM UTC and Tuesday, July 30, 2024, 1:00-4:00 PM UTC

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

    Onboarding on Zoom

    In addition to the details in 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/ issue for this Contributor Day, folks who need 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 (TBA) 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

    Leonardus Nugraha 4:01 am on July 16, 2024  

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

    The next meeting is scheduled with the following details:

    When: Tuesday, July 16, 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. @estelaris updates.
    6. Open floor.

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

    Sagar Gurnani 6:06 pm on July 8, 2024
    Tags: , ,   

    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.

    #docs, #meetings, #summary

    Anand Upadhyay 12:08 pm on July 1, 2024  

    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

    Carolin Cabezas 4:42 pm on June 19, 2024  

    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.

    Sagar Gurnani 8:34 am on June 18, 2024
    Tags: , ,   

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

    The next meeting is scheduled with the following details:

    When: Tuesday, 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.

    #docs, #meetings, #summary

    Estela Rueda 8:04 pm on June 10, 2024  

    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.