Siobhan 11:06 pm on May 20, 2014
Tags:   

Devhub Update 20th May

IRC Logs

Thanks to everyone who came along for this week’s devhub meeting. It was a long one! Here’s what happened:

Current Priorities

1. Deprecated files – we need feedback from the docs team on this issue. Does it make sense to use deprecated tags at file level? You can find the exact discussion here. @kpdesign can you raise this at the docs meeting – I won’t be able to be there. Please report back in this thread.
2. #176 Source code should display on individual pages. @atimmer and @coffee2code have been working on this. We expect it to land in the next day or two.
3. #79 Used by/Uses – this is partially being parsed but we don’t have storage for it. @Rarst suggested implementing post relationships using Posts2Posts. @coffee2code to check whether this is possible on wp.org
4. Examples – examples are nearly ready to go live. Assigned to @coffee2code to implement. A separate discussion will be had about explanations.
5. #450 Better differentiation required on search results page. @sofia-rose will be posting designs for discussion.
6. We discussed bundled libraries and came to a consensus that they should be included. This means we have to deal with two things:

  • grouping and indexing them
  • dealing with them in the search results

The second of these ties in with the previous point – better differentiation required on search results page. The search results page needs to show on the one hand, what the thing is (function, method, etc) and also a quality of the thing (deprecated, external, etc). @nicolealleyinteractive is going to put together some mockups for discussion. For reference, this is how deprecated was displayed in Mel’s original designs.

Following this, we did a pass on developer.wordpress.org tickets and closed a bunch of them (yay!)

We did open one ticket: #481. Admins will be able to edit parsed code reference content, but in order to publish they will have to enter the number of the corresponding coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress. tracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. ticket to update the docs. This will ensure that we keep track of changes and they get properly parsed.

Devhub organisation

@DrewAPicture raised the question of the relationship between devhub and core so I’ll use this opportunity to clarify:

  • the aim of the devhub project is to produce developer resources for developers working on WordPress (this includes theme and 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 developers, core developers, people building custom sites etc)
  • the code reference is one part of that project and is a resource aimed at all WordPress developers
  • I (Siobhan) am leading the project with @samuelsidler as my sidekick
  • @Rarst is the current lead for WP-Parser. He has extensive experience with building a code reference for WordPress.
  • WP-Parser was originally developed for using on 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/ but we also want to ensure that it is useful for other developers. Therefore if it has no negative impact on devhub, we are happy to incorporate changes the accommodate other use cases. If that includes parsing information that core doesn’t need and if parsing that data doesn’t have a negative impact on wp.org/ref then we will parse it
  • devhub chats happen weekly, we have a tag on trac, and a tag on make/docs. Everything is done in public. No decisions are made behind closed doors. If members of the core team (or anyone else) would like to help steer the project those are the places to get involved. Please do get involved. We would love more participation.
  • when it comes to implementation on WordPress.org, we defer to @nacin and @coffee2code
  • if anyone from the core team feels that we are missing the mark somehow, please get involved with the project.

Further tasks

In addition to the above, the following needs to be done:

#devhub