Agenda for Docs Team Meeting October 05, 2020

The next meeting is scheduled with the following details:

When: Monday, October 05, 2020, 15: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/..

Meeting agenda

  1. Project Updates
  2. External Linking Policy
  3. Docs Videos
  4. New Member Mentoring
  5. Monthly Coffee Break Update (October 2020)
  6. Google Season of Docs 2020
  7. Open Floor

#agenda, #meeting

Digital Checking 🐝-Docs team for the week of October 5, 2020

Our Digital Check-in for this week:
Please share the following in the comments:

  • What did you work on last week?
  • What would you like to work on this week?
  • What are your blockers (things that stand in your way of your work) ?

Our reading list for this week:

Contributor Links

Looking forward to ‘seeing’ many of you at the next 🐝 docs Slack meeting on October 12, 2020 at 14:00 UTC

Summary for Docs Team Meeting on 28 September 2020

Attendance

@justinahinon, @milana_cap, @dianamivelli,  @chaion07, @crstauf@tacitonic@bph@sukafia, Leslie Liszcz, @softservenet, @paaljoachim, @yui, @fahimmurshed, @tjnowell, @bizanimesh, @kartiks16, @kulsumsiddique 

Thanks to @chaion07 for Facilitating the Meeting.

Notetaker & Facilitator Selection

Notetaker: We could use a few volunteers to take notes for our weekly meetings. If you want to help then please comment here or let us know during our meetings.

Facilitator for the next meeting: @justinahinon

Next Meeting: 5 October 2020

Find the full transcript of our meeting 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/.

Project updates

@milana_cap recorded a video about setting up a local HelpHub for development and will upload it to the GDrive.

@bph inform us that the bee-docs team is getting all existing pages to 5.5 state.

  • WordPress 5.5 – 35
  • WordPress 5.4 – 12
  • WordPress 5.3 – 2
  • WordPress 5.0 – 17
  • Pre WordPress 5.0 – 3

For the external linking policy we need to:

  • list all the 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 external links
  • define safe 5-10 links
  • remove the rest

The new member mentor team welcomed 4 new members: @Christopher Chism, @Veraleee, @Christian Martin, and @Akin Ocak.

We had the Monthly Coffee Break Zoom call last week, 4 members attended.

Updates on the Google Season of Docs 2020 projects:

@tacitonic reported this week:

  • I’ve completed the Document Guidelines section, with the exception of External Sources. I’ll write that after a final policy has been established.
  • Currently working on the Language and Grammar section.
  • I update my progress in the README file daily: https://github.com/WordPress/WordPress-Documentation-Style-Guide
  • The location for the Style Guide is yet to be determined. I was thinking about a simple URLURL A specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org similar to developers.google.com/style.

@dianamivelli begun working on 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/ for the classification project and will start tracking progress and content in that repository. In the meantime, @estelaris will open a ticket to move the repository to WordPress.

Open Floor

Last week, @joyously mentioned that the page on how to contribute to the block editor was difficult to find. There was a discussion and as a quick fix, the team agreed to upload a link to the welcome box.

The team is asking the team reps to decide where will be the best place to add that link for easy finding. @milana_capsuggested a 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. with all the “Get Start” links and are waiting for response from @kenshinoand @atachibana.

Our band is growing, as suggested by @milana_cap we are listing the musicians in our team.

#meeting-notes#meetings

Agenda for Docs Team Meeting September 28, 2020

The next meeting is scheduled with the following details:

When: Monday, September 28, 2020, 15:00 UTC

Where: #docs channel on Slack.

Meeting Agenda

  1. Project Updates
  2. External Linking Policy
  3. Docs Videos
  4. New Member Mentoring
  5. Monthly Coffee Break Update (September 2020)
  6. Google Season of Docs 2020
  7. Open Floor

“Do not allow your fire to go out.Spark by irreplaceable spark in the hopeless swamps of the not-quite, the not-yet, and the not at all. Do not let the hero in your soul perish in lonely frustration for the life you deserved and have never been able to reach. The world you desire can be won. It exists. It is real. It is possible. It is yours.” 

Ayn Rand

#agenda, #meetings

Summary for Docs Team Meeting on 21 September 2020

Attendance

@justinahinon, @dianamivelli, @estelaris, @kartiks16, @tacitonic, @chaion07, @atachibana, @sukafia, @bobbingwide, @kulsumsiddique, @mkaz.

Thanks to @estelaris for Facilitating the Meeting.

Notetaker & Facilitator Selection

Notetaker: We could use a few volunteers to take notes for our weekly meetings. If you want to help then please comment here or let us know during our meetings.

Facilitator for the next meeting: @chaion07

