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 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/. if there are questions outside of our weekly chat.

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

No devhub chat today A bunch of us…

No devhub chat today. A bunch of us were at WCEU and are in various states of travel and tiredness. We’ll resume again next week.

#devhub

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

  • 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: 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.
  • MigrationMigration Moving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. 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

Devhub Update for 16th September 2014

Short meeting this week as only @coffee2code and myself were able to attend. @DrewAPicture sent in his status as well. Logs are here.

  • No news on parser work.
  • Scott landed some things related to better formatting hash parameters.
  • There are image upload problems on devhub that Scott is looking into. I’ve put the theme handbook migrationMigration Moving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. on hold while he investigates.
  • The handbook theme has a few issues that need to be fixed but we weren’t sure if @nicolealleyinteractivecom had work in progress. I’ll file a catch-all ticket with the issues.
  • Upcoming from Scott is also the rename of “examples” to “user contributed notes” and finishing up voting.

That’s about it. Hopefully we get more attendees next week. 😉

#devhub

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 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. Grand Rapids and WordCamp Maine contributor days.

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 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 meetupMeetup All local/regional gatherings that are officially a part of the WordPress world but are not WordCamps are organized through https://www.meetup.com/. A meetup is typically a chance for local WordPress users to get together and share new ideas and seek help from one another. Searching for ‘WordPress’ on meetup.com will help you find options in your area. 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, May 21 Edition

Handbooks! Handbooks! Handbooks!

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

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

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 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 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 headerHeader The header of your site is typically the first thing people will experience. The masthead or header art located across the top of your page is part of the look and feel of your website. It can influence a visitor’s opinion about your content and you/ your organization’s brand. It may also look different on different screen sizes. 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 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.. See you tomorrow!

#handbook-chat, #handbooks

Redesigned Contributor Handbooks

Hello Docs Team!

I just landed a new design for the contributor handbooks, courtesy @sonjanyc (mockup is here). You can see them on the core, mobile, docs, and polyglot handbooks, among others. The design is still a little rough around the edges, but the bulk of it is there. Namely, here’s some issues I’ve noticed:

  • There’s a hover for headings in chapters box
  • Content doesn’t properly wrap around the “topics” box
  • We need to add a handbook name to each handbook, along with a design (#439)
  • The “Watch this page” 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. needs to move to be in the actions bar (#437)
  • In the polyglots handbook, for admins, “Flag Unresolved” is shown (#436)

Last but not least, I need a decision from y’all.

Currently, we list all hierarchal subpages on the page they’re from. For example, in the coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. handbook, on the Coding Standards page, we show the subpages as a (undesigned) list. The decision we need made is whether to keep that list and design it or to remove the list entirely. Keep in mind the Chapters 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. can be organized however you’d like; it doesn’t need to be hierarchal. If we remove the Pages list, we’ll need to make sure the content is properly linked within the page.

What say you?


 

Other things I should mention are that we should document these things somewhere:

  • The starting headerHeader The header of your site is typically the first thing people will experience. The masthead or header art located across the top of your page is part of the look and feel of your website. It can influence a visitor’s opinion about your content and you/ your organization’s brand. It may also look different on different screen sizes. tag in any page should be an <h2> to keep the topics box designed. (I went through and fixed this on the core and mobile handbooks.)
  • The Chapters sidebar is a custom menu and can be organized however you like.
  • Currently, the headings in the Chapters sidebar are merely re-styled <a> tags with # as the href. We’ll probably be changing this, however.

Finally, please note that this design is only for the contributor handbooks. The developer handbooks will have a style that matches devhub.

#handbooks