Summary for Docs Team Meeting: February 17, 2020

Attendance

@kenshino, @wpza, @sasiddiqui, @atachibana, @milana_cap, @felipeloureirosantos, @bph, @leogermani, @estelaris, @nobnob, @sukafia, @tomf, @marcio-zebedeu

Facilitator: @kenshino
Note taker: @valentinbora

Actionable points

  • @everyone to review and give feedback on the Handbook refresh efforts here
  • @leogermani to spearhead Handbook refresh efforts, @milana_cap to help with feedback
  • @leogermani to open a ticket on Trac regarding #meta statistics and invite @kenshino to draw attention from the appropriate stakeholders
  • @tomf to audit content for outdated or irrelevant WordPress.com links and compile a list
  • @estelaris to write up notes from the WCVienna working session on classifying docs and post them on this site

Next meeting

Monday, February 24, 2020, 15:00 UTC on Slack #docs (follow here)

Handbook refresh

For the detailed document, see @leogermani‘s New Handbook pages on Google Docs.

@leogermani gave an update on the Handbook refresh effort and found out that the “Welcome box” is really outdated with confusing links, so he started a proposal to change that as well as give the Handbook a new home page with a short overview and links to more detailed pages

@leogermani also raised the issue about our internal codenames such as DevHub and HelpHub which can be confusing for end-users, so instead he decided in favor of using developer.wordpress.org and wordpress.org/support, respectively

@kenshino agreed we should stop using codenames in public information and address them by their URL only or both codename + url.

@milana_cap mentioned that we might still want to explain our codenames on specific detail pages in order to help users find the appropriate Components on the Meta Trac when they wanted to raise issues

WordPress.org vs. WordPress.com

@sukafia raised the WordPress.org vs. WordPress.com issue again (reminder: people confuse the two when looking for help, documentation)

@tomf added that they had the same issue during content migration where they noticed some content linking to WordPress.com docs when it shouldn’t have (we’re only concerned with WordPress.org here)

@kenshino asked whether we had a list of content that contains outdated or irrelevant WordPress.com links and @tomf answered that we didn’t. As such, @tomf agreed to lead the effort to audit content and compile a list

Open Floor

@leogermani was tasked with reaching out to #meta for statistics but didn’t receive anything back yet and doesn’t know who to specifically reach out to. @kenshino suggested to have a ticket open on Trac to help make it happen

@estelaris organized an interactive session at WCVienna this past weekend and together reviewed a series of articles and classified them with proper categories and subcategories

For context, there is an ongoing effort to reorganize WordPress.org documentation. For details, see Working File – HelpHub Article Categories

@estelaris mentioned that some articles didn’t have proper titles, other articles were (very) outdated and finally some articles were redundant in that they only linked to other pages

@estelaris agreed to @kenshino‘s invitation to write up some notes from the working session and post them on this site

@kenshino observed the efforts of @estelaris (Categorization) and @tomf (Content Audit) to be complementary and recommended they worked together

@kenshino mentioned that @coffee2code updated everyone with the appropriate Team and Contributor badges. Also, there’s a list of people that shouldn’t be holding a Team badge anymore due to inactivity

Transcript

https://wordpress.slack.com/archives/C02RP4WU5/p1581951613217400

#docs, #meetings, #summary

Summary for Docs Team Meeting 20th January 2020

Facilitator & Attendance

Facilitator: @felipeelia

Attendance: @milana_cap, @atachibana, @marcio, @bph, @audrasjb, @tjnowell, @nullbyte, @pbrocks, @carike, @tomf, @kulsumsiddique, @nobnob, @kartikshukla, @estelaris, @kenshino, @clorith and @fierevere.

Note-taker: @audrasjb

Next week Facilitator: @kulsumsiddique

Meeting transcript on Slack

DevHub migration status

@atachibana shared some stats about this project: 322 of 1069 pages were re-routed from Codex to Code Reference, which is 30.1% of all.

This is one of the ongoing efforts of the Documentation team. If anybody wants to help, they can contact @atachibana via DM or via #docs Slack channel.

New contributors are encouraged to read this handbook page to learn more about contributing to HelpHub articles.

Discussion on the Docs team organization in general

