devhub update

Long meeting today in devhub land! Here’s what was discussion:

  • WP-Parser: methods need to be broken up into CPTs
  • WP-Parser: amendments need to be made to how inline docs are parsed into the_content
  • we discussed editing of content in the code reference in the WordPress Admin. We agreed that only admins should be able to edit the content and only in extenuating circumstances. @siobhan to open the following tickets:
    • that the_content be locked for code reference post types to admins only 411
    • that an internal flag system be added so that we can keep track of things that have been edited (with a view to the docs team ensuring that all inline docs patches are updated prior to a WP update 412
  • we agreed that the 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 dev handbooks should stay as CPTs, and that @nlarnold1 is free to do as she chooses with the handbook plugin
  • I made a list of proposed templates for the theme, but @nlarold1 has been using template parts and gave me an excellent lesson on how they work. Nicole to edit and update the google doc
  • We discussed changing the prefix for the CPTs generated by WP-Parser. Currently it’s wpapi which will potentially be used by a feature pluginFeature Plugin A plugin that was created with the intention of eventually being proposed for inclusion in WordPress Core. See Features as Plugins. and it would be nice to keep them separate.

#devhub

devhub chat time change

Everyone, the new devhub chat time will be at 19:00 UTC on Tuesdays! Same place: irc.freenode.net, #wordpress-sfd

#devhub

devhub update 26th February 2014

Thanks to everyone who came along last night. These were the main discussions:

  • the main blocker right now is #27200. Missing package and subpackage tags from file level headerHeader The header of your site is typically the first thing people will experience. The masthead or header art located across the top of your page is part of the look and feel of your website. It can influence a visitor’s opinion about your content and you/ your organization’s brand. It may also look different on different screen sizes. docblocks can cause those functions/classes and others to be skipped by the parser. This is being addressed by the inline docs team.
  • @nlarnold1 is continuing to work on the styles. There some issues around content not being parsed into the right format.

We’re having an extra meeting on Thursday 15:00 UTC to work thought some tickets. It’s a great time to come along and get involved!

#devhub

devhub update 7th February

We had an extra devhub meeting on Thursday to go through the site and come up with a list of tasks. We focused specifically on the code reference for now, and have broken things down into a series of tickets.

Tasks

  • the styling needs to be adjusted in the headerHeader The header of your site is typically the first thing people will experience. The masthead or header art located across the top of your page is part of the look and feel of your website. It can influence a visitor’s opinion about your content and you/ your organization’s brand. It may also look different on different screen sizes. to make it consistent with 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/. Tickets: 313, 318, & 320 (@nlarnold1) 321 (@Rarst)
  • minor design adjustments on the landing page 319 (@nlarnold1)
  • correct page templates to be applied to single code reference pages 322 and search results page 328 (@rarst)
  • Used by and Uses information to be retrieved from parser and added to archive templates 323 (@rarst)
  • the following require styling: archive pages 325, single code reference pages 329, breadcrumbs 326, and pagination 327 (@nlarnold1)
  • archive pages required so that users can browse by file 330 and by version number 331 (@rarst)

Devhub docs

Getting set up locally to develop for devhub is not the easiest task in the world. Currently we have some docs on the meta wiki. @Rarst is going to go through the wp-cliWP-CLI WP-CLI is the Command Line Interface for WordPress, used to do administrative and development tasks in a programmatic way. The project page is http://wp-cli.org/ https://make.wordpress.org/cli/ process with @nlarnold1 and I’ll use the log to document it in the docs handbook.

The next meeting is Tuesday as usual at 15:00 UTC.

#devhub

No devhub tonight

I’m taking a few days off so no devhub meeting tonight (unless you guys want to get together and work on some tickets 🙂 ).

#devhub

Devhub Meetings

No devhub meeting tonight because it’s Christmas Eve!

And next week is New Years Eve.

Next devhub meeting: Tuesday 7th January 15:00 UTC

Merry Christmas, WordPressers!

#devhub

devhub update

Time for a devhub update! This is in lieu of today’s meeting which we’re punting due to a few of us not being able to make it.

Progress

@Rarst has been making inroads with the underlying code while @krogsgard has completed the handbook page templates and the landing page. Brian has also made some changes to the code reference design to make it fit in with the overall design. It looks like having the theme ready to commit is imminent.

But before we get there:

Actions

  • @Rarst is creating a githubGitHub GitHub is a website that offers online implementation of git repositories that can 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/ repo so that he and @krogsgard can collaborate more easily and merge what they’ve both been working on. Whenever things are ready we’ll get them uploaded to tracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. to be merged via 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/.. We’ll post a link to the repo as soon as it’s live.
  • the generated menus are proving to be tricky from a styling perspective: https://cloudup.com/czireMQkmBm @krogsgard to talk to @saracannon to come up with a way to approach this.
  • need to decide whether we want comments for the handbook pages (I vote no)

Things we need help with

  • The current handbook 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 needs some changes made to it. (new CPTs and some markup for the “watch this page” functionality) (#250)
  • the menus are currently hardcoded – we need to decide what links we want on the handbook landing page.
  • breadcrumb functionality is needed for the handbooks (#251)
  • The default handbook template looks like this https://cloudup.com/ccncFsyL5iA but the widget doesn’t really have the styles of the design (numbered stuff). We need to work out the logic for the sidebars
  • @sams asked about dashicons being hosted on devhub. We will create a page at 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//resources/ for hosting things like dashicons (#252)

Meeting Time

Due to my relocation to Thailand, the devhub meeting time will now be Tuesdays at 15:00 UTC

#devhub

devhub: 29th October 2013

Not much has moved on since last week. Here’s what we need to do. We need to see progress next week or we’ll have to start looking at how we can get things moving:

  • @krogsgard to provide @rarst with CSSCSS CSS is an acronym for cascading style sheets. This is what controls the design or look and feel of a site./HTMLHTML HTML is an acronym for Hyper Text Markup Language. It is a markup language that is used in the development of web pages and websites. for code reference landing page
  • @saracannon to send designs to @krogsgard
  • @sams to put together a plan for moving content to devhub (basically, we need a theme, then CPTs made, then content moved)
  • @toscho to continue working on search

#devhub

Feedback on Devhub Designs

Hey Docs team! Good Monday (or Tuesday) to you!

@saracannon has put together some designs for the devhub and we’d love your feedback. Keep in mind, these are initial designs and some spacing, alignment, and font sizes will change during implementation

First up, the devhub homepage. This design incorporates everything asked for in the initial mockup:

devhub-home

@saracannon also worked up an alternate version of this design with brighter colors.

Last up, the handbook design.

handbook-design

What do y’all think? Anything missing you’d like to see? Anything you see that you don’t like?

#devhub

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