WordPress.org

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 Slack for group communication.

The team holds weekly office hours on Thursdays from 18:00-19:00 UTC in the #docs Slack channel.

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

Recent Updates Toggle Comment Threads | Keyboard Shortcuts

  • Hugh Lashbrooke 11:27 am on March 15, 2016 Permalink |
    Tags:   

    HelpHub Meeting: Mar. 15 

    Reminder about our weekly HelpHub meeting at 14:00 UTC today. We’ll be looking over some of the recent development and discussing any potential issues.

    Time/date: Tuesday, March 15, 2016, 14:00 UTC in #docs

     
  • Hugh Lashbrooke 11:17 am on March 8, 2016 Permalink |
    Tags:   

    HelpHub Meeting: Mar. 8 

    I’m back for the HelpHub meeting this week, so let’s run through a status update and see what we all need assistance with.

    Time/date: Tuesday, March 8, 2016, 14:00 UTC in #docs

     
  • Hugh Lashbrooke 11:53 am on March 1, 2016 Permalink |
    Tags:   

    HelpHub Meeting Agenda: Mar. 1 

    I won’t be able to attend the HelpHub meeting today, but @kenshino will be leading the meeting in my absence. This meeting is largely a status update and a discussion about any issues that arise from that, so please keep it focussed and reserve any specific, lengthy topics for after the meeting. I’ll catch up on the back scroll tomorrow and supply any feedback where necessary.

    Time/date: Tuesday, March 1, 2016, 14:00 UTC in #docs

    Agenda:

    1. Status update
      • Let’s get the latest status update on development and content migration.
     
  • Hugh Lashbrooke 11:06 am on February 24, 2016 Permalink |
    Tags: ,   

    Contributing to HelpHub 

    We’re at the stage right now with the HelpHub project where we are able to accommodate contributors more easily as well as have tasks for Contributor Days.

    If you would like to contribute to HelpHub, then have a look through this guide: https://make.wordpress.org/docs/handbook/about-the-docs-team/current-docs-projects/helphub/ – the primary need right now is for people to get involved in migrating content from the Codex over to the HelpHub staging site.

    If you have questions or want to know more about how you can work with HelpHub at your Contributor Day then feel free to ping me on Slack.

     
  • Hugh Lashbrooke 1:12 pm on February 22, 2016 Permalink |
    Tags:   

    HelpHub Meeting Agenda: Feb. 23 

    With everything moving swiftly along, this meeting is a status update as well as a call for people to get involved in article migration/writing.

    Time/date: Tuesday, February 23, 2016, 14:00 UTC in #docs

    Agenda:

    1. Status update
      • Let’s get the latest status update on development and content planning.
    2. Call for volunteers
      • We need to move along with the process of writing the initial articles for HelpHub – this is a combination of migrating content from the Codex as well as writing fresh content. Let’s chat about how we can be most effective in doing that.
     
  • Hugh Lashbrooke 8:45 am on February 17, 2016 Permalink |
    Tags:   

    HelpHub Status Update: Feb. 17 

    We had a productive HelpHub meeting yesterday where we made a solid start to the content planning side of things (Slack logs). Development has also been moving swiftly along with some great progress being made on a daily basis.

    Staging site

    I use the term ‘staging’ somewhat loosely here, but I have setup a site that we are going to use to showcase HelpHub as well as store all the content before it is ultimately moved over to its new home on the WordPress.org network. You can find that site on wphelphub.com – it is blocked to logged-out users purely so that any content we add doesn’t start to get indexed by Google, but I’m happy to open it up if that isn’t actually a realistic concern.

    Development

    Development of HelpHub continues to be managed through the GitHub repo – things are going well with a few features already merged into the master branch. All of the code that has been merged is live on the staging site already and I will be keeping that up to date as we go along. If you have any input on the development then please comment on the relevant issue on the repo.

    Content

    We’ve started the process of adding content to the site. This will obviously be an ongoing task even after HelpHub goes live, but we’ve put the initial building blocks in place and have started planning for this:

    Migrating from the Codex

    We took the list of the top 500 codex pages (based on page views) and identified all of the articles that will be relevant to HelpHub (i.e. all of the user documentation) – this has given us 142 articles that will be our initial primary focus for migration from the codex. Those articles are listed in this sheet and we will continue to expand that sheet as needed, but the top 500 pages are the most logical place to start. This migration will most likely have to be a manual process, but I am looking into possible ways to automate it.

    Categorising content

    Having content is great, but it needs to be categorised well in order to be effective. To that end, we had a healthy discussion on GitHub regarding the categories that we will need to use – any input there would be greatly appreciated. It’s also helpful to bear in mind that the categorisation can (and should) be iterative – we can add/remove/edit categories as and when we need to do so.


    If you have any feedback or input on the HelpHub project then please comment on here or jump into the #docs channel on Slack. We have weekly meetings at 14:00 UTC on Tuesdays.

     
    • Courtney Engle Robertson 3:19 pm on February 22, 2016 Permalink | Log in to Reply

      Do we have enough done to know the final permalinks for HelpHub articles? I am cross-referencing training lesson plans against the Codex, and would be highly interested in even blank page permalinks in HelpHub while the project is under way.

      • Hugh Lashbrooke 3:23 pm on February 22, 2016 Permalink | Log in to Reply

        Not at the moment – right now we don’t even know the exact URL on which HelpHub is going to live as that has not yet been decided. We are using a staging site to load the content so we can easily export/import it across to the final destination once it is ready.

  • Hugh Lashbrooke 10:37 am on February 16, 2016 Permalink |
    Tags:   

    HelpHub Meeting Agenda: Feb. 16 

    I try to post these agendas 24 hours before the meeting, but time just ran away with me yesterday, so my apologies for the delay.

    Time/date: Tuesday, February 16, 2016, 14:00 UTC in #docs

    Agenda:

    1. Development status update
      • Let’s get the latest status update on the development.
    2. Content planning
      • We’ve been putting this off for a while (due to various external circumstances), but we can now get going with planning the content of the site – let’s kick that process off today.
     
  • Hugh Lashbrooke 2:42 pm on February 8, 2016 Permalink |
    Tags:   

    HelpHub Meeting Agenda: Feb. 9 

    We’re well underway with development for HelpHub, so this week’s meeting is more of a development status update than anything else. There won’t be any specific agenda other than developers reporting back and seeing if we can set some goals for feature delivery dates.

    Time/date: Tuesday, February 09, 2016, 14:00 UTC in #docs

    We still need to discuss content planning, but that’s still on hold for now as I need to work a few things out on the admin side before we can have any fruitful discussions around it. As soon as things are ready, however, we’re going to dive right into the content structure and planning the articles that we’ll need to write.

     
  • Hugh Lashbrooke 10:00 am on February 4, 2016 Permalink |
    Tags: status   

    HelpHub Update: 4 February 2016 

    Instead of the weekly meeting recaps I thought it would be more beneficial if I posted a weekly update covering the general status of HelpHub that explains where we’re at and if there are any areas where we could use some additional assistance.

    Current status

    We finished off 2015 with finalising the wireframes for the project and we’re using those as a base for our front-end development.

    We are managing the development of the project through GitHub – project developers are added as collaborators so they can branch and send pull requests with updates. All pull requests are discussed and approved before merge, with all merges being handled by the developer who sent the pull request. Other development guidelines are listed in the repo’s readme file.

    You can check out the repo code and issues as at any time to get a more up-to-date view of the current project status.

    Where you can get involved

    While we have a solid team of individuals working on the development of HelpHub, we’re always happy to welcome others who are keen to contribute. If you would like to get involved then please join us for our weekly meetings on Tuesdays at 14:00 UTC in #docs (note that we might be moving that meeting 30 minutes earlier, but I will confirm that in the meeting agenda post on Monday).

    You are also welcome to fork the HelpHub repo and send in your pull requests. If your work is what we’re looking for then you will be added as a collaborator so you can push directly to the repo itself.

    If you have ideas for how we should be building HelpHub, but you don’t want to (or aren’t able to) do the development yourself then we will always welcome your valuable insight in the GitHub issues as well as in our weekly meetings.

     
  • Hugh Lashbrooke 12:19 pm on February 1, 2016 Permalink |
    Tags:   

    HelpHub Meeting Agenda: Feb. 2 – Assigning development tasks 

    At last week’s meeting we finalised who would be on the development team for HelpHub. This week we’ll be assigning development tasks.

    Time/date: Tuesday, February 02, 2016, 14:00 UTC in #docs

    Agenda:

    1. Development task overview
      • I have added various tasks as issues on the HelpHub repo – we need to go through these and add any additional tasks that might be relevant.
    2. Assigning tasks
      • We need to assign tasks to members of the development team so we know who will be working on what.

    Note that I am pushing back the content planning discussion a bit as I still haven’t been able to confirm a few related details for that. We do need to get that discussion started soon though, so I’m shooting for next week to get going on that front.

     
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
Skip to toolbar