https://github.com/wordpress/helphub
The WordPress user documentation portal
https://github.com/wordpress/helphub
Last synced: 4 months ago
JSON representation
The WordPress user documentation portal
- Host: GitHub
- URL: https://github.com/wordpress/helphub
- Owner: WordPress
- Created: 2016-01-04T05:16:27.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-05-17T15:41:15.000Z (about 2 years ago)
- Last Synced: 2025-03-24T10:14:37.809Z (over 1 year ago)
- Language: PHP
- Homepage: https://make.wordpress.org/docs/category/helphub/
- Size: 38.7 MB
- Stars: 112
- Watchers: 23
- Forks: 55
- Open Issues: 49
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# HelpHub
[](https://travis-ci.com/WordPress/HelpHub)
HelpHub is going to be the new portal for all WordPress user documentation that currently resides on the [WordPress Codex](https://codex.wordpress.org/). This repo is where we will be managing the development of this new portal.
## Get Involved
You can get involved in development (or any other aspect of the project) by attending our weekly meetings in the #docs channel of [the Making WordPress Slack](https://make.wordpress.org/chat/) every Monday at 15:00 UTC.
## How to use this repo
To use this repo, simply create a new WordPress site on your local machine (using whatever development environment suits you), then empty out the `wp-content` folder and clone this repo into it. After logging in to the admin area activate `wprog-support` theme for the site to work.
You can get more information about running the HelpHub code base locally via reading the [contributing document](https://github.com/WordPress/HelpHub/blob/master/CONTRIBUTING.md)
## Workflow
Anyone is welcome to fork the repo and send pull requests, but the project collaborators (listed below) have push access directly to the repo. **All pull requests will be reviewed by at least one collaborator with commit access and the PR must pass tests. Collaborators will be responsible for merging their own pull requests once the reviews have been approved. Major feature development will require a review from the project lead, minor ones do not.**
We use ZenHub for project management, see https://github.com/WordPress/HelpHub/issues/79 for help on using it
### Feature development
All features are to be built in individual branches named `feature-abc` (where `abc` is a brief descriptor of the feature) and submitted via pull request to the `master` branch. For best results, features should be separated into their own plugins, but the project lead will evaluate this for each pull request depending on the requirements and scope of the feature.
### Bug fixes
Any fixes that do not qualify as new features are to done in individual branches named `fix-abc` (where `abc` is a brief descriptor of the fix) and submitted via pull request to the `master` branch.
### Development guidelines
As this is a WordPress community project, all development must have a strong commitment to accessibility and responsive design. We will also be following the [WordPress coding standards](https://codex.wordpress.org/WordPress_Coding_Standards) throughout the project.
Given that we will ultimately need to localize the whole site for different languages, please use `wporg-forums` as the text domain for all text strings.
Database from staging site is located in `wp-content/staging-database` folder. There you can find database files for WordPress Importer, Widget Importer & Exporter, Duplicator and UpdraftPlus.
### Design guidelines
See the [HelpHub wireframes](https://wp-commhub.mybalsamiq.com/projects/helphub/grid) for a guide on the design and layout of the project and note that all design must be consistent with the rest of [WordPress.org](https://wordpress.org/).
## Project collaborators
Project Lead: [Jon Ang](https://profiles.wordpress.org/kenshino)
The following people are active developers on the project in last year and are all listed as collaborators on this repo:
| Name | GitHub username | Slack username |
|-----------------------|-----------------------|-------------------|
| Jon Ang | @kenshino | kenshino |
| Stephen Edgar | @ntwb | netweb |
| Marius Jensen | @clorith | clorith |
| Milana Cap | @zzap | zzap |
| Akira Tachibana | @atachibana | atachibana |
| Carl Alberto | @carl-alberto | carlalberto |
| Felipe Elia | @felipeelia | felipeelia |
| Joy Reynolds | @joyously | joyously |
| Mukesh Panchal | @mukeshpanchal27 | mukesh27 |
| Subrata Sarkar | @emfluenceindia | subratasarkar |
| Burhan Nasir | @burhandodhy | burhandodhy |
People who have helped the project but are not active contributors (any more):
| Name | GitHub username | Slack username |
|-----------------------|-----------------------|-------------------|
| Mark Uraine | @mapk | mapk |
| Justin Greer | @justingreerbbi | justingreerbbi |
| Takayuki Miyauchi | @miya0001 | miyauchi |
| Hugh Lashbrooke | @hlashbrooke | hlashbrooke |
| Hiroshi Urabe | @torounit | toro_unit |
| Mário Valney | @mariovalney | mariovalney |
| Matt Cromwell | @mathetos | webdevmattcrom |
| Juliette | @jrfnl | jrf |
| Gary Pendergast | @pento | pento |
| Toshihiro Kanai | @mirucon | mirucon |
| Hidetaka Okamoto | @hideokamoto | motchi0214 |
| | @bravokeyl | bravokeyl |