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.

Our regular meeting is on Thursdays at 17: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

  • Drew Jaynes (DrewAPicture) 5:46 pm on July 17, 2014 Permalink | Log in to leave a Comment
    Tags:   

    Docs Chat: July 17 

    The following is a summary of the topics discussed:

    1. DevHub:

    • Examples and voting should be coming soon. @siobhan mentioned access to view/submit examples is or will soon be extended to all editors on the make P2s.
    • @drewapicture (me) brought up the need for syntax-highlighting on hook reference examples. @siobhan pointed out that highlighting already is in place for function references though, so maybe there’s a disconnect in implementing that across the board. I’ll follow up on the meta ticket for highlighting the submissions form.

    2. Handbooks:

    • Nothing much to report here. @samuelsidler mentioned it had been a slow week. Migrating the handbooks is still in the works. No word from @blobaugh or @sewmyheadon for theme/plugin developer handbooks.

    3. Inline Docs

    • I had a nice self-meeting yesterday in #wordpress-sfd, the first in a while. An update post for that is forthcoming. Chat log can be found here.
    • The 4.0 audit ticket is still open, patches welcome. See #28885.

    The chat logs are available here.

     
    • Samuel Sidler 6:47 pm on July 17, 2014 Permalink | Log in to Reply

      fwiw, my handbook update covered the theme/plugin developer handbooks. We have handbook chats on Wednesdays with cover them and my weekly report covers them as well.

  • Kim Parsell 10:54 pm on July 16, 2014 Permalink | Log in to leave a Comment
    Tags:   

    Tomorrow’s Docs Chat 

    I will be unavailable to lead/attend the Docs chat tomorrow afternoon. @drewapicture has graciously agreed to step in and take my place.

     
  • Drew Jaynes (DrewAPicture) 4:23 pm on July 16, 2014 Permalink | Log in to leave a Comment
    Tags: ,   

    Agenda for today's Inline Docs chat 

    It’s been awhile since we’ve had an inline docs chat, and there are several items on the agenda for today’s meeting at 19:00 UTC (3:00 pm EDT) in IRC in #wordpress-sfd:

    • 4.0 Audit – #28885
    • Access tags for all the methods
    • Hook aliases + PHPDoc tags
    • PHPDoc tags for unit tests – #28558

    If you’d like to suggest any additional items for the agenda, leave them in the comments below. Thanks!

     
  • Drew Jaynes (DrewAPicture) 7:56 pm on July 9, 2014 Permalink | Log in to leave a Comment
    Tags: ,   

    Documenting all the dynamic hook aliases 

    A couple of weeks ago at Open Source Bridge, I started a conversation with @jorbin about an idea to document common aliases of dynamic hooks in core docs. A long-standing pain point in core, and now in the Code Reference, is that dynamic hooks aren’t really searchable.

    For example, let’s say I want to search for the ‘publish_post’ hook. If I search the source, I see add_action() calls referencing that hook, but its origin is nowhere to be found. This is because the hook is actually {$new_status}_{$post->post_type}.

    The idea would be to make it possible to search the source and the Code Reference for indexed common aliases like ‘publish_post’ and have it return the reference for {$new_status}_{$post->post_type}.

    Great, so what’s next?

    We’ve already started a spreadsheet at the WordCamp Seattle contributor day to begin identifying common aliases of all of the dynamic hooks in core. Big thanks goes to @trepmal for providing a complete list of all dynamic hooks from her presentation slides.

    If you’d like to get in on the ground floor and help out, the spreadsheet can be found here: https://docs.google.com/spreadsheets/d/1QfHEPhI9j_Dts5XAxC_kX-LvdE0fxyHlnRFomOTFzQk/edit#gid=0

    Over the next few weeks, I’ll be working with @rarst to devise a solution for parsing hook aliases using WP-Parser. When we have a solution in place, we start planning the effort to begin patching hook docs in core.

    We’ll be tracking progress on #557-meta on Meta Trac.

    Yay progress!

     
  • Siobhan 5:22 am on July 9, 2014 Permalink | Log in to leave a Comment
    Tags:   

    Help research content creation workflows for the code reference 

    The code reference is rumbling along – it’s now possible for people to submit examples, source code can be viewed from pages, and we’re working on upvoting functionality. But before we can embark on the grand codex migration, we need to have a way for people to create user-generated content. We’ve discussed this before but made no major progress.

    What we want: A simple way for people to add supplementary content and information to the code reference.

    How you can help: We need example of how other code references allow users to add explanations and content.

    Please respond to this post with examples. Just some screenshots would be great. When we’ve collected a bunch of them we can go through them and see what inspiration we can get for our own reference.

     
    • Siobhan 5:23 am on July 9, 2014 Permalink | Log in to Reply

      Code Reference: PHP.net

      Brief outline

      PHP.net uses “user contributed notes” in which users can contribute both examples and narrative explanations in one box.

      Workflow

      1. On function page click “add a note”

      2. User redirected to instructions page with form for submitting note at the bottom

  • Ian Dunn 9:17 pm on June 24, 2014 Permalink | Log in to leave a Comment
    Tags:   

    Hey there Docs team. I’ve been working on a turnkey local development environment for Meta sites, and added developer.wordpress.org to it last night.

    I think this will be much more convenient for anyone wanting to help out, since they can just install a few programs and then the entire environment will be provisioned for them automatically, rather than having to manually complete the list of setup tasks.

     
    • Eric Amundson 10:52 pm on June 24, 2014 Permalink | Log in to Reply

      That’s terrific, Ian. Thanks!

    • trishasalas 8:11 pm on June 25, 2014 Permalink | Log in to Reply

      Ian, thanks for doing this. I’ve been wanting to help with themes/dev. Where can I start? :)

      • Ian Dunn 9:18 pm on June 25, 2014 Permalink | Log in to Reply

        Hi Trisha, when you said “themes/dev”, did you mean general theme development for any site in the network? If so, all 3 of the sites that WME currently supports could probably use help there. The Meta Trac has lots of tickets that need contributors :)

    • trishasalas 1:23 am on June 26, 2014 Permalink | Log in to Reply

      Ian,

      I was thinking of the docs team but I’m open to anything. The list you provided looks like a great place to start. What does the WME acronym stand for?

      • Ian Dunn 3:27 pm on June 26, 2014 Permalink | Log in to Reply

        Oh, sorry, it’s WordPress Meta Environment, the name of the Vagrant configuration that builds the environment with devhub and other sites automatically.

        For the devhub specifically, someone more in involved in the Docs team would know better than me, but it looks like #252 and #493 might be good places to start, or you can always create a new ticket if you see a problem/opportunity that isn’t already tracked in an existing ticket.

    • trishasalas 12:52 am on June 27, 2014 Permalink | Log in to Reply

      Cool, no problem. I figured it out once I looked at your original post :) I use VVV daily already so I’m familiar with it and have this setup (mostly). I’ll take a look at the tickets you mentioned. Thanks!

  • Kim Parsell 1:48 am on June 22, 2014 Permalink | Log in to leave a Comment
    Tags:   

    Docs Chat: June 19, 2014 

    Thank you to everyone who came.

    The following is a summary of the topics discussed:

    1. DevHub: @samuelsidler said Post2Posts still needs to be implemented with the parser. @coffee2code has implemented source code on the individual pages, and is working on implementing the examples functionality. The handbook plugin has been updated with the required changes.

    2. Handbooks: Some progress was made this week, mostly in the Plugin Developer handbook. @blobaugh and @sewmyheadon will add the anticipated new permalinks for each page to the spreadsheets for their respective handbooks. Once that is done, @samuelsidler plans to manually migrate over completed handbook pages, one section at a time, to their permanent home on developer.wordpress.org. Adjustments will be made to the handbook theme and plugin, as needed, during content migration. Contributor information is being gathered, and will be included on the Credits page in each handbook.

    3. Docs Issue Tracker: Development has stagnated on the project, and there most likely isn’t any developer time available right now. I’ll be going through the alpha release post comments, and creating Trac tickets for suggested changes so the discussion can continue on the tickets.

    4. Trac Tickets: @DrewAPicture brought up a new ticket that could be an interesting cross-team effort between Core, Support, and Docs: #28551 – Add Better Debugging Documentation Into wp-config.php. In addition to providing more debug constants and documentation, the current user sections of the file can be improved with better inline documentation.

    The chat logs are available here.

     
  • Jen Mylo 6:04 pm on June 20, 2014 Permalink | Log in to leave a Comment
    Tags: ,   

    Team Meetup at WCSF (More) 

    Hi again! We’re working on making sure we have enough room blocks to make sure all the contributors who are coming in October can get a decent rate (or have a room provided by us if needed). Some of you replied to my post from last week and filled in the survey so I’d know you were planning to come, but some haven’t. Additionally, some people did the survey and marked themselves as team members of teams they’re not actually involved with, so I need your help! :)

    I just want to make sure we count everyone so we can try to put you at the same hotel to make the meetup part easier (though I know most people on this team are also heavily involved in other teams, so we’ll figure that once we have a solid tally of who’s planning to come at all).

    If you didn’t read the post before, the plan for the event is:
    Sat/Sun — WCSF conference
    Monday — community summit
    Tues/Wed — team meetups (team being together to talk issues, make plans, work together, etc)

    The people who identified themselves as active members of the docs team in the survey are: @jerrysarcastic, @drewapicture, @trishasalas, @topher1kenobe, @hanni, @kpdesign, @nicolealleyinteractivecom, @davidjlaietta, @jazzs3quence, @sewmyheadon, @siobhan, @otto42 (all authors on this team blog), as well as:
    Cousett Hoover, Benjamin Hansen, John Blackbourn, Ed Caissie, and Russell Fair.

    Is this an accurate list? @kpdesign, can you let me know if these folks are all active with the docs team, and also tell me if there’s anyone missing that you think should be there from the team? Comment here, email me, hit me in irc, whatever’s easiest.

    Any docs folks not listed above who are active on the team and want to come to the team meetup should fill out the survey so I can have you on the list as we start deciding which hotels to put each team in. We’ll be spread out among 4 or 5 hotels, so I want to be sure we can keep the teams together.

    And just a reminder that we have a travel assistance program this year to help contributors who don’t work for a wp-based company and can’t cover travel costs on their own. Apply for travel assistance by June 30 Applications for travel assistance are now closed. If you need help, contact @jenmylo.

    Thanks!

     
  • Jen Mylo 11:41 pm on June 12, 2014 Permalink | Log in to leave a Comment
    Tags: , wcsf,   

    WCSF Details and a Request 

    Heads up, docs team! We’re getting ready to publish details about the plans for WordCamp San Francisco this October (which includes a mini team meetup), so if you’re thinking of attending, please read the post at http://make.wordpress.org/updates/2014/06/12/wordcamp-san-francisco-travel-contributor-days/ and take the short survey linked at the end of it so I’ll know how many team members to plan for (don’t worry, this isn’t a commitment or anything, I just need to get some rough numbers for budgeting purposes). Thanks!

     
  • Kim Parsell 11:39 pm on June 8, 2014 Permalink | Log in to leave a Comment
    Tags:   

    Docs Chat: June 5, 2014 

    Thank you to everyone who came.

    The following is a summary of the topics discussed:

    1. DevHub: @siobhan said Post2Posts will be bundled with the parser. @coffee2code will be implementing source code on the individual pages, as well as the examples functionality. Feedback is still needed on implementing explanations in the code reference, and differentiation on the search results pages.

    2. Handbooks: @blobaugh said part one of the Theme Developer Handbook is on schedule to be completed by early next week. Two sections of the Plugin Developer Handbook are almost complete, and should be done by next week, with one more section near completion. If you are interested in getting involved, contact @blobaugh and @sewmyheadon at the email addresses listed in this post. The subject of a style guide for the handbooks was brought up in this week’s handbooks chat. I noted that the Docs Handbook has a style guide and a tutorial template for reference.

    3. Admin Help: @Clorith said he still needs to talk with @jenmylo about working with local meetup organizers to identify areas that their new users are struggling with.

    For anyone unable to attend, you can read the chat logs here.

     
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