DevHub getting a new look

Update

With the feedback received last week, the design team worked on a second iteration in Figma. If you haven’t given us your feedback, please do so in this file. Feedback will be open until December 2, 2022, as we want to proceed with the work.

What is the new look about

With all the redesign happening in WP.org, it is now time for Developers documentation. The design team has started with a new look but need feedback from documentation users.

Developers documentation is composed of handbooks and articles. At this time, the handbooks will not be redesigned.

What we need feedback on?

  • Compare and review the landing page. Changes include:
    • First blockBlock Block is the abstract term used to describe units of markup that, composed together, form the content or layout of a webpage using the WordPress editor. The idea combines concepts of what in the past may have achieved with shortcodes, custom HTML, and embed discovery into a single consistent API and user experience. links the handbooks under Developer Reference
    • The second block splits the Code Reference into New and updated in 6.x version and the Common APIs handbook TOC
    • The link to Dashicons was removed since they have been deprecated. Do they still need to be linked under Resources? Or shall the link move to somewhere else?
    • Does this navigation make sense?

Other sections that need review

  • Breadcrumbs have been moved to the blue ribbon
  • User contributed notes
  • User contributed notes feedback form
  • Styling in the code block (highlighting the title and keeping the code background white)
  • The general Add note/feedback form
  • The changelog at the bottom of the page will be expandable

Feel free to leave your comments in the Figma file or in this post.

Props to @joen for feedback on this post and @javiarce for his design work.

#devhub

Devhub update 16th December

Apologies for my lack of updates of late. Meetings have been going on in SlackSlack Slack is a Collaborative Group Chat Platform https://slack.com/. The WordPress community has its own Slack Channel at https://make.wordpress.org/chat/., but I’ve not been good at writing up the notes.-

This week we discussed:

  • parser@coffee2code will be running the parser after 4.1 lands tomorrow. Re-parsing will reveal some new goodies, such as the Used by/Uses information
  • explanations@drew has a patch to scott to review. Once explanations land we’ll start testing them.
  • design – jan, who’s on the dot org team at automattic will be redesigning devhub in the new year
  • related content – we discussed #174 – link to generally related functions/classes. We’ll return to it next week after the Used by/Uses information lands.
  • plan for 4.1 parsing@coffee2code will run the parser tomorrow shortly after release. Please be available in the devhub room in case we have issues (especially you @Rarst 🙂 )

Committed this past week:

  • Introduced get_summary() and used it. Abstracted the fact the summary (aka short description) is stored in post_excerpt, primarily to force display of special characters.
  • Displayed function/method return types in the same style as parameter types (parenthesized, italicized)
  • Italicized parameter types in the display of the method signature
  • Enabled display of inline source code for classes
  • Moved formatting-related code into dedicated include file

#devhub

No Devhub Chat Tomorrow

Per @samuelsidler, there will be no Devhub chat this week.

Next chat will be Tuesday, 11/11/2014 at 20:00 UTC.

#devhub

Devhub update 10th October

Thanks everyone who attended the chat. The logs are here.

WP-Parser

There was quite a lot of work done on the Parser at WCEU

  • Luca and Anton did some test sources
  • @atimmer has done some fixes and will be integrating P2P
  • Julio started on the admin 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. box ticket

Other parser stuff:

Code reference

  • lots PRs from @tarendai at wceu
  • @coffee2code to implement redirect from /themes/ to /theme/ and /plugins/ to /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/

devhub to-do list

@sams has put together a to-do list for WCSF. These are all things that need to be done by WCSF. Most are being kept in hand by @coffee2code. Except for:

  • Some assistance from a designer is required for #630.
  • the MediaWiki plugin is being dealt with by @otto42

#devhub

No devhub chat today A bunch of us…

No devhub chat today. A bunch of us were at WCEU and are in various states of travel and tiredness. We’ll resume again next week.

#devhub

Devhub Todo List for pre-WCSF