As WordCamp Asia is coming, it would be nice to reach an agreement on two items: Team Workflows and Badges distribution.

Team workflow

It refers to reporting an issue about WordPress documentation. There is a Trello board for that. Most workflows are covered, if not all.

@milana_cap hopes to have the Workflows page published in the first week of February.

Badges

Contributors are encouraged to leave comments and suggestions on this post by the end of this week so @milana_cap can start working on a P2 proposal.

@felipeelia pointed out the example of someone who noted an error on one of the available docs and asked if they would be elligible to receive the docs contributor badge. @bph noted that it’s a micro-contribution. Several micro-contributions could lead people to receive a contributor badge. @felipeelia pointed out that it would need to keep track of each contribution in a document. @bph added that normally each contributor could keep track of it and let the Team know, when the threshold is reached.

@estalris noted that the design team do triages and people who participate on triages don’t receive a badge, because that is a micro-contribution. Only members with a specific project or role in the team are the ones that receive badges. Note: it’s for the Team badge.

Support team has a 400 replies goal to receive the contributor badge. Becoming a moderator comes with the team badge.

HelpHub

@atachibana is working on the progress and will prepare something for the next meeting.

@kenshino said he would love for that Survey to be ready to be distributed at WC Asia, in one month.

The goal is to build the questions of the survey with the general theme being “How do you think we can improve the WordPress documentation?”. Some questions using the likert scale to track how good it is now so the Team can repeat the survey in the future. Some open fields to get proper feedback so it’s possible to define future projects better.

@estelaris worked on the subcategory issue https://docs.google.com/spreadsheets/d/1qSNKiAwLbc2nLrtGLj4Ndp4-N0daZOfgazlsSYnFXqM/edit?usp=sharing. That was her first draft in trying to organize the articles, but she needs help to define the subcategories.

A discussion started about the relevancy of categorization, but the Team agreed categorization makes sense when there is a lot of content as users would be able to filter what they want to look for. @kenshino noted that we’re trying to solve a discovery issue and those won’t be solved with one method. Categorizing them is a start. But a proper search system is also necessary.

@estelaris and @atachibana are going to work together on sub-categorization system.

New readme.txt file for the Developer Handbook

@carike noted that the Core Privacy team discussed the proposed headers for readme.txt files. There is some debate about whether external calls need to be one item or split into three. Everyone agrees with the headers in general though. Next step is a meta ticket. They cannot update the readme.txt before the new headers are added, as this would lead to confusion.

Custom fields page

@leogermani edited the Custom Fields page as previously discussed. He added an entry to the Workflows card in Trello about Code reference.

#meetings, #summary

Summary for Docs Team Meeting 13th January 2020

Facilitator & Attendance

Facilitator: @leogermani

Attendance: @bph, @atachibana, @milana_cap, @kartiks16, @kenshino, @audrasjb, @pbrocks, @WPZA, @aurooba, @ibdz, @nullbyte, @estelaris, @felipeelia, @tomf, @felipeloureirosantos, @marcio-zebedeu

Note-taker: @kartiks16

Next week Facilitator: @felipeelia

Transcript

https://wordpress.slack.com/archives/C02RP4WU5/p1578926826044300

Discussion on the Docs team organization in general Workflows

We added current workflows to this trello card -> https://trello.com/c/GNXYppYS/44-workflows | If anyone wants access they can approach @milana_cap

For now, we have a few workflows defined. We are missing on reporting an issue: Gutenberg for developers handbook | any dev handbook | docs team handbook | HelpHub content

@milana_cap will add workflow of reporting the issue in trac and link to core handbook for contributing.

@leogermani will add info on DevHub

For Gutenberg dev handbook we have a workflow defined by @pbrocks

Badges

@milana_cap started the discussion in p2 https://make.wordpress.org/docs/2020/01/08/documentation-team-profile-badges/, all are requested to share their thoughts.

Docs Team Handbook
Workflows and badges pages:

Once we have all those things defined we can add those pages to docs team handbook

HelpHub
Progress of the survey :

@atachibana is working on the progress

Helphub Localization

We have it here: https://make.wordpress.org/docs/handbook/helphub/translating-helphub/

@felipeloureirosantos suggested that they don’t have updates there so far as well. There will be in the next weeks.

