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 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

Docs at WCSF

As I’m sure you all know, there will be a summit + contributor working days following 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. San Francisco this year. We should decide in advance what we are going to do. We have two working days (Tuesday & Wednesday) during which to tackle docs stuff.

My own feeling is that by Tuesday we’ll be pretty much talked out so I don’t think spending the two days in discussions about docs would be that productive. Instead, we should come up with a project in advance and spend the two days actively working on it. I think it would be best if we all worked together as a team on one single project, rather than working on different things.

Let’s use this thread to discuss ideas. Here are some possibilities:

  • Complete the handbooks – complete all of the content in the handbooks, review content, and make sure that V1 is 100% shipped.
  • Code Reference MigrationMigration Moving the code, database and media files for a website site from one server to another. Most typically done when changing hosting companies. – migration of content from the code references in the Codex to the code reference, including reviewing content, adding examples, and setting up redirects from the Codex
  • Support Hub – start making plans for a new support hub. Sketch out new content. Write content. Get someone to work on designs.
  • Codex cleanup – review of Codex content – editing, truncating, deleting pages that are out of date.

Please make your own suggestions – the sky’s the limit, though remember that we have two days and it’s off the back of WCSF and the summit, so be realistic 🙂

We should come to a consensus in the next few weeks so we can plan how to best use our time over the two days.

Also, can you please leave a note to say if you’re attending WCSF so we know how many team members we’ll have there. And can you note if you’re involved with any other teams and, if you are, how much of your time you think will be dedicated to that team.

#docs-team-meetup, #summit, #wcsf2014

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

Devhub Update 21st August

Thanks everyone who came to the meeting on Tuesday. It was an extra-long meeting because we did a bug scrub. Here’s what he discussed:

Tickets

  • #449 The parser doesn’t yet detect deprecated functions so we can’t move on this. We should have a similar notice for pluggable functions.
  • #197 – closed. Markdown is not being parsed in parameter docs. I’ve opened a ticket on Github for that.
  • #492 – this is an issue with inline docs not being escaped. @DrewAPicture is to figure out what is the best method for escaping markdown, update the handbook, and see that the inline docs are properly escaped.
  • #182 This is wider issue for wp.org and should be worked on by the 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. team.
  • #252 ryelle created a page template for dashicons. We’ll need a new ticket when we need a fuller resources page.
  • 411, 481, & 180 – changes should be landed this week (per @coffee2code & @DrewAPicture)
  • 542 – blessed. @nicolealleyinteractive is investigating

Anything else

  • Changes to examples/curated content & explanations should be landed this week
  • Handbook theme is progressing. We’ll discuss it in more detail next week.

Parser issues

The bug scrub emphasised how much we need a new maintainer for the parser. @Rarst has done a great job but in his absence we need someone to keep it moving forward. The following tickets are pending work on the parser:

Until there’s some work done on the parser none of these tickets can be worked on. If anyone is interested in volunteering please let me know.

What are you working on?

If you’re actively working on devhub, can you please leave a comment on this post with a list of things that you’re working on in order of priority. I want to make sure that everything has a ticket. It will also help me get a better handle on where we need to get more volunteers.

#devhub

Docs Handbook

I’ve done some work on the docs handbook. Here’s what I’ve done so far:

Can any of you who are responsible for different projects take ownerships of the various sections? You can add your name in the handbook spreadsheet. The ones that come to mind:

Whenever you feel like the content is ready for copyediting set it to 95% and I’ll copyedit it.

#docs-handbook

Devhub update 5th August

Thanks to everyone for coming to the meeting. Here’s what we discussed:
1. WP-Parser. We’re still trying to get P2P implemented in WP-Parser. We’ll get there eventually.
2. Voting. @coffee2code is working on the voting functionality.
3. We discussed the proposal for dealing with content in the code reference. Everyone seems happy with it. Waiting for feedback from @drewapicture and then @coffee2code will work on implementation.
4. @nicolealleyinteractivecom sent a pull request for the handbooks. @coffee2code will review and implement.

Content in the Code Reference

Below is a proposal for user-generated content in the code reference.

  • Individual code reference pages are split into three sections:

— parsed content
— officially curated content
— user-generated content

Much like this diagram:

  • Parsed Content will come from the parser
  • Officially curated content will be added by the docs team
  • User generated content will be added by users and filtered via voting.

Here are some mockups:

Function page with curated content

Function page with user-contributed note input expanded

Function page with user-contributed note

Full gallery is here:

This will involve two major changes:

  • examples will become user-contributed notes. These should be able to deal with both code examples and text
  • we will need a way for the official docs to be added. My instincts are that these should be added to the content editing section in the back-end, but at the minute the parsed content is added there. So I’m not sure what the best way to technically implement this is.

I’m definitely open to changes so please make suggestions.

Thanks to @boone for input into this.

#devhub

Help research content creation workflows for the code reference

The code reference is rumbling along – it’s now possible for people to submit examples, source code can be viewed from pages, and we’re working on upvoting functionality. But before we can embark on the grand codex 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 need to have a way for people to create user-generated content. We’ve discussed this before but made no major progress.

What we want: A simple way for people to add supplementary content and information to the code reference.

How you can help: We need example of how other code references allow users to add explanations and content.

Please respond to this post with examples. Just some screenshots would be great. When we’ve collected a bunch of them we can go through them and see what inspiration we can get for our own reference.

#devhub

Devhub update 1st June

IRC Logs
Thanks to everyone who came to the meeting. These were the major discussions:

  • Deprecated files – a decision was made by the docs team to not use a deprecated tag in the file header. We need to decide on whether we’re using CPTs for files (if we do we get deprecated for free)
  • #176 Source code on individual pages – to be implemented by @coffee2code this week
  • @coffee2code confirmed that posts2post can be used on 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/. @Rarst has opened up a ticket to discuss p2p implementation. The options are to either treat it as a Composer library and require it in the parser. Or to assume p2p is enabled as a 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 and run the parser alongside it. Please provide feedback.
  • we discussed settling the theme repository on SVNSVN Apache Subversion (often abbreviated SVN, after its command name svn) is a software versioning and revision control system. Software developers use Subversion to maintain current and historical versions of files such as source code, web pages, and documentation. Its goal is to be a mostly compatible successor to the widely used Concurrent Versions System (CVS). WordPress core and the wordpress.org released code are all centrally managed through SVN. https://subversion.apache.org/. and scrapping the repo 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/. In order to do this, we’ll first need to update the devhub instructions to use tracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. tickets and patches rather than GH pull requests.
  • still pending: better differentiation on search results pages, explanations in the code reference

#devhub