Next Meeting: 28 September 2020

Find the complete Transcript of the meeting 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/..

Project Updates

@milana_cap updated badges page with a new document and a process for tracking contributions. (asynch to the meeting)

@atachibana reported on the migrationMigration Moving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. and re-routing of Codex to Code:

  • 29 Classes out 43 have been completed which is an improvement of 7.4% leading to 67.4% from last week’s 60.5%, and
  • 51 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. out of 355 have been completed which is an improvement of 2.6% leading to 14.4% from last week’s 11.8%.
  • @atachibana thanked @stevenlinx for the contribution.
  • He also did some housekeeping on Codex this week and welcomed suggestions from everyone.

@bph also provided an update beforehand on Digital check in for 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 Documentation (BEE-docs). Birgit requested that the BEE-docs team members leave comments on that post. (async to the meeting)

Docs Videos

@milana_cap fully recorded a contributing video and forgot to silent nearby devices and as a result there were a lot of background noises in the recording. Eventually had to delete it and she’ll attempt to re-record it. (async to the meeting)

External Linking Policy

@milana_cap reported prior to the meeting that the team started with the Plugin Developer Handbook for the discussion on External Linking Policy. @themiked outlined two phases. Please let Milana know if help is needed with this. We want to make the entire process transparent and publish on our blog. It’ll also help with defining the workflow for the other parts of #docs.

@themiked also reported that the goal is to compile a list of all the links on all the pages in the 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 guide and start with that, hopefully deleting them all and then adding back the ones on the approved domain list (asynch to the meeting).

New Member Mentoring Team

Due to everyone’s commitments, the Mentoring Team isn’t being able to properly focus on the Mentoring process for the past few weeks. The team is looking for new people to join over Making WordPress #docs team.

Please contact @sukafia, @softservenet, @tacitonic or @Prubhtej_9 with your ideas, suggestions and comments (if any).

Monthly Coffee Break Reminder (September 2020)

@sukafia provided the team with the schedule for the Monthly Coffee Break for September 2020.

Please 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.” @sukafia or @chaion07 if you require further assistance.

Google Season of Docs

@tacitonic reported:

  • Working Repository has been transferred to the WordPress organization on 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/.
  • Almost done with the first section. You can read more about it here: https://github.com/WordPress/WordPress-Documentation-Style-Guide/tree/master/docs/2-document-guidelines (Overall status: one week ahead of schedule).
  • Waiting for a confirmation from the #docs team for a suitable location for the Style Guide on 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/ for a request that was made on the 15th of September

@dianamivelli reported:

  • Been reading HelpHub topics, making sure the titles are applicable, and suggesting new titles for some.
  • Raised the topic of identifying a consistent title style such as action+object for the title, when possible.
  • Further discussion is being done on a private Slack channel consisting folks from the #docs team that @estelaris had opened.

@estelaris added:

  • The Slack group includes both Technical Writers and all four mentors to discuss any topic that relates to both projects, as we will coincide in certain points and it is good to agree on the best approaches.
  • The big topic discussed this week was ‘Article Titles’. Removing Gerunds and adding an action+object title.
  • Also discussed the use of one-word titles.

The Technical Writers will be following the Handbook Grammar Guide as always. Thanks to @atachibana for sharing the link.

Open Floor

@bobbingwide asked if WordPress documentation could be kept up to date with the latest release? @estelaris answered that it would be really nice and the team is working hard to reach that goal. But since we had to migrate the articles from one site to another, we are taking the time to also update those articles. Another team is working on a new design for the pages. The Google Season of Docs Team is working on a new writing style guide and a new classification to implement a new navigation to documentation. There is also the Release Team who is working on adding documentation on the new releases. Not to mention the typos, broken links, small updates, etc that need constant upkeep.  With too many moving parts the team is working very hard and will reach our goal of having up-to-date, easy to find documentation soon.

@bobbingwide further asked, How committed is the Release Team to delivering the documentation for the new release concurrently with the new release? @joyously advised this question to be addressed in the Dev Chat and the editor in particular should be documented before being incorporated into coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress..

@bobbingwide also asked on the point of view of the docs team? @estelaris replied saying that the Release Team is very committed particularly to work on that and documentation needs to be ready before the public release.@mkaz added by saying there shouldn’t be a #docs team, that function should be a part of every feature development and those features shouldn’t be merged/released without documentation. @estelaris also shared the link to the 2020 WordPress Release Squad and another link to the WordPress 5.6 Release Planning @makz added by saying that it should be more integrated into the development of the features- if something doesn’t get merged without documentation, then you wouldn’t need a documentation squad for the release, by default it would be there.@justinahinon added async to the meeting by saying that one of the roles of the Release Documentation Team is to ensure that new things that come in the release receive proper documentation. So approximately 90% (estimation), new stuff in a release are documented by the date of the release. @estelaris invited @bobbingwide to attend the Dev Chats in the #core channel on Wednesdays at 8 PM UTC. @themiked added by saying that this may not be a priority for the Dev Team as there should be a docs representative for every release.

