Code Monkey home page Code Monkey logo

helphub's Introduction

HelpHub

Build Status

HelpHub is going to be the new portal for all WordPress user documentation that currently resides on the WordPress Codex. 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 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

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

Project collaborators

Project Lead: Jon Ang

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

helphub's People

Contributors

atachibana avatar bravokeyl avatar burhandodhy avatar carl-alberto avatar clorith avatar cralberto11 avatar dd32 avatar dependabot[bot] avatar emfluenceindia avatar felipeelia avatar hideokamoto avatar hlashbrooke avatar joyously avatar jrfnl avatar justingreerbbi avatar kenshino avatar kodemonster avatar mapk avatar mathetos avatar mirucon avatar miya0001 avatar mukeshpanchal27 avatar ntwb avatar pento avatar torounit avatar zzap avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

helphub's Issues

Archives

All archives need some basic tweaking:

  • font size is too small
  • TOC is cut on right side, probably by some overflow: hidden

Use Grunt as the project task runner

Currently both Grunt and Gulp are being used, we should use one or the other.

Gulp is setup for the theme, Grunt for everything else

After a quick impromptu meeting in Salck just now it was decided to use Gulp for all the things

Anyone want to to a shot at this? Happy to help if you do 😄

Page Header needs restyling

The current page headers need to be simplified to match new styling.

Current Appearance
screen shot 2017-08-08 at 9 50 42 am

Proposed Appearance
screen shot 2017-08-08 at 9 50 57 am

Remove centering of text, border, and other misc. meta data. Make sure font size, family, and weight all match new design.

Search bar placement

Any search bar that pertains to the immediate section (Docs, or Plugins, or whatever) needs to be displayed in the subnav area.

Current Search field placement (sidebar)

screen shot 2017-08-08 at 9 58 46 am

Proposed Search field placement (see Plugins)

screen shot 2017-08-08 at 9 57 28 am

Double #main element

We have double #main element on archive, frontpage template and some other places. Initial one opens in header.php to wrap sidebar and main content. The second one, like in archive pages, should be removed from all places.

Localisation Functionality

I'm not sure what the plans are currently for localisation.

Eg. The Japanese Codex is quite frankly as I understand a manual effort at checking change logs on pages and them fixing it. It also seems to be hosted out of WordPress.org

I read there are some indications on possibly making one for DevHub or the whole of WordPress.org - see https://wordpress.slack.com/archives/docs/p1454139890000244

Perhaps we might collaborate on this?

Remove the "Leave a Reply" form

The "Leave a Reply" form is in a column right now covering up content and making it difficult to read. It should be removed completely. I don't think we need to allow comments for doc pages.

Current
screen shot 2017-08-08 at 9 34 02 am

Installating WordPress

On one of the home page widgets, Installating WordPress instead of Installing WordPress.

From what I can see this is a widget header, if someone with the right permissions could edit that widget, alternatively if I am allowed access to edit widgets I can do it.

Thanks

Unique Codex Articles don't fit

So we have a series of articles for WordPress versions, and an 'archive' page for it. See https://codex.wordpress.org/WordPress_Versions

So I paged the core team on this

@Ipstenu: So you're the last one who did multiple changes (anyone else feel free to chip in too). Eventually the leftover non Dev Hub codex pages are gonna be moved into Helphub, there are some pages that don't really fit into the Helphub's general design

E.g. Pages like this https://codex.wordpress.org/WordPress_Versions

So I realised that editing that page and the Changelog page are separate jobs but really it kinda feels like one should able to write the change log and then have the archive generate the links.

So I'm wondering if you guys think it makes sense to create a Custom Post Type maybe called wp_version_article or something, whereby the change log, db numbers, release dates etc all get saved as meta data.

I'm asking this because that Codex article looks like it'll be annoying to manage if you used our Post post type to write it. See https://wp-commhub.mybalsamiq.com/projects/helphub/Single%20article

Should we create a custom post type for WordPress versions? It's a pretty important page.

But I do not know if it belongs to Helphub. But it certainly also doesn't belong to DevHub

Search results template

We didn't include a search results template in the wireframes, but with the search being such a prominent feature of the home page we need to build that out.

Functionality: Automatic linking for hooks (filters/actions)

Overview:
Add ability to reference the correct hook by using a shortcode.

Workflow:

  1. User adds [filter name="the_title"] or [action name="do_shortcode"]
  2. The system will look for a hook name in the reference database
  3. If successful, a link will be created to the reference
  4. If not successful, the name of the filter will be displayed with a red underline (marking missing content)

Implementation:
Should be pretty straight forward.

What do you think? Improvements?

Sidebar Navigation should follow new design styles

The sidebar navigation has the correct background color, but the text and structure need to inherit the new styling.

Current Appearance

screen shot 2017-08-08 at 10 01 29 am

Proposed Appearance

screen shot 2017-08-08 at 10 01 40 am

Solution

  • Remove bullets
  • Add top and bottom dividers
  • Add proper indentations
  • Add accordion sections of links
  • Add proper arrow icons for visual reference of an accordion
  • Main title should just say "CHAPTERS"
  • Use correct color blue for links, correct font size and weight

No Search Results should guide/suggest forums

The flow of this is TBD but in the event that there is no search results, we need to guide the user to the forums in some way. Suggesting topics would be ideal but maybe a nice interface guiding the user would be ok as well. This would should feel like HH did not really fail in providing results but rather saying "I don't have what you are looking for, but I know who does!"

This will be one of the gateways from HH to the forums.

Subnav links need extra styling

The links in the subnav are too difficult to read right now. It looks like they have the new styling, but there's some old styling causing problems.

Current Appearance
screen shot 2017-08-08 at 9 18 56 am

