Thanks to everyone who attended the devhub meeting…

Thanks to everyone who attended the devhub meeting. Logs are here. The following was discussed and decided:

Markup in inline docs

The markup in the inline docs is currently inconsistent which makes it difficult to parse. After discussion, it was agreed that markdown would be the best option. @DrewAPicture is going to report back to the inline docs team on that tonight.

Search

@toscho has been working on the search. We decided that it would be best to provide search filters so that people can filterFilter Filters are one of the two types of Hooks https://codex.wordpress.org/Plugin_API/Hooks. They provide a way for functions to modify data of other functions. They are the counterpart to Actions. Unlike Actions, filters are meant to work in an isolated manner, and should never have side effects such as affecting global variables and output. for function, hook, or class. We all would like a good autocomplete 🙂

Other stuff

@krogsgard has joined the team and is going to be helping with theme development.

The following actions need to be worked on for next week:

Actions

  • @toscho to add patch for search #172
  • @krogsgard to turn code reference landing page into markup and css
  • @krogsgard to get set up locally for developing for devhub
  • @saracannon to produce final designs for devhub landing page and handbooks
  • @sams to figure out where all of the devhub junk (PSDs, files etc) should live and put them there

As an aside, since we’ve got @toscho and @rarst set up for developing on wp.org, we’ll put together a document (probably for the make/metaMeta Meta is a term that refers to the inside workings of a group. For us, this is the team that works on internal WordPress sites like WordCamp Central and Make WordPress. handbook) that will contain info on setting up a wp.org development environment.

Chat as usual next Tuesday at 16:00 UTC.

#devhub

devhub meeting 24th September.

Had the devhub meeting today. We discussed the following:

  • Moving handbooks to devhub: having the handbooks on make/docs is confusing for new contributors. We need to get them moved to devhub asap. @saracannon can we get an estimate on when the theme will be finished?
  • @hanni has got some people to help out with the pluginPlugin A plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the WordPress.org Plugin Directory https://wordpress.org/plugins/ or can be cost-based plugin from a third-party dev handbook
  • @rarst is set up with his local environment, will get in touch if there are any more issues.

Next week I’m going to be flying at 4pm and then at WordCampWordCamp WordCamps are casual, locally-organized conferences covering everything related to WordPress. They're one of the places where the WordPress community comes together to teach one another what they’ve learned throughout the year and share the joy. Learn more. Europe so let’s postpone the meeting to 8th October.

#devhub

devhub Meeting and Actions

Had our first devhub meeting. The following actions were agreed:

  • @samuelsidler to talk to @saracannon about getting some designs for the homepage.
  • @hanni and @sewmyheadon to come up with theme developer handbook completion grand plan with deadline.
  • @hanni to corral people for pluginPlugin A plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the WordPress.org Plugin Directory https://wordpress.org/plugins/ or can be cost-based plugin from a third-party developer handbook
  • @samuelsidler to follow up with @Otto42 about progress on code reference homepage.
  • @siobhan to get in touch with Greg Brown re: search.
  • @Rarst to get set up locally, review tickets, and choose one or two to tackle.

See you next week at 16:00 UTC on Tuesday!

#devhub

Regular meeting for developer.wordpress.org

Going to start a regular meeting and office hours for developer.wordpress.orgWordPress.org The community site where WordPress code is created and shared by the users. This is where you can download the source code for WordPress core, plugins and themes as well as the central location for community conversations and organization. https://wordpress.org/. This will be held on Tuesdays at 16:00 UTC. #wordpress-sfd

If you’d like to be involved with the project please do come along.

#devhub

@samuelsidler and I have put together the specs…

@samuelsidler and I have put together the specs for developer.WordPress.orgWordPress.org The community site where WordPress code is created and shared by the users. This is where you can download the source code for WordPress core, plugins and themes as well as the central location for community conversations and organization. https://wordpress.org/. Please check them out and comment on the make/meta blog.

