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

Handbooks Update, May 21 Edition

Handbooks! Handbooks! Handbooks!

We had our weekly chat yesterday (logs), with @blobaugh, @designsimply, @jerrysarcastic, @mattpritchett, @sewmyheadon, and myself in attendance.

  • Plugin Developer Handbook:
    • Some new interest after last week’s update!
    • The spreadsheet is being kept up-to-date, with work being done on various sections.
    • A special thank you to @topher1kenobe who’s doing a bunch of great work and tearing through pages.
    • Interested in helping? Email ben@lobaugh.net or comment here.
  • Theme Developer Handbook:
    • The first section (Part Zero) is done! It’s set at 95% and @jerrysarcastic will give it a final pass to take it to 100%.
    • Part One is pretty far along. @designsimply volunteered to take on a page in the section (the least far along page too!) and @sewmyheadon has committed to completing the section just after the next Docs Sprint on June 7.
    • New contributors will be given pages in Part Two and beyond, as we try to complete the handbook section-by-section.
    • A new section for security should get added to Part One, giving a basic overview of security and linking on to Part Three’s more in-depth security section.
    • We also talked a bit about the “opinionated voice” of the handbook. Some of the claims will get toned down slightly, but in general the tone is fine for getting users on the right path.
    • Interested in helping? Email eric@ivycat.com or comment here.

As I mentioned above, the monthly Docs Sprint is June 7, online and in-person in Seattle. All are welcome to join in #WordPress-sfd!

We also hope to have the handbook plugin and theme ready for devhub in the next couple of weeks. In that case, we’d start migrating content over, section-by-section and throw up an “in-development” notice for the other sections.

And of course… we need your help! If you’re interested in helping, email either Ben or Eric, with their email addresses above, or leave a comment on this post and we’ll get right back to you.

#handbook-chat, #handbooks

Handbooks Weekly Chat update @samuelsidler was out today…

Handbooks Weekly Chat update

@samuelsidler was out today so I lead the discussion. @sewmyheadon was also unable to attend so chat centered around the plugin handbook.

  • Shortcodes section is almost complete (Thanks @topher1kenobe!)
  • We need someone who knows how TinyMCE renders shortcodes in the editor to round out the section
  • The plugin spreadsheet is being updated on an on going basis
  • Some relevant content from the Codex is being moved into the handbook (E.G. CPTs)
  • Instead of randomly attacking the list we are more purposefully moving section by section.

We still need more volunteer writers! If you want to get involved drop me a line at ben@lobaugh.net or ping me on IRC.

Honorable mention was @jerrysarcastic sarcasm 😉

#handbook-chat, #handbooks

Hello everyone here’s a quick handbook update from…

Hello everyone, here’s a quick handbook update from our chat yesterday:

  • Work continues on the plugin developer handbook. Over the next week we’re going to focus on getting the spreadsheet in order.
  • Next steps for the plugin developer handbook is to go through section-by-section, completing them, that way we’ll have something to launch when the devhub handbook theme is ready.
  • Because of some miscommunication, @sewmyheadon didn’t make the chat, but will be by for the docs chat today.
  • I’m traveling during the chat next week, but @blobaugh will host office hours in IRC.
  • I’ve updated the plugin developer handbook link in the header to the new one. (This is the old one, for reference.)

Let me know if you have questions and let’s keep plowing forward!

#handbook-chat, #handbooks

We’re moving the handbooks check in up a…

We’re moving the handbooks check-in up a bit to accommodate Europeans. The new time will be at 21:00 UTC and we’ll meet in #wordpress-sfd. I’ve updated the time in the sidebar. See you tomorrow!

#handbook-chat, #handbooks

Handbooks Chat: 27th Feb

Present: @blobaugh, @caseydriscoll, @hanni, @NikV @philiparthurmoore,and @sams.

1.Plugin Developer Handbook

The revised outline proposal was finalised last week by @blobaugh and @hanni, who are this week working on getting the content copied over from the “old” to new structure. If you take a look at the handbook you’ll see this is well underway, and we’re hoping to complete the merge in-time for the sprint.

A backup was taken of all content prior to starting this, so as to be able to “revert” in case of disaster, and also to allow the restoration the proper metadata for each and every contributors to each section when appropriate.

The structure can be seen here: https://docs.google.com/spreadsheet/ccc?key=0Ak0ISjkNpXRIdHRVSDlFOWlBakYwRnNJZV9rbDIyOHc&usp=sharing#gid=0

The first section is very much in draft form, and is intended to be written by a couple of folks going through the process of writing their own plugin (including @hanni), so no-one should be alarmed by the apparently bizarre state at present.

Note: until we’ve ported the numbers etc. we’ll not replace the link in either the spiffy new nav or the sidebar, so as not to confuse. This also motivates us to get it finished in time for this weekend’s Docs Sprint. Whilst the sprint is based in Seattle, everyone is welcome to participate, wherever they are.

Admin-wise, @blobaugh is leaving for a trip to Uganda on the 5th March, and will return on the 21st. As such, Ben is eager to get things in tip-top shape prior to his departure.

During @blobaugh‘s trip, @hanni will be the point of contact for the Plugin Developer Handbook.

2. Theme Developer Handbook

Due to travel, Theme Developer Handbook Editor @sewmyheadon was unable to make this week’s meeting, so @hanni attempted to fill his shoes for the day.

@philiparthurmoore kindly joined to help kick-off the effort to integrate some of the fantastic themeshaper.net content. As per previous recent handbook discussions, focus for the Theme Developer Handbook is very much on stage (i).

To this end, over the next couple of weeks @philiparthurmore will be working on an initial one page summary distilling the themeshaper content down to the basics of getting from zero to your first theme, upon which we can then expand as necessary.

He’ll have an outline ready for the Docs Sprint on March 1st, such that any folks present can see where things are going and lend a hand if they so desire.

If anyone else is interested in helping with this, please do leave a comment here or ping Philip, Eric, or myself.

Thanks again everyone!

#handbook-chat, #handbooks

Handbooks Chat: 19th Feb 2014

@sewmyheadon, @blobaugh, and, @hanni had our first checkin yesterday.

  1. Stated utility and purpose of the meetings: to support each other as far as possible, and ensure we’re all the right track with regards to the goals of the handbooks, focusing on incremental progress rather than becoming bogged down with concern over current timeline.
    @hanni’s purpose to allow each editor to focus on their handbook whilst watching for potential problems or unwanted divergences, reviewing diffs on an at least weekly basis and helping out with editing when and as she can.
  2. Agreed on the provisional contents the reference portion of Plugin Developer Handbook cut up by @blobaugh and @hanni).
  3. Started on new spreadsheet for the Plugin Developer Handbook to reflect structure update and porting of existing content (links forthcoming).
  4. @sewmyheadon will be meeting with @philiparthurmoore to integrate the ThemeShaper tutorials and restructure Theme Developer Handbook as needed over the next ten days or so.
  5. Welcomed new contributor @lorax who’ll be attending the docs chat today to get involved!

#handbook-chat