Docs Chat Agenda – July 14, 2016

Here’s the agenda for the Docs team weekly chat, which are held Thursdays at 17:00 UTC in the #docs channel on Slack.

Current Projects Updates:

  1. Theme Developer Handbook – @kenshino
  2. Codex Migration (DevHub) – @drewapicture
  3. DevHub – @drewapicture
  4. HelpHub – @kenshino
  5. Inline Docs – @drewapicture

Other Stuff:

  1. Internationalizing documentation
  2. Version articles (HelpHub)
  3. Hosted about pages
  4. Open Floor

#chat, #codex-migration, #handbooks, #helphub

4.1 Docs Updates

There are a number of updates that need to be made for 4.1 to both the handbooks and the Codex.

Handbooks:

There are several posts on Make/Core about changes in 4.1 that affect the developer handbooks:

Themes: New Template Tags in 4.1

Queries Improvements:

Shared Terms: An Update on Shared Term Splitting

Customizer API Improvements: JS/Underscore-template-rendered Custom Customizer Controls in WordPress 4.1

I still need to add a list of Codex pages here that will need to be updated with the content from these posts.

Codex Updates:

The following are the pages that need updated or created in the Codex.

If you would like to help, please leave a comment indicating which page you would like to work on.

New default theme:

  • Twenty Fifteen page. We can use some of this content. Note: The custom color screenshots are slightly different from the .org version. Takashi Irie provided some screenshots that reflect the default colors available: https://cloudup.com/cNHOeJVOq-k (@kpdesign)

New features:

  • New Distraction-Free Writing and inline image editing toolbar in Post editor – https://codex.wordpress.org/Posts_Add_New_Screen and https://codex.wordpress.org/Pages_Add_New_Screen
  • New sessions logout button on Profile page – https://codex.wordpress.org/Users_Your_Profile_Screen
  • New Recommendations tab on Plugin Install page – https://codex.wordpress.org/Plugins_Add_New_Screen
  • New translation installation setting on General Settings and Network Settings pages – https://codex.wordpress.org/Settings_General_Screen and https://codex.wordpress.org/Network_Admin_Settings_Screen
  • Appearance menu – Header and Background menu items now link directly to the Customizer.

#4-1, #codex, #handbooks

Handbooks Update: November 18, 2014

Present today were: @aj_mallory, @blobaugh, @grappleulrich, @naomicbush, @samuelsidler, @sewmyheadon, and @topher1kenobe.

Most importantly, the chat is moving to Thursdays at the same time. The next chat will be Thursday, December 4, 2014 at 21:00 UTC. We will not have a chat next week due to Thanksgiving in the US. Of course, we all idle in #docs in Slack if there are questions outside of our weekly chat.

Plugin developer handbook:

  • Launched version 1 at WCSF
  • Not much traction since
  • Focus going forward is getting minor issues (on the spreadsheet) taken care of, then onto reviewing the top Codex pages and bringing over any good information so we can redirect them.

Theme developer handbook:

  • Completely migrated since prior to WCSF.
  • Minor movement just after WCSF but mostly stagnant.
  • We need volunteers to own pages so we can get moving.

If you want to help with either handbook, ping any of us in #docs on Slack (especially @blobaugh@sam, @sewmyheadon, and @topher1kenobe).

Coming up on December 6 is the Docs Sprint in Seattle and in #docs on Slack.

#handbooks

WCSF 2014 Docs Contrib Day Notes

Purpose to see how we are doing on Docs and look towards the future

Plugin handbook

  • Almost complete. One page left to write
  • Siobhan is holding back launch with the intro 😉
  • Landing page on developer.wordpress.org will be updated to unveil the plugin hb tomorrow!
  • How can we get feedback from the users on handbook pages?
  • Add list of pages from the codex that can be redirected or need content migrated into the spreadsheet

Theme handbook

  • At 67% completion
  • Future focus can be put completely on theme hb instead of splitting with plugins

Contributor days

  • Difficult to retain contributors
  • Takes a while to get them up to speed on how to contribute
  • Are still useful as contributors that do return contribute significantly

Developer.wordpress.org

  • Landing page will show the new theme
  • Theme hb link should be whited out and say coming soon
  • Need examples contributed to the code reference
  • Need a way to group together items in the functions reference. Possibly a tag that can be added. Scott (coffee2code) is looking into options
  • The JSON API docs need to be pulled in. Currently exist as markdown on Github
  • Need a banner on the handbooks that lets users know all content is volunteer contributed and they can get involved

Future

  • Go through codex and find pages that can be relevant to the plugin handbook
  • Siobhan will provide list of high traffic codex pages that need to be checked for content and redirected to plugin handbook
  • Need list of content that is duplicated between both plugin and theme handbook (E.G javascript)
  • Where should content live that does not exactly live in either handbook? (E.G list of javascript libraries built into WordPress)
  • Need a Slack bot that will send messages to #docs when user wants to ask a question???
  • How do we easily let in new users to edit handbooks? This needs more discussion. Prefer to contact a human to get access. Preferably one of the editors
  • Will be implementing an issue tracking system that will contain tickets for things that need updated/added

Make.wordpress.org/docs

  • Instead of weekly meetings we should use the blog to post questions, get feedback, etc
  • Switch to monthly all docs team chats