@tomjn asked if there is a document for how to contribute to docs that has all the things? @estelaris shared a link to the Docs Handbook. @mkaz also shared a link to the Block Editor Handbook. @jouisly suggested that the Handbook should be easier to discover.

@milana_cap suggested that we should make a list of the musicians in our team. She also shared her list and requested others who can play an instrument or into music to comment in this post.

#meeting-notes, #meetings

Digital check-in for Block-editor end user documentation (🐝 docs) team (9/21/2020)

Our Digital Check-in for this week:
Please share the following in the comments:

  • What did you work on last week?
  • What would you like to work on this week?
  • What are your blockers (things that stand in your way of your work) ?

Links

Looking forward to ‘seeing’ many of you at the next 🐝 docs 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/. meeting on September 28, 2020 at 14:00 UTC

External Linking Policy – Meeting Notes August 25th

Attendance: @kenshino, @joostdevalk, @mkaz, @cbringmann, @andreamiddleton, @justinahinon, @wpza, @themiked, @milana_cap, @chaion07

Unfortunately, Zoom recording doesn’t display participants’ names, so it can be difficult to recognise people who had cameras turned off. If you attended the meeting and your name is not on the list, please let me know, and I’ll add it.

Agenda: https://make.wordpress.org/docs/2020/08/24/external-linking-policy-zoom-meeting-agenda/ 

Video recording of the meeting: https://drive.google.com/file/d/1KnB9PQHZDGBGc6Zn2f7FCZsLMnIsTmGu/view?usp=sharing 

Summary

In short, we’re allowing external links. We discussed that by virtue of an entity being a commercial one doesn’t make it undesirable. We’re proposing to start this slowly and the policy will mature as things move along. We’ll make a separate post on P2P2 P2 or O2 is the term people use to refer to the Make WordPress blog. It can be found at https://make.wordpress.org/. to define the policy a little further and leave it for a period of time for feedback.

Brief introduction and goals of the policy

As you know, official  documentation has moved from Codex to WordPress. The whole content is updated, including screenshots and facts. We are required to take care of external links.

We should keep in mind that Documentation will soon have its official license. We agreed to have GPLGPL GPL is an acronym for GNU Public License. It is the standard license WordPress uses for Open Source licensing https://wordpress.org/about/license/. The GPL is a ‘copyleft’ license https://www.gnu.org/licenses/copyleft.en.html. This means that derivative work can only be distributed under the same license terms. This is in distinction to permissive free software licenses, of which the BSD license and the MIT License are widely used examples. v2+ but there is a high chance that we will consider making this multi license and add one that is more appropriate for documentation. 

Throughout the official documentation on 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/, we have taken care not to directly recommend any plugins, themes, products or services. We have so far been only documenting what is inside the WordPress software, that comes in a zip file you download from the official WordPress website.

We want to make sure the external content we are linking to is expanding the content in the documentation. That content should also be free for consumption, meaning it is not behind any paywall or other additional action required from the user.

We want to ensure our user’s privacy is intact, meaning we don’t want any tracking links.

License

Policy considered: External resources should publish content under a license compatible with GPL v2+, and this should be visible on their website.

Conclusion: This is beyond our control and sets hard limits on the number of resources that meet these criteria. There is likely to be a hard line for sites that promote non-GPL derivatives of WordPress which is consistent throughout the project. Rather than insisting on the presence of a GPL compatible license, we should focus on content that is NOT breaking or advocating against GPL.

Promotion, affiliates, paywalls, tracking

Policy considered: External resources will not promote any 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, theme, product, or service on the page we’re linking to. No affiliate links allowed in content, and the content as a whole is free for consumption without requirements from the user to pay, subscribe, or share on social media.

Conclusion: This remains as is. The scope of promotions and affiliate links expands to the whole page instead of just the content, while tracking links are limited to the URLURL A specific web address of a website or web page on the Internet, such as a website’s URL www.wordpress.org itself. The URL that we place inside WordPress.org documentation can not contain any tracking or referral codes. 

Direction

“Whatever we discuss here should apply to other parts of WordPress.org too.” – @kenshino

We should be focusing on the spirit of openness. Focus on what we want, rather than what we don’t want. Describe what is desired from external resources to have, and if possible, show examples. 

