HelpHub icon indicating copy to clipboard operation
HelpHub copied to clipboard

Single page design of WordPress Version page

Open atachibana opened this issue 7 years ago • 8 comments

Already we have custom post type 'WordPress Version' and some contents were migrated into staging-site with it. Question.

  • Does this page include enough information for HelpHub contents? Though it was converted from Codex, isn't there missing information or feature?

Codex example: https://codex.wordpress.org/Version_4.9 image

HelpHub example: https://wp-helphub.com/wordpress-version/version-4-9/ image

atachibana avatar Jul 07 '18 07:07 atachibana

Hi there,

Just for information: this is an example of major WordPress release but we also need HelpHub pages for minors, e.g. https://codex.wordpress.org/Version_4.9.7 (Security Release) or https://codex.wordpress.org/Version_4.9.5 (Maintenance release) :)

audrasjb avatar Jul 30 '18 07:07 audrasjb

@audrasjb Thank you.

Yes, we know it and almost all pages were migrated, though the recent pages are not yet done. https://wp-helphub.com/wordpress-version/version-4-5-2/

Those migration will be tracked by #248.

By the way, I know the Codex is using wiki-template for fixed sentences and URL links. We should prepare similar shortcode or Gutenberg block...

atachibana avatar Jul 30 '18 11:07 atachibana

Hi @mapk , it came up over the HelpHub meeting that the new pages that are Version Pages replacing the Codex Version Pages may need some sort of differentiation between General Content and Developer Content. @Kenshino suggested we add to this ticket for you to take a look at.

POINT RAISED: The point raised was that the General and Developer content seemed to run together. One possible solution might be to put the Developer content in a separate tab that could be accessed dynamically. The result would be that there would be less content in each section (tab) and that it would be both easier to read and view the more advanced information.

docs-general-development-image-tab

ISSUE: Most of these pages are separated content wise at "For Developers..." then comes "What's New..." This is not always the case though, there are some variances in the content. *see some pages below for comparison *some of these would probably have to be edited to achieve the Tab Separation.

https://wp-helphub.com/wordpress-version/version-4-2/ *page has "For Developers," but it's not an h2, it's a bullet point (probably supposed to be h2) https://wp-helphub.com/wordpress-version/version-4-3/ *page has "For Developers," but it's not an h2, it's a bullet point (probably supposed to be h2) https://wp-helphub.com/wordpress-version/version-4-4/ *"For Developers" with h2 heading https://wp-helphub.com/wordpress-version/version-4-5/

https://wp-helphub.com/wordpress-version/version-4-6/ https://wp-helphub.com/wordpress-version/version-4-7/ https://wp-helphub.com/wordpress-version/version-4-8/ https://wp-helphub.com/wordpress-version/version-4-9/ *developers target (h2) marked "Developer Happiness"

VERSION UPDATE RELEASES https://wp-helphub.com/wordpress-version/version-4-5-2/ *update release pages like this are being migrated @atachibana These pages don't have a lot of information right now. Assumption would be they would be enhanced at some point?

@mapk These pages follow the same basic format where there are Introduction Type paragraphs and then more technical information. They'd probably have to be modified to fit the Tab scheme, but they already flow the same way. If it ended up being a code markup issue, those probably could be done fairly quickly.

ALL MAJOR RELEASE AND UPDATE RELEASE PAGES There is quite a bit of additional information to what is presently on the Codex pages being Migrated located on the news sites. These pages probably can be enhanced content wise at some point, including the update release pages.

softservenet avatar Aug 12 '18 20:08 softservenet

There is no rule in the current Version page in Codex. Someone copy from previous version, others write from scratch. So we should define the rule in HelpHub and modify current contents to follow the rule.

atachibana avatar Aug 20 '18 14:08 atachibana

While I agree the separation would be beneficial, adding more navigation to a page that already has too much navigation doesn't seem to be the right solution here.

Right now, the right sidebar is filled with links that are just overwhelming. I believe we should completely drop the right sidebar and fit all navigation under the left sidebar. Rather than linking every heading though, we should be a lot more selective and only link to main sections of the content similarly to (https://material.io/design/environment/surfaces.html#). I understand this bit is unrelated to the immediate question, but still something that might help our overall structure going forward.

If we want to separate out the dev content from the general content, should we look at doing this in the top level navigation like Material Design does it? Or in the cases when the dev content relates to the general content, they might be able to live on the same page but formatted differently?

Maybe, for now, we restructure the "For devs" part to the bottom of the page and format it a bit differently. Let's try not to add more navigation.

mapk avatar Aug 20 '18 15:08 mapk

Proposed design for WordPress Version single page (Desktop)

  • Sidebar navigation for HelpHub (match DevHub and overall wp.org Meta)
  • Add breadcrumb
  • The right sidebar should be more selective and link to main sections (not implemented in this design yet)
  • Propose the accordion solution for "For devs" section

Version-Single-Desktop-2

wittwitsan avatar Jun 10 '19 14:06 wittwitsan

I like this. The only question about right sidebar (table of contents, I assume): You want to keep it or remove it?

zzap avatar Jul 01 '19 14:07 zzap

I think the side bar should be specific about WordPress versions only.

Kenshino avatar Jul 08 '19 07:07 Kenshino