Proposed Appearance
screen shot 2017-08-08 at 9 19 12 am

Solution
This below style should be overwritten by the new one that pertains directly to the link in .main-navigation

a:visited, #wporg-footer ul li a:visited {
    color: #4ca6cf;
}

This below style can be removed completely.

a:visited {
    color: #800080;
}

HOVER STATE
The styling of the hover states need to be added to the anchor tag to ensure it turns white as well. And add the color to turn white for the li and the a tags.

Current Appearance
screen shot 2017-08-08 at 9 26 09 am

Proposed Appearance
screen shot 2017-08-08 at 9 26 18 am

Solution
Remove this style altogether.

a:hover {
    color: #d54e21;
}

We should have contributor documentation

As tools and workflows are sorted out and improved upon, we need a solid contributor guide.

As such, we should be creating a CONTRIBUTE.md CONTRIBUTING.md as is GitHub standard in such cases.

Define and build relevant CPTs & taxonomies

The content of HelpHub will (most likely) need to be built using custom post types and taxonomies. The other option is that we just use the post post type and it's associated taxonomies. Either way we will need to decide what we're going to do and build the appropriate CPTs, taxonomies, and custom fields.

Topics box in page needs proper styling

The Topics box in the page has some of the new styles, but needs a few more things.

Current Appearance
screen shot 2017-08-08 at 9 37 35 am

Proposed Appearance
screen shot 2017-08-08 at 9 39 02 am

  1. Each Topics box should have the header "Topics" with the bottom border.
    SOLUTION: Add the <h2> tag with "TOPICS" as the text. Font weight should be 400 as well.
  2. Each Topics box should also be the correct width.
    SOLUTION: Remove max-width: 35% from .table-of-contents selector.
  3. Font size needs to be adjusted a bit smaller.

Search functionality

WordPress has a decent built-in search, but it might be a good idea to look into how we can improve that. There are plugins that improve the default WordPress search (the ones that come to mind are SearchWP and Relevanssi), so it might be good to investigate an option like that, or look into building an enhanced search ourselves as the search functionality is very important to achieving HelpHub's goals.

Getting more done in GitHub with ZenHub

Hola! @Kenshino has created a ZenHub account for the Kenshino organization. ZenHub is the only project management tool integrated natively in GitHub – created specifically for fast-moving, software-driven teams.


How do I use ZenHub?

To get set up with ZenHub, all you have to do is download the browser extension and log in with your GitHub account. Once you do, you’ll get access to ZenHub’s complete feature-set immediately.

What can ZenHub do?

ZenHub adds a series of enhancements directly inside the GitHub UI:

  • Real-time, customizable task boards for GitHub issues;
  • Multi-Repository burndown charts, estimates, and velocity tracking based on GitHub Milestones;
  • Personal to-do lists and task prioritization;
  • Time-saving shortcuts – like a quick repo switcher, a “Move issue” button, and much more.

Add ZenHub to GitHub

Still curious? See more ZenHub features or read user reviews. This issue was written by your friendly ZenHub bot, posted by request from @Kenshino.

ZenHub Board

SASSify styles

For an easier road moving forward, and since the theme is built on top of _s already, we should use sass for styles.

The benefit to this are modular style rules, making it easier to add/remove styles, and also makes it easier to keep control of the styles that already exist.

It will obviously be a process to set up initially, as development so far was done directly against style.css, but the benefits going forward should make it worthwhile.

Retain links to translated Codex Pages

Moving to Helphub means Codex pages in other languages will lose relevance as the English pages will get redirected.

We'll retain the links to those Codex pages.

#48 aims to fix that

Read Time should check if the post is entirely new

Read Time should check if the post is entirely new or at least if post_content is empty before attempting to run DomDocument() and it's related functions

Now it returns the error message via the Add New Post page

$data->loadHTML(): Empty string supplied as input in /home/hughlash/public_html/wphelphub.com/wp-content/plugins/helphub-read-time/helphub-read-time.php on line 52

Article Categories

Let's define some core post categories.

Eg. Installing WordPress, Moving WordPress, Using WordPress etc etc

Any thoughts?

Travis CI Error - themes/helphub/header.php

Good First Bugs

Fix Travis CI error of themes/helphub/header.php

https://travis-ci.org/Kenshino/HelpHub/jobs/254806894

FILE: /home/travis/build/Kenshino/HelpHub/themes/helphub/header.php
----------------------------------------------------------------------
FOUND 2 ERRORS AFFECTING 2 LINES
----------------------------------------------------------------------
 40 | ERROR | [x] When an array uses associative keys, each value should
    |       |     start on a new line.
    |       |     (WordPress.Arrays.ArrayDeclarationSpacing.AssociativeKeyFound)
 49 | ERROR | [x] File must end with a newline character
    |       |     (Generic.Files.EndFileNewline.NotFound)
----------------------------------------------------------------------
PHPCBF CAN FIX THE 2 MARKED SNIFF VIOLATIONS AUTOMATICALLY
----------------------------------------------------------------------



Contributor tracking

We need a way to

  1. Track contributors (both now and in the future) of article content
  2. Display the article contributors at the bottom of the article

We already have all the current contributors on the Migration document (and any changes should be in the history) but we might want to find a better way to track this.

SCSS files with empty blocks?

Responsive Tables

Some of our articles require tables.

Jetpack would most certainly be available to HelpHub but Markdown Tables are a pain to use. There is a generator - http://www.tablesgenerator.com/markdown_tables

You could paste tables from MS Word (the code generated actually isn't that bad). It's probably the fastest and most intuitive way owing to the nice table drawing system Word has.

But either of these methods aren't responsive.

A possible method is to have the table allow horizontal scrolling via overflow-x

Any ideas?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.