We have slack channel #meta-helphub as a contact point between our team and the meta team to get updates on this and speak with them about this issue.

@felipeelia mentioned here is a meta ticket for that too. https://meta.trac.wordpress.org/ticket/2082 @milana_cap will bring some more information on this in the next meeting. @kenshino suggested bringing @netweb to share thoughts

General topics

@joyously brought the topic of Custom Fields article in HelpHub (https://wordpress.org/support/article/custom-fields/), which is missing some information on how to diplay the custom fields (original codex article: http://web.archive.org/web/20160301204600/https://codex.wordpress.org/Using_Custom_Fields)

@Kenshino (Jon) and others argue that this is end-user docs and should not have this kind of information. It should have a link instead.

@felipeelia suggests to link it to: https://developer.wordpress.org/plugins/metadata/rendering-post-metadata/

@leogermani will make the edits on this topic

Remove paragraph of BitNami in the multisite considerations article

Topic brought by @René Hermenau. The pege mentioned is https://wordpress.org/support/article/before-you-create-a-network/. Everyone agreed to remove it. @atachibana will do it.

Improve docs on Multisite

Also a topic that @René Hermenau suggested, make it clearer that Multisite is a choice that brings more complexity to the installation. A quick discussion came up on how to show pros and cons so people can make a informed decision. @nullbyte would be volunteering it.

Plugins Handbook i18n

@Pascal might be able to help.

Specific headers, this kind of stuff needs to be there, @milana_cap will do that.

DevHub

Updates from @atachibana : We redirected 314 of 1069 (29.4 %) of Code Reference’s Functions part

Open Floor

@bph shared that we made progress on the meta-trac ticket. https://meta.trac.wordpress.org/ticket/4915 feel free to comment,

@bph asked should the documentation for Gutenberg End User have a section for features only available in the plugin? They are future features for Core, so it might make sense to have future features/changes. to which @leogermani responded as long as it’s clear that it’s not available in core yet, and @kenshino mentioned it should only feature Core info

@kenshino shared few small things i.e. He started a thread in the Advanced WordPress Facebook group, https://www.facebook.com/groups/advancedwp/permalink/2868239546571574/ if you are in the group. Some interesting comments so far. It is noticed that many people still don’t know that we’ve stopped updating Codex. We ought to talk about WC Asia Contributor Day and plan properly for it very soon.

@leogermani mentioned In the header of our page on make.wordpress.org/docs we have, under “Want to get involved” a phrase that says “the many Contributor handbooks” linking to our handbook. Shouldn’t it just say “Documentation team handbook”? Also, he thinks the contents of the header should also be subject to a review now that we are reviewing everything and to which @milana_cap & @kenshino suggested that we will alter it.

#meetings, #summary

Summary for Docs Team Meeting 25th November 2019

Facilitator & Attendance

Facilitator: @aurooba

Attendance: @kenshino, @nao , @bph, @kartiks16 , @mkaz, @pbrocks, @milana_cap, @estelaris, @jaime-wedholm, @arnelcus , @nullbyte, @kulsumsiddique , @ibdz

Note-taker: @kartiks16

Next week Facilitator: @kulsumsiddique

Transcript

https://wordpress.slack.com/archives/C02RP4WU5/p1574694002316200

Docs Team Handbook Discussion & Tracking Doc changes across DevHub & HelpHub

  • To determine a few focuses and rotate amongst them. @kenshino wrote a P2 about this – https://make.wordpress.org/docs/2019/10/14/changing-the-nature-of-our-weekly-meetings/
  • @milana_cap came with a suggestion on noting down what were your problems, concerns faced by the one who facilitated the meeting for the first time.
  • @aurooba created a link https://docs.google.com/document/d/1hL49dGkpQOuUOJiBs-4p-EmGMVPjfHkLDQLI1LubnNE/edit to all additional questions/thoughts/concerns about facilitating in here so we can get this figured out.
  • @kenshino created a dedicated Google Drive Folder which contains different areas of Docs covers. We can start a document there for everyone to add their thoughts/questions about facilitating, and then work on creating a set of guidelines. It will be helpful for team members and for newcomers.
    Google drive folder: https://drive.google.com/open?id=1iDTW27QdF7dBtSHWAUiDIcrrD0hbgApO
  • Past discussion about assigning sections of the handbook to different team members: @milana_cap was supposed to write a p2 post about that. We can reuse trello board which we used for re-organizing the old Handbook.
  • Create a P2 Post on the discussion on how we would like to proceed ahead, Trello or Trac? @milana_cap will be creating a P2 post which will help to figure out on the trello/trac

Project Updates

  • @atachibana provided below update
    Content: 264 of 1069 (24.7%) pages were redirected. Last week was 256 of 1068 (23.9%).
  • HelpHub localization @milana_cap see some content has been imported to Serbian rosetta but some are still missing.
  • @nao started this status doc to collect team progress. Checking in with other teams now.
    https://docs.google.com/spreadsheets/d/1343cKHK5iV1TbOKuR57gcjkDV69xVik8QM_xjkJjDQI/edit#gid=0

Open Floor

  • @bph asked Block editor End-user Documentation is part of …… HelpHub? Answer to it is yes which is confirmed by @milana_cap

#meetings, #summary

Summary of HelpHub meeting 03 December 2018

Attendance

@kenshino @atachibana @sergey @mapk @milana_cap @felipeelia @pbiron @abrightclearweb @mkaz @hlashbrooke @clorith @chrisvanpatten

Phase 1 Launch

Phase 1 was softly launched at wordpress.org/support. It was featured in Hugh’s post The Month in WordPress: November 2018 and, thanks to @drewapicture and @mapk, will be mentioned in Matt Mullenweg’s State of the Word at WordCamp US coming up this weekend. For State of the Word’s slides (made by @mapk) @atachibana prepared Phase 1 statistics and list of content contributors, while the list of development contributors is prepared by @milana_cap.

Search functionality on wordpress.org/support doesn’t include new HelpHub articles while it does the old Codex ones – track ticket. This is a big problem and we need to, first and foremost, include HelpHub in search and find a healthy way for smooth shutting down the relevant Codex pages. It was proposed to turn Codex to read-only state, improve the notice to clearly state where new information can be found and then redirect relevant Codex pages to HelpHub ones as Codex is pretty good indexed.

On a matter of naming it’s been decided that we’ll keep HelpHub as a project code name while official name will be “User Docs“. It will stand next to “Forums” and “Developer Docs” in main menu for wordpress.org/support.

All issues for Phase 1 will move to track while for Phase 2 remain on Github. To create new ticket go here: https://meta.trac.wordpress.org/newticket and select “Support Hub” component.

Phase 2

@mapk started with mapping Gutenberg blocks for publishing HelpHub content – github issue. Here’s the demo: https://wpuxtesting.com/2018/11/version-4-9/

Transcript of meeting can be found here: https://wordpress.slack.com/archives/C02RP4WU5/p1543849346079100

#summary

Summary for Helphub Meeting February 20

Content

MVP for content is marked as: better content, internal search, improved readability (design and content wise) and better article discovery (through better categorisation). We also need more content migrated from codex and we need more help with it. If you are interested please reach out for @atachibana on slack and he’ll provide the “how and where”.

Development Updates

We have two options for improving local development of HelpHub with VVV:

  • Rearrange the Helphub repo to fit into a VVV custom site template, it means mostly moving stuff to a public_html subfolder, and adding a provisioner and logs folder.
  • Wait for some VVV changes that might arrive in a month or two’s time that make specifying a wp-content folder easier, then update the documentation.

Voting is happening in slack.

MVP (Phase 1)

  1. Get the PR approved and merged – #154.
  2. Finalize the article CPT – rewrite rule (prefixed slug and the first CPT should have /article/ as the domain path).
  3. Set up the front page (which re-positions the current front page).

Attendance

@kenshino @clorith @atachibana @milana_cap @kafleg @wizzard @tomjn @xkon

Read the meeting transcript in the Slack archives. (A Slack account is required)

#summary

Summary for Helphub Meeting Februar 13

Content

Content status page is updated, you can find it here. Twenty Seventeen article is migrated. Also, there is a new article in review process about password best practices, as explained in track ticket.

Development Updates

Somehow along the way, we lost path to the original plan, which is that HelpHub is a static content part of Support forums. The goal is to drive people to solve their own problems before getting to the forums.

Here are wireframes.

Therefore, home page for HelpHub is actually current home page for support. Articles are going to live under /support so we need to create CPT templates for HelpHub related content. It is agreed for CPT to be under “articles” slug. We need a script for migrating all existing articles on HelpHub to CPT, GitHub issue #153.

Articles should be simpler with a limited, right-side sidebar that showed a few basic things like related articles and such, with meta information at the bottom of the page. In rtl languages, the sidebar would be on the left. We might need custom post template for Guides as they need ToC (this will be marked as Phase 2), which is not always the case with Articles. For Articles, if needed, we might try a different approach with horizontal ToC.

Forums would also show at the bottom of search results, as a last resort if search didn’t help in finding the answer. Or at the bottom of an article, if article didn’t cover the problem.

Next steps

  • Replace current theme in Github repo with the Support one, @clorith volunteered.
  • Start tagging Github issues with MVP.
  • Properly define an MVP on next meeting.
  • Define a launch date, which will help give the push to everyone working on project to tide it over. End of May is proposed but this really depends on MVP and available people.

AOB

There was also a discussion about how docs team is going to use Gutenberg (the new editor) for the purpose of writing articles/guides and how to include it in our Handbook.

Attendance

@kenshino @clorith @atachibana @samuelsidler @xkon @chetan200891 @milana_cap

Read the meeting transcript in the Slack archives. (A Slack account is required)

#summary

Summary for Helphub Meeting Februar 06

It’s been a while since the last meeting and, therefore, this meeting was more about getting back on track than updates. In general, we need to create a plan with exact goals regarding content, design and functionality defined. With this plan tasks and necessary steps will be more clear.

Content

We don’t have updates on migration state. However, we should consider what content (that is not present in codex) could be useful for today’s end users. One such example is #40237Educate users about modern password best-practices.

I’d love to hear some thoughts on this (cc @atachibana).

Design Updates

Home page design is blocked by several questions. These questions should be answered as soon as possible in order to move forward with design and development for home page.

Development Updates

Sidebar navigation is in progress at the moment. We’ll follow design from other .org Handbooks but, for the time being, populating sidebar will be done manually.

AOB

@tjnowell did awesome work in fixing documentation for setting up VVV. He did the same for core Handbook as well, and opened issue on GitHub for fixing the process in our CONTRIBUTING document. He’s a hero!

Attendance

@tjnowell @mapk @clorith @kenshino @milana_cap

Read the meeting transcript in the Slack archives. (A Slack account is required)

#summary

Summary for Helphub Meeting October 24

Migration Updates

CSS Shorthand in Codex is updated as well as initial draft of HelpHub (Homepage) Contents page. This page shows how many pages are missing. This creates new list of Migration candidates which will be known under working title “Phase 3”.

Design Updates

Now that we have initial draft for Homepage it would be great if someone would do design for it.

Development Updates

Staging has been updated with latest code from master. Work on sidebar styling has been started. Also, there’s been discussion on Versions archive page.

AOB

First draft on documentation about VVV instance for contributing to HelpHub with code on Contributor Day is done and next phase would be including HelpHub repo in it.

Attendance

@atachibana @davidmlentz @milana_cap

Read the meeting transcript in the Slack archives. (A Slack account is required)

#summary

Summary for Helphub Meeting October 17

Migration Updates

Recent updates:

  • Managing Plugins
  • Dashboard Screen, and Customizing Your Sidebar
  • Before You Install, Image Size and Quality
  • Updated How to install WordPress

Gutenberg documents – recently, updated by V1.0.4 screen and function.

Design Updates

Design for home page will be worked on once we have finished content for it.

Development Updates

Bug scrubs have little to no point at this moment and are on pause for the time being. Blog posts updates will be continued with though. Latest master will be deployed to staging.

AOB

Started discussion about setting up VVV instance for contributing to HelpHub with code on Contributor Day.

Attendance

@atachibana @picturecities @davidmlentz @mapk @kenshino @hardeepasrani @audrasjb @khoipro @milana_cap

Read the meeting transcript in the Slack archives. (A Slack account is required)

#summary