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

LucP 7:08 pm on July 5, 2022
Tags: ,   

Summary of Docs Team Biweekly Meeting July 5th, 2022

Housekeeping

Projects checks

DevHub & Learn WordPress development

  • The #meta team is working on improvements to DevHub (the developers documentation). If you have any suggestions, please comment on this post
  • There is also an x-post from the Learn team. Again, if you are interesting in either collaborating or have ideas, please comment. The docs team is actively contributing with the Learn team.

Open Floor

  • @mburridge wanted clarification on whether to continue creating 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 issues in the Documentation-Issue-Tracker. (see issues #379 and #75).
  • While the Block Editor Handbook falls under the 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/ team, @milana_cap mentioned in one of the issues that we might as well gather all issues regarding the Block Editor Handbook in the Documentation-Issue-Tracker while the docs team is preparing to send over a larger issue to the Gutenberg team with all sorts of improvements.
  • Similar issues as #379 and #75 should be posted in #docs so the team can take a look at it. @milana_cap later clarified the point on slack

Props to @greenshady for helping with notes.

Estela Rueda 10:32 am on July 5, 2022  

Agenda for docs team bi-weekly meeting 5 July 2022

The next meeting is scheduled with the following details:

When: Tuesday, July 5, 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. Exploration: Improving DevHub
  5. Learn WordPress development: creating a public roadmap for content creation
  6. Open floor

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

Tellyworth 5:38 am on July 1, 2022
Tags: ,   

X-post: Exploration: improving DevHub

X-post from +make.wordpress.org/meta: Exploration: improving DevHub

Jonathan Bossenger 9:32 am on June 30, 2022
Tags: ,   

X-post: Learn WordPress Development: Creating a Public Roadmap for Content Creation

X-post from +make.wordpress.org/training: Learn WordPress Development: Creating a Public Roadmap for Content Creation

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