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

Bryan Petty 5:20 pm on December 17, 2013

The comments needs a bigger discussion than just a simple vote really.

Is there going to be a simple avenue for users to contribute additions and corrections? I know the content is all managed inline, and that often means a source code checkout, creating a patch, and a TracTrac Trac is the place where contributors create issues for bugs or feature requests much like GitHub.https://core.trac.wordpress.org/. ticket submission even for minor spelling and grammar improvements. That’s a lot to ask of just any user reading the docs who likely isn’t familiar with any of the above. If comments are off, they’re more likely to just ignore it altogether. This isn’t as simple as updating the Codex, and you’re probably already familiar with how neglected that can be.

On the other hand, are there going to be dedicated resources available to moderate comments, convert corrections into valid patches, and maybe even clean out irrelevant comments over time (since these will be comments on permanent pages)? If there’s not adequate moderators, then you’re probably right, there’s not any point to even allowing comments. Maybe it’s possible that someone’s time is better spent applying fixes from comments than trying to review and maintain the inline docs themselves though.
- Sam Sidler 7:00 pm on December 17, 2013
  There are a number of places comments “could be” on devhub. You’re only referring to code reference content, which comes from inline docs. But I’ll go through all of them one-by-one:
  - Code reference: We’ll have examples here and a way to submit examples, but not comments. Instead, we’ll have a way to report an issue – the same way across all docs, see the issue tracker mockups/spec.
  - Handbooks: Again, no comments necessary here as we’ll use the issue tracker submission button.
  - Blog posts: We may want to consider comments on the devhub blog posts.
  - Resources (like Dashicons): There’s no real reason to have comments here, but perhaps an issue tracker submission button would be useful.
  I think that’s all of the items, but I might be missing something. Net result: I don’t think we need comments, outside of perhaps on the blog.
  - Siobhan 2:57 pm on December 18, 2013
    Just to expand on what @samuelsidler has said – my question above was on comments for the handbook pages specifically, which we don’t need comments for.
    
    For the code reference, we’re going to use comments in two different ways:
    
    to enable people to submit examples to the code reference.
    
    to enable people to submit narrative explanations to the code reference.
    
    Any changes to the docs that are generated via the parser (i.e. that are inline) will need to be submitted as a patch to coreCore Core is the set of software required to run WordPress. The Core Development Team builds WordPress..
Eric Andrew Lewis 3:16 am on December 21, 2013

Is there a page that outlines the overall structural plan for devhub? That would be great.
- Siobhan 7:22 am on December 24, 2013
  
  IA: https://meta.trac.wordpress.org/ticket/240
  
  Spec: https://make.wordpress.org/meta/2013/08/14/developer-wordpress-org-specification/

Want to get involved?

Weekly meetings

devhub update

Progress

Actions

Things we need help with

Meeting Time

Want to get involved?

Weekly meetings

Progress

Actions

Things we need help with

Meeting Time

Share this: