Documentation Office Hours Feb 28 - Moving forward with Curated Docs
Our next weekly Documentation Office Hours will be a discussion of how we can push forward with the plans for the "Curated Docs". Other Documentation Infrastructure discussions would also be welcome, but I'd like to concentrate on the Curated Docs. Please sign in and join the discussion!
See above for the time (hopefully in your time zone; if not, check your user profile). The discussion will take place in the #drupal-docs IRC channel.
Read moreAssociation is prioritizing site builders...
In case you didn't notice, the Drupal Association has made a list of 6 priorities for 2012. Number 6 is "Make Drupal.org awesome for site builders", and Documentation is a large component of this.
So I just thought I'd make sure the Documentation Team was aware of this discussion:
Original page discussing the 2012 priorities: http://groups.drupal.org/node/197558
Sub-page specifically about this priority: http://groups.drupal.org/node/198708
Association group home page (which also lists these priorities): http://groups.drupal.org/drupal-association
Outline for Drupal 7 Site Building quick start guide
The Docs Team has put in a proposal to attend the Google Summer of Code Docs Summit/Sprint in October 2011. This conference includes a sprint, and we decided that we would propose building:
A quick start guide to building a Drupal 7 site (with core Drupal and contributed modules), which we've identified as a missing piece in our official Drupal documentation. (We had a beginner's suite building guide for Drupal 5, which was updated somewhat for Drupal 6, but it has issues and needs to be totally rethought.) This new quick start guide would use a fictitious company web site as an example, and go through all of the steps necessary to build a Drupal site (after the initial installation of Drupal -- we already have good documentation on that part). We would then link to this quick start guide from our Drupal documentation home page, and from other pages on Drupal.org (our intent would be for this to live on-line on drupal.org, and to be a fairly prominent piece of documentation, maintained going forward in new versions of Drupal).
What I'd like to do here is make an outline, so we're ready to get to work on this when we arrive (if our proposal is accepted).
Read moreNeed info on "Standard Issue Tags for Drupal core"
I've been asked to edit the Standard Issue Tags for Drupal core page to correct its characterization of accessibility issues, and, as usual, the editorial eye found more needing to be fixed than it was asked to review.
Specifically in this case, there are cases in which two issue tags are difficult to distinguish from each other. "Accessibility" and "needs accessibility review" is one such instance. Another is "usability" and "needs usability review." The definitions given for these terms don't help clear things up, either.
Before I make sweeping changes, I would like to get feedback from folks who are familiar with the issue queue about a role- and intent-based approach for telling who should — or, sometimes, who may — use any particular tag.
Read moreproposal: server related pages
Hello everyone,
I've just had a debate on the issue queue for core about Fast 404s and how to route around the issue of having Drupal be the 404 handler by default. The debate was enlightening for everyone involved I think. But the consequence should be a documentation page addressing the issue and the multiples available strategies for solving it.
Read moreDrupal Docs As ePub
Here is a proof of concept I was trying out this morning.
I wanted to read the SimpleTest documentation on my (non-internet connected) ereader so I made an ePub document out of the all the web pages. This centralizes the content into an (almost real) book that can be read on most electronic readers (with working Table Of Contents, embedded images, etc).
Due to the file upload restrictions (it doesn't recognize the '.epub' extension), you must change the '.html' to '.epub' after you download it, in order to read it.
Read moreCore Conversations on documentation at DrupalCon?
Hey all -
DrupalCon Chicago's Core Conversation proposals need to be in by next Friday. Jennifer (jhodgdon) and I have been pondering whether and what might make a good topic or two to pitch.
Please post with ideas and whether you'd be interested in attending a docs focused session, it'll help us gear our proposal towards something everyone will be interested in!
Thanks!
Read moreDocumentation Robot: feedback appreciated
I recently got the opportunity to work on an idea that I've had for a few weeks – some kind of automized technical documentation of Drupal sites. It resulted in a rudimentary but working module Documentation Robot, collecting some technical information about the site where it is installed and summarizing it on a page.
It currently collects information about node types (including CCK fields), installed modules/projects, and user roles. In the pipe is also support for documenting views, panels, better CCK field documentation, and a tonne of other ideas I got. I also want to make the collected information re-usable in a number of different formats (for example DITA or creation of book nodes), but that is further off in the future.
Read moreGoogle Code-In (GHOP v2.0)
Greetings, Documentation Team!
Just wanted to raise to your attention that Google is sponsoring a program to help 13-18 year olds get involved in open source called Google Code-In:http://code.google.com/opensource/gci/2010-11/index.html. The program runs Nov. 22 - January 10, and the past incarnation (GHOP) netted us rockstars such as Jimmy Berry (who wrote the infrastructure for our automated testing bot), Daniel Wehner (who is now a Views co-maintainer), and Charlie Gordon (who has done a bunch of work in core on SimpleTest and D7UX patches).
Read moreA DITA documentation distribution for Drupal
Introduction
A couple of weeks ago we launched Modulecraft an awareness & fund-raising project that aims to rally Drupal professionals around a shared effort to create the ultimate toolset for Drupal business. The first fundraising round has as goal the development of a documentation distribution for Drupal that uses a similar approach as the localization server and that enables a distributed/federated documentation architecture for the Drupal project. As a Drupal user you'll be able to get a set of documentation from the drupal.org docs server imported into your own site. You will than be able to edit it and build subsets of the documentation for your own projects. You'll also be able to submit topics that were edited or created by you on your own infrastructure and add them as suggestions to the Drupal documentation server.
The following is a first proposal for the specification of the Documentation system we want to build as part of the modulecraft project. It is by no means complete, and it strongly needs your feedback. This is our first encounter with DITA and our ideas should really be proof checked by technical writers that have extensive experience using DITA. It also contains some proposes a somewhat exotic usage of RDFa, feedback is also very much needed here. In the coming days I'll be adding new sections to the specification here. This is a wiki so be bold! You can add comments either here or at the original posts on the Pronovix blog. I'll be incorporating feedback into this wiki.
Read more



