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.

#contributors, #helphub, #status

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

#helphub, #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.

#helphub, #status