Prior to WCSF we need a few changes on devhub so that y’all can make awesome handbook improvements as your project. I’ve come up with a list of things that seem important prior to WCSF. This list may not be exhaustive, so we’ll add to it as we come up with other things. In general, the following are in list by importance.

  • Fix image uploads on devhub, which is currently preventing us from migrating the theme developer handbook.
  • Add the Mediawiki 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 for external redirects so we can redirect Codex pages to devhub (#meta446)
  • Add voting to examples (#meta551)
  • Create a new user role for handbook editors (#meta621)
  • Add the code TinyMCE plugin to devhub
  • Various handbook design changes (#meta631)
  • Improve the design of the callout shortcodes (#meta630)

#devhub, #handbooks

Devhub Update 23rd September

Thanks to everyone who attended the meeting today! Here’s what we discussed:

Parser

  • before the content is parsed again we need a hook to allow long descriptions to be stored in 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. instead of post_content. @drewapicture has submitted a pull request

Code Reference

  • examples have been turned into User Contributed Notes. @coffee2code will make them live to the world at large
  • work on voting is still in progress
  • rather than using shortcodes for quick reference, we’ll implement auto-linking to do it automatically.
  • @coffee2code will redirect /themes/ and /plugins/ on devhub to /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/

After some meta tracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. tickets about changes to inline docs, we discussed how to approach suggestions for changes to the code reference. This presents a challenge because while the page appears to be a whole on the front page, it actually comprises a number of different elements:

  • parsed content
  • curated content
  • user contributed content

@DrewAPicture is going to open a ticket and create some mockups for a front-end to deal with this type of feedback.

Handbooks

  • @sams continues to work on handbook migrationMigration Moving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies.
  • @DrewAPicture create a patch for ticket #1. Yay Drew! @coffee2code to implement

General

We now have different, clear types of activity that contributors can carry out across 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/. I’ve opened a ticket to somehow have this activity integrated with profiles.wordpress.org.

IRC Logs

#devhub

Devhub Update for 16th September 2014

Short meeting this week as only @coffee2code and myself were able to attend. @DrewAPicture sent in his status as well. Logs are here.

  • No news on parser work.
  • Scott landed some things related to better formatting hash parameters.
  • There are image upload problems on devhub that Scott is looking into. I’ve put the theme handbook migrationMigration Moving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. on hold while he investigates.
  • The handbook theme has a few issues that need to be fixed but we weren’t sure if @nicolealleyinteractivecom had work in progress. I’ll file a catch-all ticket with the issues.
  • Upcoming from Scott is also the rename of “examples” to “user contributed notes” and finishing up voting.

That’s about it. Hopefully we get more attendees next week. 😉

#devhub

Devhub Update 11th September 2014

Thanks to everyone who attended the devhub chat! Here’s what we discussed:

Parser

I’ve been throughout the issues on githubGitHub GitHub is a website that offers online implementation of git repositories that can easily be shared, copied and modified by other developers. Public repositories are free to host, private repositories require a paid subscription. GitHub introduced the concept of the ‘pull request’ where code changes done in branches by contributors can be reviewed and discussed before being merged be the repository owner. https://github.com/ and marked any that are devhub related. There aren’t that many. If I’ve missed any let me know.

Code reference

  • @coffee2code ran the parser for WP 4.0 (thanks!)
  • the workflow has been implemented for editing parsed content in the code reference. If anyone wants to help test let us know.
  • parsed content has been moved to metadata so the main post editing area can be used for curated content
  • lots of the code reference archive pages need some sort of 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. to allow users to only pull up the information they need. Opened ticket 601
  • @siobhan to write user contributed notes content
  • @coffee2code is working on implementing voting

The Great MigrationMigration Moving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies.
We’re approaching the point at which we can migrate content from the Codex to the code reference. Some considerations:

  • all code reference pages in the Codex will need to be redirected to their equivalent page in the code reference.
  • we’ll need to develop a style guide for formatting explanations. I’ve opened a ticket for discussion of it 602
  • we’ll need to develop a workflow for moving content over from the Codex

Handbooks

No outstanding technical issues. @samuelsidler is working on migrating the content.

IRC Logs

#devhub

Devhub Update August 26th

Thanks everyone who came to the meeting! Here’s what we discussed:

Parser

  • @Rarst has committed some pull requests. 124, 123, 122, 121
  • @siobhan to go through WP-Parser issues and mark any that need to be worked on for devhub

Code Reference

Handbook Theme

  • @sams to report back on content migrationMigration Moving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. and report any issues with the theme that appear during migration.

Note: if anyone is making any major changes please open a ticket on tracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. to go with the change.

#devhub