“These are the cases where we see the value or a need for external linking and anything we link to should meet these expectations…. Websites should uphold the values and principles of WordPress.” – @andreamiddleton

Next steps

Slowly building “allowed list”

Advice by @andreamiddleton on moving forward:

  • Start with a Plugin Developer Handbook, as there are leftovers from Codex. 
  • Identify five to ten safe resources without profit motives and supported by stable organizations, which we are confident will  not break (cease to exist, turn into link farms etc), e.g. MDN and ReactReact React is a JavaScript library that makes it easy to reason about, construct, and maintain stateless and stateful user interfaces. https://reactjs.org/. docs.
  • Define the time period in which a new group of resources will be reviewed and vetted, and create a way for people to suggest new ones. Meanwhile, consolidate the proposed links.
  • The documentation team should be public in its decision on which links are allowed. In the case that a disagreement cannot be resolved amicably by the documentation team, it should be escalated to the Executive Director or the Project Lead. (This was discussed and added post call)

Community members

Besides these safe resources, we can also define what makes a single person’s content trustworthy following the criteria:

  • A historically proven positive contributor.
  • Gives sound advice.
  • Nurtures WordPress’s values and principles in contributions and the community.

Whenever this personal content appears to fit well in current WordPress documentation, it is advised that the Documentation team try to import it, whether by asking the author to contribute it to the official documentation or asking the author’s permission for the team to do that by themselves. 

#external-linking-policy

Agenda for Docs Team Meeting September 14, 2020

When: Monday, September 14, 2020, 15:00 UTC

Where: #docs channel on Slack.

Meeting Agenda

  1. Attendance
  2. Meeting Note-taker & Facilitator for next week’s meeting
  3. Project Updates
  4. External Linking Policy
  5. Docs Videos
  6. New Member Mentoring
  7. Monthly Coffee Break Reminder (September 2020)
  8. Google Season of Docs 2020 Updates
  9. Open Floor

#agenda, #meetings

Summary for Docs Team Meeting: September 07, 2020

Attendance

@chaion07 @atachibana @collinsmbaka @sasiddiqui @crstauf @tacitonic @lvg2013 @kafleg @manthanadmane @sukafia @fahimmurshed @justinahinon @rifatalif @estelaris.

Agenda

You can find the Agenda here.

Notetaker: @b-07

Notes Reviewed by: @chaion07

Facilitator: @chaion07

Facilitator for Next Meeting: @tacitonic

Follow the meeting on the Slack channel for Docs.

Project Updates

@atachibana mentioned that @stevenlinx and himself are working on the migrationMigration Moving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. and re-routing of codex to code reference for

  • Classes: 25 of 43 (58.1% < 48.8%)
  • 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.: 33 of 355 (9.3 < 7.3%)

External Linking Policy

@milana_cap is nearly done with the meeting notes draft for external linking policy and contributing video for setting up HelpHub in local. She’ll share those soon.

Docs Videos

We will hopefully have a contributing video for setting up HelpHub in local as @milana_cap is currently working on it.

New Member Mentor Training

@tacitonic provided new members update:  8 people have joined #docs last week. If anyone have a question or an inquiry then they are advised to reach out to @sukafia @softservenet @prubhtej or @tacitonic.

Monthly Coffee Break September 2020

@sukafia informed the team about The Monthly Coffee Break which is set for September 24, Thursday and will have an American friendly time. He further suggested that we adopt a time within lunch break hour instead of creating a Doodle.

Google Season of Docs 2020

@milana_cap, @felipeelia, and @tacitonic discussed regarding any additions/changes @tacitonic’s proposal. They will be reviewing it and we’ll decide whether we want to have a call on that. The new 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 is yet to be created.

@dmivelli will give updates every 4 weeks approximately to the team here so we can move on.

@timohaver and @estelaris will help in reviewing articles to suggest a classification inside the 4 pillars (first run), there will be at least a second review of the articles depending on @dmivelli ‘s goals.

Open Floor

There was nothing much discussed on the open floor. So @chaion07 ended the meeting with this great quote from Henry Ford:

Don’t find fault, find a remedy

Agenda for Docs Team Meeting September 07, 2020

The next meeting is scheduled with the following details:

When: Monday, September 7, 2020, 15:00 UTC

Where: #docs channel on Slack.

Meeting Agenda

  1. Project Updates
  2. External Linking Policy
  3. Docs Videos
  4. New Member Mentoring
  5. Monthly Coffee Break Reminder (September 2020)
  6. Google Season of Docs 2020
  7. Open Floor

Please add comments with your suggestions or for any changes.

I want to add a quote by Henry Ford for this week:

Don’t find fault, find a remedy

Henry Ford

#agenda, #meetings