#handbooks, #wcsf2014

Devhub Todo List for pre-WCSF

Prior to WCSF we need a few changes on devhub so that y’all can make awesome handbook improvements as your project. I’ve come up with a list of things that seem important prior to WCSF. This list may not be exhaustive, so we’ll add to it as we come up with other things. In general, the following are in list by importance.

  • Fix image uploads on devhub, which is currently preventing us from migrating the theme developer handbook.
  • Add the Mediawiki plugin for external redirects so we can redirect Codex pages to devhub (#meta446)
  • Add voting to examples (#meta551)
  • Create a new user role for handbook editors (#meta621)
  • Add the code TinyMCE plugin to devhub
  • Various handbook design changes (#meta631)
  • Improve the design of the callout shortcodes (#meta630)

#devhub, #handbooks

Handbooks Update: September 23, 2014

Present today were @blobaugh, @sewmyheadon, and @topher1kenobe, with a few devhub peeps following along as we overlapped slightly. Logs are here.

  • Plugin handbook: Topher worked on section 8 (metadata) and section 9 (CPTs and taxonomies) and both are now at 100%. Ben will be out of town for the next two chats.
  • Theme handbook: No updates this week. Hopefully some more next week.
  • Migration update: A bunch of the plugin handbook has been migrated with more being migrated this week.

If you want to get involved in either handbook, please email any of us.

Again, we meet on Tuesdays at 20:00 UTC. Hope to see more people there!

#handbooks

This weekend @sewmyheadon is hosting a Documentation Sprint…

This weekend @sewmyheadon is hosting a Documentation Sprint in Seattle. If you are in the area and would like to join in person join us at Uptown Espresso on Westlake. If you are remote please join us in #wordpress-sfd on Freenode.

For full details see the Meetup post at http://www.meetup.com/SeattleWordPressMeetup/events/196326602/

#handbooks, #plugin, #sprint, #theme

Weekly Handbook updates I ran the handbook chat…

Weekly Handbook updates

I ran the handbook chat for @samuelsidler yesterday while he was out. Present were @blobaugh @jerrysarcastic @topher1kenobe @sewmyheadon

The theme handbook is coming along. This weekend is another of the monthly doc sprints and @sewmyheadon is hoping to knock out a good chunk of the handbook.

A couple more sections of the plugin handbook have been marked 100% or are ready for review. Thanks again to @topher1kenobe for doing much of the heavy lifting!

Migration to the new devhub has been going slowly but has had some progress.

In addition to the monthly doc sprint in Seattle hosted by @sewmyheadon there will also be a general contributor day in Tacoma starting soon. Also led by @sewmyheadon. What a great guy!

The handbooks are still a work in progress and we are always happy to have more contributor, either writing content, editing, proofing, testing, or other! If you would like to help out please contact @samuelsidler @blobaugh or @sewmyheadon

#handbooks

Handbooks Update: August 20, 2014

We had our weekly chat today with @blobaugh, @jerrysarcastic, @sewmyheadon, @topher1kenobe, and myself in attendance (log here).

Both handbooks received quite a bit of attention during the WordCamp Grand Rapids and WordCamp Maine contributor days.

Plugin Developer Handbook:

  • Some progress made over the last week.
  • A lot of things at 90%+ that need final edits.
  • Focus is on getting sections completed one-by-one.
  • Each section will need an “introduction” added. Some of them already exist.

Theme Developer Handbook:

  • A second docs meetup in the Seattle area is going to be setup starting in October or so.
  • Eric would like a second person to help lead the handbook, specifically someone who can work with other volunteers.
  • Like the plugin handbook, we’ll need introductions for each section.

For both handbooks, our focus is on getting things done faster and not making them “perfect.” We’ll edit as needed on the live site, but it’s important to get what we have in a usable state and get it live soon. Migrated pages will be blanked out on the staging site (make/docs) so we don’t modify them further.

Finally, I updated the “Handbooks” page on the docs contributor handbook. That page and its subpages (including the style guide) need review and editing so we can help onboard new contributors.

Would it help to have contributors join our weekly chats? Or perhaps to have a weekly, online handbook sprint? What does the docs team think?

#handbook-chat, #handbooks

Handbooks Update: August 6, 2014

We had our weekly chat this afternoon (logs), with @blobaugh, @topher1kenobe, @sewmyheadon in attendance. Could have been others lurking too.

Plugin Developer Handbook

@blobaugh had some family issues that interfered with following up with contributors last week, but @topher1kenobe completed the Metadata section and it is awaiting review so we still have good forward momentum.

Also, there we some contributions over the weekend at the Docs Sprint in Seattle by @awoods & @pjackson1972.

@blobaugh will try to get Section 2 finished this week while traveling, but no promises.

Theme Developer Handbook

We also had contributions to the Theme Dev Handbook at our Docs Sprint in Seattle on Saturday, and inducted a few new Docs contributors and got them up to speed so they can help too.

We made some good progress and Part One of the Theme Dev Handbook is nearly ready for prime time. We have three remaining articles in that section that need serious work, and they all need a bit more editing, but we should be able to move on within the next few weeks.

#handbook-chat, #handbooks