WordPress.org

Making WordPress.org

Opened 22 months ago

Closed 6 months ago

#3377 closed enhancement (fixed)

Sync Coding Standards content from GitHub to DevHub

Reported by: netweb Owned by: coffee2code
Milestone: Priority: normal
Component: Developer Hub Keywords: has-ui-feedback has-screenshots
Cc:

Description

Via https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/issues/1269

Following in the footsteps of the wp-cli and REST API projects having documentation sync'd from GitHub to DevHub this ticket is to add a new "Coding Standards" section to https://developer.wordpress.org/

Currently, WordPress' Coding Standards documentation lives on the make/core handbook

WordPress' Coding Standards are not just for Core, plugins, and themes use them, as does the upcoming Tide project, by moving the Coding Standards to a dedicated section on DevHub this allows the plugin and theme handbooks to also link to and reference this documentation.

Previously in #2968 DevHub was updated to support the importing of the REST API docs from GitHub, the patche/s in this ticket build on the changes introduced in that ticket.

The goal is to have the markdown files at https://github.com/WordPress-Coding-Standards/docs imported into a new DevHub "Coding Standards" section at https://developer.wordpress.org/coding-standards

Attachments (4)

meta-3377.patch (3.2 KB) - added by netweb 22 months ago.
meta-3377.png (112.6 KB) - added by netweb 22 months ago.
meta-3377.2.patch (3.2 KB) - added by netweb 22 months ago.
code-standards.svg (1.2 KB) - added by EmpireOfLight 21 months ago.
Code standards icon for Dashicons

Download all attachments as: .zip

Change History (30)

@netweb
22 months ago

#1 follow-up: @netweb
22 months ago

Patch meta-3377.patch SVN copies the /inc/rest-api.php file added in [5992] to inc/coding-standards.php with the proprosed changes for this ticket.

The patch currently doesn't include adding the new "coding standards" section on https://developer.wordpress.org

A patch should be added for this by adding to the appropriate section to /wporg-developer/page-home-landing.php once a design has been finalised.

I had two thoughts for adding the new "coding standards" section on https://developer.wordpress.org

  1. Add another row with the same blue styling as the current REST-API WP-CLI are now

or

  1. Add another row with the same "grey" styling as the current "Code Reference" section (see incoming attachment)

or

  1. ???

@netweb
22 months ago

#2 in reply to: ↑ 1 ; follow-up: @GaryJ
22 months ago

Replying to netweb:

Patch meta-3377.patch SVN copies the /inc/rest-api.php file added in [5992] to inc/coding-standards.php with the proprosed changes for this ticket.

I think the file reference in functions.php needs updating to coding-standards.php.

#3 in reply to: ↑ 2 @netweb
22 months ago

Replying to GaryJ:

I think the file reference in functions.php needs updating to coding-standards.php.

Good catch, fixed in https://meta.trac.wordpress.org/attachment/ticket/3377/meta-3377.2.patch

#4 @obenland
21 months ago

Adding subsections that way doesn't seem very scalable.

@mapk Do you have thoughts on how best to accommodate new sections??

#5 follow-up: @mapk
21 months ago

  • Keywords ui-feedback has-screenshots added

While we're working on this page, it might be a good time to implement some of the new design styles if possible. Is this something we can do?

Desktop
https://cldup.com/6G2TrAnB0k.png

Mobile
https://cldup.com/6TTgiMc5JQ.png

FEEDBACK

  1. Do the two "Coding" modules need to be styled differently than the others? If so, why?
  2. Are these all the accepted icons that represent each category? I haven't changed them from the original, but I always thought "themes" was the paintbrush. Should each of these icons match what's being displayed on https://make.wordpress.org/ ?

#6 follow-up: @GaryJ
21 months ago

I'd agree with the icons matching those on make.wordpress.org where possible.

The Code Reference being the <> makes sense, since that's code reference about Core (which has <> icon on make.wordpress.org).

I'd like to see the Code Standards have its own icon. Since they are code standards for the whole community (Plugins, Themes and Core), I don't think having the same icon as just Core (<>) makes sense. Also, the angular brackets tend to be delimiters in HTML, but the current CS is more about PHP, and to a lesser extent, JS and CSS. As yet, there is no dashicon specifically marked as representing CS/WPCS.

#7 in reply to: ↑ 6 @mapk
21 months ago

Replying to GaryJ:

I'd agree with the icons matching those on make.wordpress.org where possible.

Excellent.


I'd like to see the Code Standards have its own icon.

There's a Design meeting today, I'll add it to the agenda. Maybe we can get one made.

