WordPress.org

Ready to get started?Download WordPress

Make WordPress Documentation

Welcome to the official blog for the WordPress documentation team.

This team is responsible for all things documentation, including the Codex, handbooks, developer.wordpress.org, admin help, inline docs, and other general wordsmithing across the WordPress project.

Want to get involved?

Join the discussion here on the blog, or check out the landing pages for:

Weekly Meetings

As well as discussing docs issues here on the blog, we use IRC for group communication.

The team holds weekly office hours on Thursdays from 17:00-18:00 UTC in #wordpress-sfd IRC on Freenode.

Individual teams have their own regular meetings, you can find details of those in the sidebar.

Recent Updates Toggle Comment Threads | Keyboard Shortcuts

  • Siobhan 2:10 pm on September 11, 2014 Permalink | Log in to leave a Comment
    Tags:   

    Devhub Update 11th September 2014 

    Thanks to everyone who attended the devhub chat! Here’s what we discussed:

    Parser

    I’ve been throughout the issues on github and marked any that are devhub related. There aren’t that many. If I’ve missed any let me know.

    Code reference

    • @coffee2code ran the parser for WP 4.0 (thanks!)
    • the workflow has been implemented for editing parsed content in the code reference. If anyone wants to help test let us know.
    • parsed content has been moved to metadata so the main post editing area can be used for curated content
    • lots of the code reference archive pages need some sort of filter to allow users to only pull up the information they need. Opened ticket 601
    • @siobhan to write user contributed notes content
    • @coffee2code is working on implementing voting

    The Great Migration
    We’re approaching the point at which we can migrate content from the Codex to the code reference. Some considerations:

    • all code reference pages in the Codex will need to be redirected to their equivalent page in the code reference.
    • we’ll need to develop a style guide for formatting explanations. I’ve opened a ticket for discussion of it 602
    • we’ll need to develop a workflow for moving content over from the Codex

    Handbooks

    No outstanding technical issues. @samuelsidler is working on migrating the content.

    IRC Logs

     
  • Kim Parsell 1:27 pm on September 11, 2014 Permalink | Log in to leave a Comment
    Tags:   

    Project Status Updates: September 11, 2014 

    DevHub and Handbooks project: please post your weekly status update in the comments by the end of today.

    If there are any other docs issues that need to be discussed, please add them in the comments.

    Team Office Hours will be from 17:00 UTC to 18:00 UTC today in #wordpress-sfd. Please plan to be there as we’ll be discussing what project the Docs team will be working on at the team meetup after WordCamp San Francisco.

     
  • Siobhan 3:32 pm on September 8, 2014 Permalink | Log in to leave a Comment
    Tags: , summit,   

    Docs at WCSF 

    As I’m sure you all know, there will be a summit + contributor working days following WordCamp San Francisco this year. We should decide in advance what we are going to do. We have two working days (Tuesday & Wednesday) during which to tackle docs stuff.

    My own feeling is that by Tuesday we’ll be pretty much talked out so I don’t think spending the two days in discussions about docs would be that productive. Instead, we should come up with a project in advance and spend the two days actively working on it. I think it would be best if we all worked together as a team on one single project, rather than working on different things.

    Let’s use this thread to discuss ideas. Here are some possibilities:

    • Complete the handbooks – complete all of the content in the handbooks, review content, and make sure that V1 is 100% shipped.
    • Code Reference Migration – migration of content from the code references in the Codex to the code reference, including reviewing content, adding examples, and setting up redirects from the Codex
    • Support Hub – start making plans for a new support hub. Sketch out new content. Write content. Get someone to work on designs.
    • Codex cleanup – review of Codex content – editing, truncating, deleting pages that are out of date.

    Please make your own suggestions – the sky’s the limit, though remember that we have two days and it’s off the back of WCSF and the summit, so be realistic :)

    We should come to a consensus in the next few weeks so we can plan how to best use our time over the two days.

    Also, can you please leave a note to say if you’re attending WCSF so we know how many team members we’ll have there. And can you note if you’re involved with any other teams and, if you are, how much of your time you think will be dedicated to that team.

     
    • Siobhan 3:34 pm on September 8, 2014 Permalink | Log in to Reply

      Another thought I had was working on a plan for engaging new docs contributors – looking at ways that we can make it easier for people to get involved, breaking things up into smaller projects, creating better docs for docs :)

    • Chris Reynolds 3:48 pm on September 8, 2014 Permalink | Log in to Reply

      I will be there

    • Drew Jaynes (DrewAPicture) 5:17 pm on September 8, 2014 Permalink | Log in to Reply

      I’ll be there. I imagine that my time will be pretty evenly split between Docs and Core. If we decide to start (or continue) content migration from the Codex to the Code Reference, we’ll definitely need to get a bit more functionality in place before then, such as cross-domain redirects for the Codex and some other stuff.

      Personally, I think getting the handbooks done would be an awesome project and a milestone achievement very fitting of meeting up at the community summit.

      • Siobhan 6:55 pm on September 8, 2014 Permalink | Log in to Reply

        I also think it would be good to get them wrapped up. They might be nearly done already though. @samuelsidler?

        • Samuel Sidler 8:34 pm on September 10, 2014 Permalink | Log in to Reply

          Meant to reply to this before…

          Things are coming along, but I doubt we’ll be at 100% by WCSF. Even if we are, we’ll want to go through and fix any issues or even work on new proposed sections. I think it’d be a fine thing to work on.

    • Sarah Gooding 6:37 pm on September 10, 2014 Permalink | Log in to Reply

      I will be there! I can make it to the Tuesday contributor day but have to fly out on Wednesday.

  • JenniferBourn 3:08 pm on September 8, 2014 Permalink | Log in to leave a Comment
    Tags:   

    Learned about helping out and getting started with documentation this past weekend at WordCamp LA. Edited my first page in the theme handbook and looking forward to digging in some more :) I’m a designer, not a developer, so I’m focusing on clarity and ease of understanding, consistency in formatting, etc.

    I do have some questions about formatting for consistency, such as:

    • Sometimes things are capitalized and sometimes the same thing isn’t … so, what should be capitalized and what should not? (i.e. post, page, Post Type, Custom Post type)
    • In a list of items, if not in a bulleted list, do you want the comma used before the “and” or not?
    • In a bulleted or numbered list, should each item have an initial cap or not?
    • And regarding consistency in bolding, should code references (i.e. post_type) use a bold or regular style?

    I’m sure I’ll have other questions as I go, but I’m looking forward to digging in, reading all your hard work, & learning! Oh, and please let me know if I do something wrong or mess anything up … just a little nervous about getting started :)

     
    • Siobhan 3:22 pm on September 8, 2014 Permalink | Log in to Reply

      Welcome! Thanks for helping out with docs! Here are some answers:

      • when using a proper name, capitalize.
      • do you have an example? I’m not quite sure what you mean. Most lists should be bulleted
      • not capitalized
      • not bold. Preferrably wrapped in html code tags

      Let us know if you have any more questions! There are docs office hours at 17:00 UTC Thursdays in #wordpress-sfd if you have any questions. Or you can ask in the #wordpress-sfd chat room if there’s anyone around.

    • JenniferBourn 3:50 pm on September 8, 2014 Permalink | Log in to Reply

      Thank you! As I come across examples of anything else I have questions about, I’ll share and ask. I have never used IRC before, so this is new. I’ll get a client, read the Help with IRC documentation, and join you Thursday.

    • Samuel Sidler 4:07 pm on September 8, 2014 Permalink | Log in to Reply

      For your second point, I believe you’re referring to the Oxford comma and yes, we should be using it.

    • JenniferBourn 4:24 pm on September 8, 2014 Permalink | Log in to Reply

      Perfect! Me too.

  • Jen Mylo 1:21 pm on September 8, 2014 Permalink | Log in to leave a Comment
    Tags: ,   

    WCSF Tickets, Meetup 

    Anyone planning to attend WCSF this year from the docs team, please read the post at http://make.wordpress.org/updates/2014/09/08/wcsf-tickets-and-stuff/ for information about WCSF ticket sales and the contributor days following the main conference. Please click the link and read that post *before* asking questions on this thread. :)

    If you are planning to attend the docs team meetup but I have not been in touch with you regarding hotels/travel dates, please ping me in IRC (jenmylo) or shoot me an email (same username @wordpress.org) so I can include you in the planning.

    Thanks!

     
  • Glenn Zucman 9:52 pm on September 7, 2014 Permalink | Log in to leave a Comment
    Tags:   

    I’m at WordCamp LA Contribute day. We’re looking over pages and cleaning up typos and language (not finding many problems) I’ve been looking at pages for The Loop, Theme Functions, etc

     
  • Ben Lobaugh (blobaugh) 6:53 pm on September 4, 2014 Permalink | Log in to leave a Comment
    Tags: , , ,   

    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/

     
  • Ben Lobaugh (blobaugh) 6:46 pm on September 4, 2014 Permalink | Log in to leave a Comment
    Tags: ,   

    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

     
  • Kim Parsell 1:33 pm on September 4, 2014 Permalink | Log in to leave a Comment
    Tags:   

    Project Status Updates: September 4, 2014 

    Happy 4.0 release day! :)

    Thank you to @drewapicture for taking the lead on preparing the Version 4.0 Codex page.

    DevHub and Handbooks project: please post your weekly status update in the comments by the end of today.

    If there are any other docs issues that need to be discussed, please add them in the comments.

    Team Office Hours will be from 17:00 UTC to 18:00 UTC today in #wordpress-sfd.

     
  • Drew Jaynes (DrewAPicture) 3:41 pm on September 2, 2014 Permalink | Log in to leave a Comment
    Tags: , version-article   

    All Hands on Deck for the 4.0 Version Article 

    For most of today and part of tomorrow, my efforts will largely be focused on fleshing out the Codex version article for the 4.0 release.

    We’ll be combing through some of the (older) This Week in Core posts on make/core, the About page content, as well as the bug and enhancement/task changesets.

    Working on the version article is also an excellent opportunity to start building a Codex sprint list for the coming release.

    If you’d like to help out with either effort, we could certainly use you. Even if you only have 30 minutes to spare, every little bit helps. I’ll be hanging in the #wordpress-sfd channel on IRC all day today, so feel free to jump in.

     
c
compose new post
j
next post/next comment
k
previous post/previous comment
r
reply
e
edit
o
show/hide comments
t
go to top
l
go to login
h
show/hide help
shift + esc
cancel