FYI: The Codex & Doc survey is live: http://wordpressdotorg.polldaddy.com/s/documentation-survey
Recent Updates Toggle Comment Threads | Keyboard Shortcuts
Since we’re revving up for the 3.6 release and a Codex Sprint, this post will serve as our “master changes list” for 3.6. This list is by no means complete, so leave a comment if you feel like something is missing. We’ll update it as we go. If you’ve completed a todo item, let us know and we’ll check it off for you.
(needed in time for release):
‘needs-codex’ Trac tickets
>> Look for the Trac comment where needs-codex was added for more info
Audio / Video
The folks at Balsamiq have kindly provided us with a free MyBalsamiq account for the WordPress project. If you want to create mockups let me know and I’ll add you to the account.
I am looking for WordPress users to feature in the introduction of the book.
By WordPress users I mean people using WordPress for their website, blog, etc. I don’t mean people using WordPress as a development tool, to build their business – i.e. people who are outside of the community, who are doing something interesting, and who use WordPress. They’re likely your clients, or your family members, or the people you’ve recommended WordPress to. They may know very little about WordPress – that’s not important, it’s the people that matter. Here’s some examples of people that I’d like to speak to:
- small business owners (e.g. picture framers, watch makers, grocers, restauranteurs, butchers, bakers, candlestick makers)
- political activists (particularly anyone who’s blogged from war zones, uprisings, revolutions, or world-significant events)
- non-profits & charities
- bloggers (mummy bloggers, fitness bloggers, cooking bloggers, knitting bloggers, fan blogs, gossip bloggers, etc etc )
- educational institutions (universities, schools, other educational units)
- governments and government agencies
- anyone who does something interesting and uses WordPress
I’m happy to chat with them on Skype or via email. I’ll be asking them what they do day to day, where they do it, and how they use WordPress.
I’m looking for people all over the world. If you know of someone who you think would be a good fit but they don’t speak English, it would be great if you could act as a translator.
Any help the community could give me on this would be massively appreciated. I realise that I rarely interact with WP users outside of the community anymore . But since many of you have clients, friends, family etc, I was hoping you could point people in my direction.
If you know of anyone who would be interested, please ask them to email siobhan at wordpress dot org.
Update: I need to be in touch with people by 27th May.
Siobhan, WORDPRESS ROUNDUP | Website Design, Websites For Sale and SEO, bdthemes, and 9 others are discussing. Toggle Comments
I’m putting together a survey which we can get people to answer about WordPress’ documentation. I’ll get it online later this week, but I thought it would be worth seeing if you guys had any suggestions for questions that you think would be useful. The aim of the survey is to:
- help to create a new architecture of the documentation
- help us to discover pain points
- create a list of priorities for new documentation
Okay, here’s what I’ve come up with so far.
1. WordPress user (I use WordPress to run my website/blog)
2. WordPress builder (I build and customize websites but I don’t write PHP)
3. Novice developer (learning to write my first plugins/themes)
4. Intermediate developer (I write plugins and themes and they’re pretty good)
5. Advanced developer (I dream in PHP)
What documentation do you currently use (select all that apply):
1. Codex – guides
2. Codex – API documentation
3. Tutorials and guides on blogs
5. Breaking WordPress/plugins/themes and putting them back together
6. Premium services
8. PHP docs and inline documentation
9. Forums (like wp.org or stack exchange)
How useful do you find the WordPress Codex:
What types of documentation/learning do you prefer?
2. User Guides
3. Breaking stuff and putting it back together
5. Code references and API documentation
6. In-person training
7. PHP docs and inline documentation
What’s the first place you go when you have a question about how something in WordPress works?
What do you find most helpful about the Codex:
What problems do you face with the Codex (check all that apply):
Out of date documentation
I can’t find what I need
Content isn’t clear
Content isn’t accurate
Difficult to navigate
What would you like to see more of:
Handbooks focused on specific tasks
Better code reference
Better inline help
What improvements to documentation would improve your experience of using or developing with WordPress:
Have you ever contributed to the WordPress Codex:
Would you like to contribute to the WordPress Codex:
If you’ve never contributed to the Codex, can you please say why:
WordPress › Docs Team Update May 10, 2013 « Make.WordPress.Org Updates Make.WordPress.Org Updates, Eric Amundson, Siobhan, and 9 others are discussing. Toggle Comments
Yesterday in DevChat, @ocean90 requested we write a help tab for the new revisions screen. I’ve uploaded a first-run patch and am looking for feedback and revisions (ha) on that text.
I’d just like to note that I think we can be succinct about this without leaving out important information.
The ticket and patch are on the #23899 ticket.
The following is the first-run text:
This screen is used for managing your content revisions.
Revisions are saved copies of your post or page, which are periodically created as you update your content. Text highlighted in red shows what content was removed, highlighted in green shows what content was added.
From this screen you can review, compare, and restore revisions:
- To navigate between revisions, drag the slider arrow left or right or use the Previous or Next buttons.
- Compare two different revisions by selecting the ‘Compare two revisions’ box to the side.
- To restore a revision, click the Restore This Revision button.
For more information:
Side note: The Revisions Management page is slated for pre-sprint release, in other words, it’ll be done in time for the 3.6 release so forum folks have something to reference.
I got an email from Gary Jones about the CSS property ordering in the Core Contributor Handbooks. He says:
Currently the CCH says the CSS properties should be grouped as:
- Box model
- Colors and Typography
I don’t think this is prescriptive enough, and it’s certainly not easy for core contributors (or theme / plugin developers who also follow the WP standards) to go along through each property and decide which category it fits in to before having to manually move lines up and down.
As part of the Genesis 2.0 CSS reorganisation, I came across http://csscomb.com – it’s available as a plugin for most of the popular editors, but also as an online tool as well. It already comes with tests, but I also did some with multiple properties in a rule (i.e. padding using rem, then px fallback) and mis-ordered browser-prefixed properties, and it sorted them perfectly. It also keeps any whitespace between the : and value, to keep browser-prefixed values lines up, as per the CCH.
If you head to the online tool, then click on Settings, you’ll see it pops-out with a comprehensive list of CSS properties, including ones for CSS3 and prefixed properties, which WP might not have made a decision about if they don’t use them.
I think this tool can be used in one of two ways:
1) Amend the CCH so that Display comes after Positioning, so it then matches the CSScomb defaults and can be easily used by anyone online or in their editor without further set up, making it easy to automate the property ordering process.
2) Take the list of properties, and update it to reflect the order that WP prefers, and make this available as a list (Gist) that can be copied back into the online settings, and as an equivalent file for use in editors (Sublime Text 2 uses a JSON file), including a list of instructions for both.
Being more descriptive, by having someone else keep track of the full list of properties (including CSS4, CSS5 properties etc.), and having a tool that is available for those with and without compatible editors, means that the process can be automated, and a chunk of potential human error is removed.
I’d love to hear what the docs / CS folks have to say about it using this tool. Being able to open a .css file, select all, then hitting a keyboard shortcut to have it automagically match the WP standards has got to be worth investigating?
What do you guys think? Is this something we want to look into?
Below is the outline of the WordPress biography that I’m working on! I’m hijacking the docs blog for this sits it’s sort of documentation. This is something I’ve been researching over the past few months, and am quite far along with the very early sections. We thought it would be a good idea to share it with the community to see if there are any glaring omissions, so if you’re interested in providing some feedback, read on!
Some things to note:
- this is a rough outline of the shape of the book.
- the people listed under “Key People” are not the only people who are relevant. They are those who have been or will be interviewed for that section of the book. There are people who are relevant to many of the sections (Mark Jaquith, Jen, Westi, to name just a few). See my other post on my interview list. Here is a full list of people on my radar to be interviewed so far.
Things to provide feedback on:
- are there any significant areas of WordPress that you feel are missing. Remember that we’re interested in things that had an impact on WordPress and the community, not when you set up your personal site.
- are there any people that I might not have thought of who are relevant to a specific section? Do you have something to say? Do you want to be included? Let me know.
Okay, here it is!
Where WordPress is today.
Featuring WordPress users all over the world to create a snapshot of WordPress use 10 years after it was first launched.
Key people: WordPress users
Part 1: The Blogging Software Dilemma
This section deals with the very early days of WordPress, the state of blogging, b2 development, and the forking of b2.
On the state of blogging in 2002, the founders of WordPress, and why they decided to get online.
This chapter will contain biographical information about the founders of WordPress – Matt Mullenweg and Mike Little. It will look at why they decided to set up their own blogs, and how they got into web development. The chapter will also contextualise blogging in 2002-2003. It will look at how blogging came about and evolved, and where it was in 2002.
Key people: Matt Mullenweg, Mike Little
Key Resources: ma.tt, zed1.com/journalized
Rebecca Blood: http://www.rebeccablood.net/essays/weblog_history.html
Steve Rosenburg: http://www.amazon.co.uk/Say-Everything-Blogging-Becoming-Matters/
On the development of b2.
This chapter opens with Michel Valdrighi in Corsica in 2000. It looks at his experience of software development, why he wanted to develop his own blogging tool, and why he chose PHP/MySQL. It will cover the vision he had for it, the early functionality that went into the software, and the growth of the b2 community. It will look at why Michel ceased development on the software and the effect that this had on the community.
Key people: Michel Valdrighi
Key Resources: b2 forums on tikadada.com (possibly lost), zengun.org
On forking WordPress, forks in general, early WordPress and the community
This chapter opens with Matt’s original post on “The Blogging Software” dilemma, and Mike’s comment about forking it. It looks at what it means to fork an open source project and the history of forks. It looks at why Matt decided to fork b2 and turn it into WordPress. This is followed by the early development of WordPress and the functionality that went into it. It will cover the development process and how decisions are made. It will also look at the growth of the WordPress community, and the significant changes made to WordPress during the first year (including the plugin system).
Key people: Matt Mullenweg, Mike Little, Alex King, Dougal Campbell, Ryan Boren, Christine Selleck, Craig Hartel + any other very early community members
Key resources: WP.org blog, ma.tt, WP.org support forums, early IRC logs (pending), early mailing lists (possibly lost)
Part 2: Freedom 0
This section covers WordPress’s license, the GPL, how it has affected WordPress and impacted its growth.
On the GPL
This chapter will cover the history and background of the GPL. It will look at why Richard Stallman created the license, what it means, and why its is important to many software developers. It will look at how the GPL became the license used by WordPress and what that means for developers and users.
Key resources: Free Software Foundation, Richard Stallman: Free Software, Free Society, the GPL license, cafelog.com
On the Movable Type Licensing Change
In May 2004, Movable Type changed their license. This precipitated a huge influx of people moving to WordPress. The writer, Mark Pilgrim, wrote an influential post that spurred people to move. This chapter will look at the effects of that licensing change, notable people who made the move to WordPress, the increase in WordPress users, and the effect that this had on the WordPress community.
Key People: Anil Dash, Mena Trott, Mark Pilgrim, Om Malik, Carthik Sharma, Panjak Kumar + other community members who helped people to move their sites.
On the ways that the GPL continues to shape and effect the WordPress community
The GPL continues to affect the WordPress community. This will look at instances when discussions around the GPL have caused shifts in the community. It will look at how the discussion around GPL themes influenced the growing theme marketplace. It will look at the distinction between WordPress’s official stance on the GPL and the GPL followed to the letter of the law.
Key people: Matt Mullenweg, Chris Pearson, Brian Gardner + others (?)
Part 3: WordPress, Inc
This section will look at the difficulties around supporting open source software and commercialising it.
On initial attempts to make money to support the growing project
The focus of this chapter will be early attempts to make money to support the WordPress project. It will explore the difficulties of supporting an independent open source project that isn’t intended as a commercial project. It will look at the circumstances around the search engine spam that appeared on WordPress.org. It will look at the announcement about WordPress Inc that was made at the 100K party.
Key people: Matt Mullenweg, Jonas Luster, Toni Schneider
This chapter will look at the setting up of Automattic, early employees and investments that were made in the company. It will look at the ethos behind Automattic and how that works alongside the WordPress project. It will ask how a company can be commercially viable within an open source context. It will look at how WordPress.com and Automattic’s other services have effected WordPress’s growth.
Key people: Matt Mullenweg, Toni Schneider, Om Malik, Phil Black, Mike Hirschland
On commercial themes
This chapter will look at the introduction of the theming system into WordPress and how this changes the user’s experience. It will look at the emergence of the commercial theme market. It will look at the founding of the major theme shops and the issues that they faced. It will look at the relationship, tensions, and synergies between the open source project and commercial businesses.
Key people: Brian Gardner, Adii Pienaar, Justin Tadlock, Ian Stewart, Cory Miller, Collis Ta’eed, other ppl running WP Theme Shops
On the wider commercialisation of WordPress and the effects on the community
This chapter will look at the growth of the commercial economy around WordPress. It will look at how businesses can make money by building their businesses on top of free software. As the commercial theme market has become saturated, it will look at how other businesses emerged, how they evolved, and the effect that this had on the community.
Key people: Cory Miller, Lisa Sabin-Wilson, Ben Metcalfe, Alex King (other WP business folks)
Part 4: The next ten years
(better title needed – want to find a suitable blog post title)
This section will look at the challenges that WordPress faces in the coming ten years.
On going mobile
This chapter will look at the growth of mobile technology and its effect on WordPress. It will look at how mobile technology has changed how people interact with the web, in terms of both browsing and creating content. It will look at how WordPress development has had to adapt and change to meet these needs. It will look at how WordPress plans to adapt further in the future.
Key people: Isaac Keyet, anyone on the mobile dev team, Matt Mullenweg
On the “third phase of WordPress” – as an application framework
This chapter will look at current moves in WordPress to start using the platform as an application framework. It will look at some of the early developers and businesses who are using WordPress in this way. It will look at how community members are starting to push WordPress in new and different directions, and what this might mean for the future.
Key people: Noel Tock, Brad Williams – other application framework folks.
Hi all. I talked to Siobhan about including Documentation in our Gnome participation this summer. @siobhan: Head over to http://codex.wordpress.org/Gnome_Summer_Program_for_Women#Documentation and fill in project ideas and info on whoever from this team is willing/able to mentor an intern (ideally we put more than one mentor with each student). No idea yet how many student slots we’ll get. Feel free to edit the Documentation section as you see fit.
My list of people who have been/will be interviewed, and those that have been contacted. Some things to note:
- Mainly includes only people who were involved prior to 2006 (because that’s where I am)
- If you’re not on the list, and you want to be, leave a comment.
- If you notice someone missing, leave a comment
Donncha O Caoimh
Lorelle van Vossen
Cena Mayo (by email)