This ticket was mentioned in Slack in #design by karmatosed. View the logs.


21 months ago

#9 follow-up: @cathibosco1
21 months ago

  • Keywords has-ui-feedback added; ui-feedback removed

@mapk brought this up in our design meeting today... I am currently editing dashicons and will gladly create the Code Standards icon.
@GaryJ - do you want to reach out to me to articulate what works best?

Woot!! I believe there was also a request I saw in GitHub for an icon that Gutenberg team needs that features brackets like this: [ ] .....

I'd like to build/design all of the current icons being requested next week for us. Gathering a list.... -thank you

This ticket was mentioned in Slack in #core-coding-standards by garyj. View the logs.


21 months ago

#11 in reply to: ↑ 9 @netweb
21 months ago

Replying to cathibosco1:

@mapk brought this up in our design meeting today... I am currently editing dashicons and will gladly create the Code Standards icon.
@GaryJ - do you want to reach out to me to articulate what works best?

Woot!! I believe there was also a request I saw in GitHub for an icon that Gutenberg team needs that features brackets like this: [ ] .....

I'd like to build/design all of the current icons being requested next week for us. Gathering a list.... -thank you

Awesome, there's an ongoing discussion on WPCS for a new icon here:

https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/issues/540

#12 in reply to: ↑ 5 @netweb
21 months ago

Replying to mapk:

While we're working on this page, it might be a good time to implement some of the new design styles if possible. Is this something we can do?

Sure, thanks for the mockups, any design not mine is better design ;)

@EmpireOfLight
21 months ago

Code standards icon for Dashicons

#13 follow-up: @EmpireOfLight
21 months ago

Just attached the design @cathibosco1 created and posted on the #dashicons-design slack channel. I'll add it to the dashicons for 5.0 list unless anyone has comments.

This ticket was mentioned in Slack in #core-coding-standards by netweb. View the logs.


21 months ago

This ticket was mentioned in Slack in #meta by coffee2code. View the logs.


21 months ago

#16 @coffee2code
21 months ago

In 6512:

developer.wordpress.org: Adapt to new handbook styles as introduced in the Make team sites.

  • Revamps style of handbook sidebar (including making menu collapsible) and in-content table of contents
  • Removes search pane (with imminent switch to search widget) for handbooks
  • Moves breadcrumbs into main content area for handbooks
  • Moves #masthead out of, and before, #page
  • Restyles masthead to have blue background
  • Restyles slide down search pane to not match new masthead
  • Introduces dropdown menu for masthead menu at smaller viewports (as used in WP-CLI Commands)
  • Minor front page revamp of colors (more coming)

Fixes #2969,
See #2459, #3377.

#17 in reply to: ↑ 13 @cathibosco1
20 months ago

Replying to EmpireOfLight:

Just attached the design @cathibosco1 created and posted on the #dashicons-design slack channel. I'll add it to the dashicons for 5.0 list unless anyone has comments.

Refined - working with the template - it is a in a final format now. https://d.pr/i/7OSVR6

I added the .svg and .ai to the design trello board https://trello.com/c/Su0sTmFm/52-new-wpcs-icon

This ticket was mentioned in Slack in #core-coding-standards by netweb. View the logs.


20 months ago

This ticket was mentioned in Slack in #design-dashicons by cathibosco. View the logs.


20 months ago

This ticket was mentioned in Slack in #meta by netweb. View the logs.


14 months ago

This ticket was mentioned in Slack in #docs by coffee2code. View the logs.


12 months ago

#22 @coffee2code
12 months ago

In 7739:

developer.wordpress.org: Revamp the design of the homepage to match the redesign of other wp.org sites (support, plugins, main, etc).

Also changes dashicon used for theme handbook.

Props mapk, coffee2code.
Fixes #2459.
See #3377.

#23 @coffee2code
6 months ago

In 8681:

Developer: Add front page entry for Coding Standards documentation, currently only as a placeholder.

Props cathibosco1, coffee2code.
See #3377.

#24 @coffee2code
6 months ago

In 8685:

Developer: Add base class DevHub_Docs_Importer to handle the majority of DevHub-specific functionality related to importing GitHub-hosted docs.

See #3377.

#25 @coffee2code
6 months ago

In 8686:

Developer: Import Coding Standards documentation from GitHub.

Props netweb, coffee2code.
See #3377.

#26 @coffee2code
6 months ago

  • Owner set to coffee2code
  • Resolution set to fixed
  • Status changed from new to closed

In 8687:

Developer: Enable link to Coding Standards handbook.

Fixes #3377.

Note: See TracTickets for help on using tickets.