#devhub

Handbooks Design Comp – Preliminary

WP_Handbooks_comp-01a

Click to enlarge

Last week I presented an initial design comp for the handbooks in IRC [log] and we discussed it there, and I’m posting here to continue the conversation.  This design builds on previous wireframes, but is very much a preliminary design, as we’re still not clear what theme (or themes) we’ll be using to house the various handbooks yet.

What we do know is that at least some of the handbooks will find their home in existing P2P2 P2 or O2 is the term people use to refer to the Make WordPress blog. It can be found at https://make.wordpress.org/. blogs, so that is what I’ve started with here.

How do you design without a theme?

Legibility, scannability, whitespace, and typography are all things that should serve the content, not the theme, so that is where I’ve focused for now.

I’ve also tried to design with overall flexibility in mind as well; a font change and a few tweaks are all that should be needed for this design to work with most themes.

Here are some highlights:

  • Body copy – The body is set in 16px with a 24 px line height for whitespace, about 80 characters per line.  Helvetica Neue is used here to match P2 blogs but can be easily substituted.
  • Headings – Beyond varying font sizes, I also outdented h1 headings to make them stand out from the body copy.  For h2-h6 headings, I indented them from the body copy, and added border-left to create an added graphic element.  [See all headings]
  • Text Containers –  Content boxes for code, info, alerts, and next steps are color coded to stand out from the body copy.  I’ve used Genericons for the related icons as well.
  • TOC – This is generated automatically, based on the headings on the page.  Only h1-h3 headings are represented for now, and the font weight of each has been varied to make this easier to scan as well.   I’m not sure if lesser (h4-h6 headings) even have a place in the TOC.

Feedback?

Since we still need to figure out the theme issue, this is a good stopping point for the design.  Please leave your feedback in the comments so they can be included in the next round! 🙂

EDIT:  For some context, here is what the design looks like mocked up inside a P2 theme.

#devhub, #handbooks

Better WordPress Code Reference

Discussions have been ongoing about better code reference for WordPress. Here’s where we are so far:

  • @rmccue, @duck_, and @djpaul have been developing the parser, which isn’t far off
  • we need to have a discussion about how be are going to do user contributions. Are we going to use WP comments functionality? I thought it would be cool if we attach a taxonomyTaxonomy A taxonomy is a way to group things together. In WordPress, some common taxonomies are category, link, tag, or post format. https://codex.wordpress.org/Taxonomies#Default_Taxonomies. to the comments we could tag them as explanation or example and they could be spat out in the right place. This would require a Code Reference Moderator, so someone would need to take on that role (and get all of the glory that entails)
  • We have three wireframes which @melchoyce is going to turn into a design. We will need designs for the following pages:
  • landing page
  • individual function page
  • archive page

We also may need:

  • standard narrative page
  • APIAPI An API or Application Programming Interface is a software intermediary that allows programs to interact with each other and share data in limited, clearly defined ways. pages (though @nacin suggested that these would live in the PluginPlugin A plugin is a piece of software containing a group of functions that can be added to a WordPress website. They can extend functionality or add new features to your WordPress websites. WordPress plugins are written in the PHP programming language and integrate seamlessly with WordPress. These can be free in the WordPress.org Plugin Directory https://wordpress.org/plugins/ or can be cost-based plugin from a third-party Dev Handbook)

Here are the wireframes thus far:

Landing Page
Landing Page

Function Page

FunctionPage

Archive Page

archive_page

Please feel free to comment on these, however please focus on the following questions:

  • are there any navigation elements you feel are missing from the landing page?
  • are there any other developer resources you feel should be featured on the landing page?
  • are there any navigational elements missing from the individual function page?
  • are there any content elements missing from the function page?
  • would it be useful to have a page that lists every function, like: https://codex.wordpress.org/Function_Reference?
  • as a developer, are their any elements of a code reference that you would love to see included but that we haven’t allowed for yet?

#devhub