In conjunction with Google Summer of Code (GSoC), Google is hosting a "Doc Sprint Summit" at Google's Mountain View headquarters (California) 17 October - 21 October. I don't know anything about it besides what's here: https://sites.google.com/site/docsprintsummit/
The summit will consist of:
a) An un-conference on open-source documentation topics
b) Everyone who comes for the un-conference will divide up into 5-8 person teams to sprint on writing up a documentation "book" for a GSoC project [EDIT: "project" meaning such as the Drupal project] from this summer. The Drupal project had several GSoC students this summer (see http://groups.drupal.org/google-summer-code-2011), and there are many other open-source projects involved as well.
Anyway, besides participants (hence the post to the Docs group to see if anyone is interested in going), they're also looking for proposals for which GSoC projects could use a doc sprint (hence the post to the GSoC group). Any ideas? (comment below)
The process is apparently that we could submit a proposal for a sprint, and along with that, we can nominate 5 people to attend the conference, whose accommodation and food would be paid for (and they can also apply for travel funds).
So... If anyone would like to attend as a doc sprinter, or has an idea for which of our GSoC projects could benefit from a doc sprint, comment here and let's see if we can put something together! The application deadline is 5 August, so if we're going to get this going, now is the time...
EDIT: See below. Apparently they are looking for proposals from the Drupal project as a whole, not necessarily related to a particular GSoC student project...
Comments
Conditional text?
I don't know whether the conditional text project needs much in the way of documentation, but if it does, it might be a good candidate. The interesting thing about conditional text is that (assuming it actually works well) it makes Drupal much more useful for technical communication in general which would fit with the interests of the summit participants who, I'm assuming, have an interest in techcomm.
Indeed...
I was thinking about this... wondering if we could propose writing up a "how to make great doc in Drupal with Conditional Text etc." sort of book? But I'm not sure if everything else is ready for real time yet.
As far as Conditional Text working well, Tamas (Yorirou) is doing a great job, and it's definitely on track to being a useful module. The UI is still a bit rough around the edges, but we're only half way through the summer, and the functionality is there already.
Drupal programmer - http://poplarware.com
Drupal author - http://shop.oreilly.com/product/0636920034612.do
Drupal contributor - https://www.drupal.org/u/jhodgdon
I think they mean mentor organizations instead of GSoC projects
The way I read the invitation, we don't need an implicit connection with this year's GSoC. I think the GSoC connection is only there to make sure that people attend from those projects that Google is invested in.
I'll investigate more, could be I try to attend.
--
Check out more of my writing on our blog and my Twitter account.
Hmmm.
Ah, on reading the page again I think you might be right. In which case, the proposal would be to make a "Drupal Quick Start" guide:
"... short form Book Sprints to produce 'Quick Start' guides for specific GSoC projects .... Each Quick Start Sprint will bring together 5-8 individuals to produce a book on a specific GSoC project .... Applications for Quick Start Sprints are invited from projects that are part of the 2011 GSoC program." [Drupal is a project that is part of the 2011 GSoC]
The deadline is August 5th. If we apply as an official team from the Drupal project, we should make sure that the documentation that will be produced is something that the Documentation team wants/needs. I don't know that we need an overall "Drupal Quick Start" guide, but maybe we could think of some aspect of Drupal that does need a quick start guide (e.g., it could be a Drupal Theming Quick Start, or something like that -- not that I think we need one for Theming -- I'm just saying that as an example).
Along with the quick start sprint proposal, we can also nominate up to 5 people to go to California in October to participate.
Then it also says individuals can apply to attend the event as well, whether they are from GSoC projects or not. But I think it would be better if we could get together a proposal for a team from the Drupal project, wouldn't it?
===> So can we think of something in Drupal that we need a quick start guide for?
Drupal programmer - http://poplarware.com
Drupal author - http://shop.oreilly.com/product/0636920034612.do
Drupal contributor - https://www.drupal.org/u/jhodgdon
Got clarification
I emailed Carol Smith (the coordinator of the docs summit), and she replied:
No, it does not need to be associated with a GSoC project. In this case "project" is your project - the thing you or your org is working on that you
want to document.
So you are correct kvantomme -- we can make an official proposal from the Drupal project, and it doesn't need to be related to a particular student project.
Drupal programmer - http://poplarware.com
Drupal author - http://shop.oreilly.com/product/0636920034612.do
Drupal contributor - https://www.drupal.org/u/jhodgdon
[Proposal for GSoC Doc Sprint] DrupalGapps
I am a Google Summer of Code 2011 student. I am working on DrupalGapps (Google Apps Framework for Drupal) for my GSoC project.
I'd like to participate in the GSoC Doc Sprint Summit for documenting DrupalGapps. How should I go about doing it? Should I register by myself or can the Drupal community propose/register for me?
Here is my proposal:
What is the project about?
DrupalGapps is a contributed module for Drupal. The project aims at achieving seem-less integration of Google Apps in Drupal.
DrupalGapps is a framework for Google Apps and Drupal integration. It strives to provide API for integration of Google Apps’ management and applications APIs like Admin Settings API, Migration API, Calendar Data API, etc.
DrupalGapps is a contributed module for Drupal and is available at http://drupal.org/project/drupalgapps.
Status of the project:
DrupalGapps was selected by the Drupal community as a project for GSoC 2009. The project was proposed by Ankur Saxena and he successfully completed development of wrapper API for Google Provisioning API (using ClientLogin authentication protocol). Ankur was mentored by Kaustubh Shrikanth (primary) and Robert Wohleb (co-mentor).
Stella Power contributed UI and application which made use of DrupalGapps API to provide UI for user-management in Drupal. This contribution was included in DrupalGapps as a sub-module.
All the work done until here is Drupal 6 compatible.
Further work is in progress on DrupalGapps as a part of GSoC 2011 where Vaidik Kapoor is working on porting DrupalGapps to Drupal 7, integrating 2-legged and 3-legged OAuth authentication and developing Google Docs wrappers and Google Docs like application for Drupal. Vaidik is being mentored by Kaustubh Shrikanth (primary), Stella Power (co-mentor), Ankur Saxena (co-mentor) and Daniel Wahner (co-mentor).
Links: Proposal and project wiki.
As of now, DrupalGapps is available for Drupal 7, 3-legged OAuth integration and development of wrapper API for Google Docs is complete. Further work is in progress.
Some Statistics:
Reported installs: 15 sites currently report using this module.
View Detailed Statistics
Similar Modules:
Reported installs: 14 sites currently report using this module.
Link
Reported installs: 323 sites currently report using this module.
Link
Link
Future Development:
As of now there are a few things that we have in mind that we’d like to see in DrupalGapps:
Reasons:
With DrupalGapps documented, more and more site developers/admins will take DrupalGapps in use for Google Apps integration in a customized web application made using Drupal.
We plan to focus documentation sprint on 3 areas :
Vaidik Kapoor
What docs?
The GSoC Docs Summit is looking for "Quick start guide" docs proposals. Do you think GAPPS needs a "quick start guide", and if so, can you write a short paragraph about what it would document?
Drupal programmer - http://poplarware.com
Drupal author - http://shop.oreilly.com/product/0636920034612.do
Drupal contributor - https://www.drupal.org/u/jhodgdon
I really think that
I really think that DrupalGapps needs a quick start guide and there are a few reasons I have mentioned in my last comment.
I'd like to see the following things getting document:
* “How to Guides” for administrators deploying Drupal and who want to integrate Google Apps with it.
* DrupalGapps code documentation to help developers contribute easily to the module and build features very easily. This would make integration of any random Google Apps service into Drupal very easy.
* “How to Guides” for Developers who want to use Drupalgapps API in their module, hence extending functionality to different spectrums.
The major reasons for documenting DrupalGapps are that it is an old project but has not been in use on many websites because of lack of documentation. There are some similar projects around so developers also have confusions in choosing one. A proper documentation will encourage use of DrupalGapps when Google Apps integration is in question.
Also, DrupalGapps can solve some important issues like SSO with Google Apps hosted accounts. These are some issues I have been directly contacted for help. So my mentor, co-mentors and I think that DrupalGapps should be documented and GSoC Doc Sprint summit could be a very good opportunity.
Vaidik Kapoor
That's a start...
OK, this seems like a reasonable idea... but you will need to narrow this down into a single Quick Start Guide book proposal that people can complete in a few days at the docs sprint. Would people need to be Google Apps or Drupal experts in order to participate in writing this documentation, and if so, can you get enough people together to write the book at the sprint in a few days?
Drupal programmer - http://poplarware.com
Drupal author - http://shop.oreilly.com/product/0636920034612.do
Drupal contributor - https://www.drupal.org/u/jhodgdon
Well it'd be the best to have
Well it'd be the best to have Google Apps and Drupal experts with me writing the documentation.
Better than that - I have my mentor and co-mentor ready to work on this. Kaustubh Shrikanth and Ankur Saxena have confirmed that they'd want to attend the summit for documenting DrupalGapps. Stella Power is ready to contribute in any possible way via IRC or any other way but she will not be able to attend the sprint.
Also, we can prioritise what needs to be documented first and if time is left, we can go ahead as far as possible with the remaining deliverables. Below is the prioritised list of deliverables for the doc sprint:
The above list is exactly the same as in my previous comment. But I have made it clear that this is how we prioritise it and if any time is left, we'd like to work on the remaining deliverable(s).
Vaidik Kapoor
Make it fit...
This sounds like a good plan for your module's documentation, but I'm not sure that the people who are organizing the sprints will pick it unless it is framed as a "quick start guide", which they've described as:
"... short form Book Sprints to produce 'Quick Start' guides for specific GSoC projects." (and I got clarification from Carol Smith that in this context, "project" means Drupal, not a specific GSoC student project).
Again, I'm not the one choosing the proposals, but I'm not sure that your three item list would be chosen as the best "quick start guide", if I had a bunch of proposals to choose from. What do you think? Can you possibly re-frame it as a quick start guide, so that you have a better chance of being chosen?
We also have an urgent need on drupal.org for a different type of quick start guide (on building sites in Drupal 7 -- see comments below)... I don't know if the Drupal project can submit two separate applications, but I think that the general site building guide would have a larger audience than the GApps guide, so that one would probably have to take priority if it's coming from the Drupal documentation team as an official application. But let's think for a few days -- we need to submit applications by August 5th, so we have a little while to think about it. And we might not have people from the Drupal docs team who want to travel to California in October.
Drupal programmer - http://poplarware.com
Drupal author - http://shop.oreilly.com/product/0636920034612.do
Drupal contributor - https://www.drupal.org/u/jhodgdon
One other thing...
You could also apply as an organization, and list your organization as "Drupal GApps module". :)
Drupal programmer - http://poplarware.com
Drupal author - http://shop.oreilly.com/product/0636920034612.do
Drupal contributor - https://www.drupal.org/u/jhodgdon
Proposal...
I was talking to Ariane about this today on IRC during our weekly Docs Office Hours...
We think we should propose a quick start guide to site building with Drupal 7. This would basically be along the lines of the current "Cookbook for beginners" http://drupal.org/documentation/customization/tutorials/beginners-cookbook , which was originally written for Drupal 5 and hasn't really been updated (somewhat for Drupal 6, but not at all for Drupal 7). I'll make an outline later...
So, if we make that the official proposal for the Drupal project, is there anyone who would like to go to Mountain View California at Google's expense, October 17-21, to participate in this documentation sprint and un-conference?
I will nominate myself, but we can take up to 5 people. Is anyone interested in networking with docs people from other open source projects, who has the time to go to California that week?
Drupal programmer - http://poplarware.com
Drupal author - http://shop.oreilly.com/product/0636920034612.do
Drupal contributor - https://www.drupal.org/u/jhodgdon
quick start guide to site building with Drupal 7 proposal
Hi, Jennifer.
Sounds a cool proposal. I have recently joined the group, but I can work in all the project needs.
Regards
Pablo Aviles
Co-founder | CTO.
4Koodi, CRC
Site: http://4Koodi.com
blog: http://paviles.net
Does that mean you want to go?
paviles - does that mean you want to go to California that week to attend the event?
Drupal programmer - http://poplarware.com
Drupal author - http://shop.oreilly.com/product/0636920034612.do
Drupal contributor - https://www.drupal.org/u/jhodgdon
haha, that mean I can.., if
haha, that mean I can.., if we need.
Pablo Aviles
Co-founder | CTO.
4Koodi, CRC
Site: http://4Koodi.com
blog: http://paviles.net
Cookbook thoughts
Here are some thoughts on the Cookbook:
-- The first things to do after installing Drupal
-- Installing and configuring the most common modules (Views, etc.)
-- Downloading a contrib theme and making some changes to it
-- Creating some interactive features like forms and reports.
-- Managing users and content
Things that I don't think belong in the Cookbook include:
Excellent...
Agreed with every one of your points. The idea here would be to make a guide to how to set up a Drupal 7 site, not to replicate the existing Cookbook.
Drupal programmer - http://poplarware.com
Drupal author - http://shop.oreilly.com/product/0636920034612.do
Drupal contributor - https://www.drupal.org/u/jhodgdon
In addition to the above
Hi. New here and have been combing over the site for a while both as a new Drupal user of version 7 (I only briefly used 6 before leaping to 7) and wanting to contribute to the documentation team. Hope you don't mind my input as I have been following (re: lurking) this thread with great interest.
One of the things I would love to see with a Drupal 7 Quick Start Guide/Tutorial is it stop being called a "Cookbook." My thought behind this, beyond what LeeHunter said here is that it is difficult to find on the documents page and unclear that it is for new users (as evident by the discussion here: http://drupal.org/node/1053484).
This might seem trivial, but it might help with clarity and focus of a fresh start mission to those writing it and would certainly make it easier to find in a search later.
I have other thoughts and ideas but I'll stop there since, like I said, I'm new and don't know what other stuff has been done already.
count me in
I think this is a great opportunity to get connected to a bunch of Open Source docs people so I would love to attend.
Additionally I think it's a good opportunity to stack out a time slot in which I can help out with documentation and put some of the DITA best practices I've picked up into action for the Drupal project.
So count me in.
--
Check out more of my writing on our blog and my Twitter account.
Here is the current open
Here is the current open issue on the beginners cookbook http://drupal.org/node/1011470
If there is space, I'd love
If there is space, I'd love to participate as well.
Excellent!
So, I see we have:
- Me
- Kristof
- Eric
- Maybe Pablo?
All of us are interested in going to the Doc Summit and working on D7 Site Building in Drupal: A Quick Start Guide for Beginners (not to be called a Cookbook), which would take the user through the steps of building a site for a specific fictitious company, concentrating on what to do vs. what not to do. :)
Eric: you're aware this is just after the PNW Drupal Summit? I"m thinking if they accept our proposal, I would fly down from Portland after the summit, and return to Spokane, meaning I would just transport myself to the Summit one-way (either get a ride from another Spokane attendee, or fly).
And then we also have a proposal from Vaidik to do a GApps guide, with his team.
Anyone else want to go or have any more ideas? Kristof, Eric, Pablo: Do you definitely want to go to California for that whole week in October? If so, can you send me your email address -- Kristof I have yours, and Eric I should have yours but can't seem to find it at the moment (may have gotten lost in last computer crash)...
Drupal programmer - http://poplarware.com
Drupal author - http://shop.oreilly.com/product/0636920034612.do
Drupal contributor - https://www.drupal.org/u/jhodgdon
Yes, I want.
Hi, Jennifer.
Yes, I want.
My email is ..gmail [dot] com
(I sent you an email)
Best Regards
Pablo Aviles
Pablo Aviles
Co-founder | CTO.
4Koodi, CRC
Site: http://4Koodi.com
blog: http://paviles.net
Chiming in late
I guess I'm a little late, but if you need a backup, I'd also be interested in attending.
great opportunity
It's a great opportunity to contribute and learn, I also really look forward to get to know the docs folks from all the other projects. I'm sure I'll gain a lot of new insights so I'll be there (barring health/family issues of course).
--
Check out more of my writing on our blog and my Twitter account.
So should we apply
So should we apply individually for our sprint on DrupalGapps or our proposal will be included with the community's application (I'm guessing you will be applying on behalf of the drupal community)? The latter would be better as we'll get to meet other community members who will be coming down there. Probably we can do our sprints together. It will be a great experience.
Vaidik Kapoor
Seem separate...
I think the "Drupal 7 Site Building Quick Start Guide" from the Docs team and the DrupalGapps docs are two separate proposals -- although I'm sure Gapps is useful, it wouldn't be part of the standard site building guide for beginners that we want to make. Also, we can only propose 5 people to come per proposal, and we have about 5 already for the docs team, plus 3 from your group.
So how about if you put in your application with the organization as "Drupal Gapps Module", and I'll put in ours for the Drupal Docs team?
Drupal programmer - http://poplarware.com
Drupal author - http://shop.oreilly.com/product/0636920034612.do
Drupal contributor - https://www.drupal.org/u/jhodgdon
Perfect! :)
Perfect! :)
Vaidik Kapoor
Who's committed?
People I know about who have indicated they might want to come to this (6 people, and we can only propose 5):
- Jennifer (me)
- Lee
- Eric
- Kristof
- Pablo
- Also Margo who commented above wrote privately to me and asked to come.
Did I miss anyone else who said they wanted to go?
I think this is a great opportunity to talk to people from other open source projects' documentation teams (the conference portion) and to write some badly-needed Drupal documentation (the sprint portion), and I would like to make sure that the team we propose is really committed to both aspects, and to bringing their experiences back to the Drupal project. I know Lee, Eric, and Kristof well... Pablo and Margo -- I'm less familiar with your backgrounds and how you've been contributing to the Drupal project (or plan to in the future)... anything you can tell me to help decide?
Also... Is everyone on the list definitely able to take off a week to go to California in October (plus travel time), and does everyone still want to go? I'd hate to eliminate one person and then find out that one of the ones I included actually couldn't make it. So is everyone committed?
Drupal programmer - http://poplarware.com
Drupal author - http://shop.oreilly.com/product/0636920034612.do
Drupal contributor - https://www.drupal.org/u/jhodgdon
Add Boris (batgolix)
Another long-time contributor has said he'd like to go (see below). Application deadline is this Friday...
Drupal programmer - http://poplarware.com
Drupal author - http://shop.oreilly.com/product/0636920034612.do
Drupal contributor - https://www.drupal.org/u/jhodgdon
That brings us to more than
That brings us to more than 5, I've been talking with the organizers of the sprint and with Don Day and I think I'll submit a proposal to create a starters manual about writing quality technical information using the principles from the DITA architecture. That would allow us to also get Boris in.
--
Check out more of my writing on our blog and my Twitter account.
It's not a 100% sure Don will
It's not a 100% sure Don will make it, but I've got my proposal in, let's see what comes up.
--
Check out more of my writing on our blog and my Twitter account.
From the rules it didn't say
From the rules it didn't say that you can't propose someone for more than 1 project so I've got Jennifer down as a potential invitee for the DITA thing, that should actually improve your chances for nomination I believe. If the DITA sprint doesn't hold I think I could still join the Drupal start guide team.
--
Check out more of my writing on our blog and my Twitter account.
Actually in retrospect if you
Actually in retrospect if you think that could cause confusion, I'll reach out to the organizers and explain.
--
Check out more of my writing on our blog and my Twitter account.
Just checking...
You didn't make your proposal as coming officially from the Drupal project, right?
Drupal programmer - http://poplarware.com
Drupal author - http://shop.oreilly.com/product/0636920034612.do
Drupal contributor - https://www.drupal.org/u/jhodgdon
nah, I left that out
nah, I left that out intentionally
--
Check out more of my writing on our blog and my Twitter account.
definitely like to attend
I would definitely like to attend the conference and help build the Quick Start Guide as I have plenty of experience writing user manuals for a beginner's audience (mainly in Dutch but also in English).
I have no problems freeing time in my agenda in October for this, so I can commit myself to this.
My only drawback would be the travel time which is more than 12 hrs in my case (best scenario). I don't mind the travelling but if you find a good team that lives a bit closer, than it could be more convenient.
Is the proposal for Friday
Is the proposal for Friday already written? can I assist with it?
I'm down...
I'm 95% sure I'll be out West for the Pacific Northwest Drupal Summit, as well as BADCamp, and I was wondering what I'd do in the interim week, so this sounds like an awesome opportunity. I've been shying away from documentation work recently, and I wasn't involved in the GSoC this year, but I definitely would love to attend the summit and help create these beginner docs. I don't know if I can really swing missing 4 days of work, but I'm sure I can figure out a way to make it work if I can be of assistance.
One thing that I'm curious how you'd like handle are the areas for which there is no clear "right way" to do things (or more precisely: there are 2 or more "right ways"). Some basic examples would be content sliders, "block" and "context" functionality, and admin bars.
Anyway, let me know if I can help.
Thanks!
Alex Urevick-Ackelsberg
ZivTech: Illuminating Technology
Proposal is in!
The Docs leadership decided we should submit our official application with the people we thought had contributed most to the Drupal project (and to Docs in particular), so I went with: myself, Kristof, Eric, Lee, and Boris. Here's what I sent in as the proposal:
Anyone else who didn't get chosen for this application -- sorry! Please do feel free to apply to attend as an individual (which you can from https://sites.google.com/site/docsprintsummit/home)
Drupal programmer - http://poplarware.com
Drupal author - http://shop.oreilly.com/product/0636920034612.do
Drupal contributor - https://www.drupal.org/u/jhodgdon
Wiki...
I've made a new Wiki page where we can collaborate on an outline for this new guide:
http://groups.drupal.org/node/166229
Please feel free to add your suggestions! My hope is that before we get there (if our proposal is accepted), we'll have an outline worked out and can get to work right away. And if our proposal isn't accepted, we can get to work on it at DrupalCon London? :)
Drupal programmer - http://poplarware.com
Drupal author - http://shop.oreilly.com/product/0636920034612.do
Drupal contributor - https://www.drupal.org/u/jhodgdon
Excellent!
Excellent!
I am in too.
I am in too.
SumitK
www.sumitk.net
Short listed! But...
I heard from Google today, and the "Quick Start guide to site building in D7" proposal has made the short list (down to 10 projects out of 60 proposals)!
The only catch is that apparently their budget is short on travel funds. So I've been asked to confirm, for myself, Lee, Eric, Boris, and Kristof:
* can they make it for the entire Doc Summit
* do they need travel assistance
* where will they be traveling from
I've responded already with "yes" (entire summit), "yes" (travel assistance), and:
Lee - Ottowa
Eric - Seattle or perhaps flying from Portland (PNW Drupal Summit?)
Boris and Kristof - Belgium
If any of that information is not correct, please let me know and I'll pass it along... but I'm flying out tomorrow to DrupalCon London (hooray!!), and was asked to reply by Monday, so I wanted to at least get the information that I thought was correct to them. Actually, if you could all contact me and confirm you still are able to go, that would be good!
Anyway, it seems likely that if we're accepted, our group of 5 will be reduced, and likely to the North American folks... I'll let you know when I hear for sure.
Drupal programmer - http://poplarware.com
Drupal author - http://shop.oreilly.com/product/0636920034612.do
Drupal contributor - https://www.drupal.org/u/jhodgdon
That's right for me (but two
That's right for me (but two a's in "Ottawa").
Sorry!
I sit corrected on the spelling of Ottawa. Thanks for responding (and thanks Boris for responding below).
Drupal programmer - http://poplarware.com
Drupal author - http://shop.oreilly.com/product/0636920034612.do
Drupal contributor - https://www.drupal.org/u/jhodgdon
Is there anywhere they have
Is there anywhere they have published the sprints which have been selected for the summit? And have the sprints been finalised or there are going to be additions later?
Vaidik Kapoor
Don't know...
All I know is that I got an email message saying the D7 site building guide was short-listed. I don't think they've made their final decisions yet.
Drupal programmer - http://poplarware.com
Drupal author - http://shop.oreilly.com/product/0636920034612.do
Drupal contributor - https://www.drupal.org/u/jhodgdon
Regarding me: can they make
Regarding me:
can they make it for the entire Doc Summit
-- Yes
do they need travel assistance
-- Yes, at least partially. travel costs from europe will be around 1000 eur (cheapest fair)
where will they be traveling from
-- Brussels, Belgium
Anyway, it seems likely that if we're accepted, our group of 5 will be reduced, and likely to the North American folks...
-- that sounds fair to me. As said before via email: I would be thrilled to participate in an event like this but I have doubts whether that justifies costs & burned fossil fuels
Nope!
We did NOT get selected for the docs summit, unfortunately!
Drupal programmer - http://poplarware.com
Drupal author - http://shop.oreilly.com/product/0636920034612.do
Drupal contributor - https://www.drupal.org/u/jhodgdon
Offer to help (docs sustainability and summit discussions)
Hi, All --
I'm sorry to hear the group didn't get selected for the docs summit -- I've been following that discussion as well as the one from Drupalcon London on docs sustainability and hoping for progress on both fronts.
My business partner (Dick Johnson) and I took a Drupal class and have been gaining Drupal experience (5 live sites so far -- all on Drupal 7 -- for a variety of organizations) and would like to make a specific proposal that we think might help the QuickStart effort for D7 as well as Ariane's options 2-4 from Drupalcon:
2 Divest the handbook from the docs team and write a central guide from scratch
3 Improve infrastructure (possibly XML-based)
4 Recruit more people (we aren't a TON, but there are two of us)
We can help in one or more of the following areas -- would appreciate the team's reaction to how, specifically, we could best work within the team structure. We could get started immediately.
Help write the Drupal 7 QuickStart Guide (under the guidance of someone more experienced than we are). We are certainly not ready to tackle this on our own, but we'd be glad to help if we can.
Prototype the QS Guide as a DITA-based, structured doc set published as a set of topics to a Drupal 7 site. Our specialty is content-rich sites, and we have been experimenting on D7 with what we call DITAmashups: structured and unstructured information colocated on the same site and "linked" with a universal set of metadata.
We have "invented" DITAmashups not as an abstract concept, but in response to many structured/unstructured problems that we have observed and our clients have brought to our attention: How to keep a reasonable level of control over "official" product documentation and still take advantage of the expertise and enthusiasm of the wider community of users.
We envision organizations using the structured set for the tightly-controlled information and the unstructured set (blogs etc) as the informal, crowdsourced information. Both of our sites are works-in-progress. We welcome comments.
You can see the D7 site at www.ditainfo.info. We have also done a WordPress site using the same structured material at www.xmldocs.info. The "about this project" topics explain more about why and how we did what we did.
We've been contributing to the DITA/XML open source community for about 5 years, and we'd like to contribute in a similar way to Drupal, now that we have gotten hooked on its many merits as a publishing platform!
Please let us know how we can best help your efforts, now that we have made some progress on the Drupal learning spectrum.
Thanks, Anna and Dick
Hi Anna - Thanks for the
Hi Anna -
Thanks for the interest and the post.
So, as far as writing an "official guide" - that's not something that Jennifer and I want to do right now - there were some developments at Drupalcon that may lead to us having access to an existing well-written set of documentation, so we want to wait and see what happens with that. This is not the same as the "Quickstart" guide Jennifer originally posted about here - that was to be part of the online documentation in its current state. Since we are discussing whether or not to continue maintaining that, we should hold off on any official work on that. Of course, if you want to take it upon yourself to start on it, nobody will stop you.
Also, as far as needing the guidance of someone more experienced, we need to figure out how the community can support that, as Jennifer and I have limited time for this sort of work - part of what I was getting at with needing the team to be more self-sufficient and self-driven.
When it comes to DITA/D7 it's really not possible to take that on right now. We don't have the ability to set up D7 sites on the current Drupal.org infrastructure. Also, there is very little infra support for docs and setting to building a DITA style site on an official Drupal.org subdomain is an enormous task for the resources we have. If you want to get involved with a similar project, I suggest you look at the Help System plans and help there: http://drupal.org/node/1095012
Lin Clark (who specializes in RDFa/semantic web) is also looking at possibilities for infrastructure and integrating offsite/unstructured/crowdsourced docs, while Jennifer and Kristof Van Tomme look at DITA prototypes to try out for the D7 Help System. Once we get further down the road with those, then we might be able to talk about any infra changes for the Docs. But that said, if we go the route of making the current docs a wiki and having a small curated official guide, then that is quite unlikely to end up using DITA.
Overall, I'd suggest helping with the Help System initiative, as it seems to suit your specializations well and there is a structure/plan in place so that you can actually get involved in that. The greater documentation question just needs a lot more planning and discussions before we are even ready for help.
In the meantime, it'd be great if you want to help with the more day-to-day needs of the http://drupal.org/project/issues/documentation and Core Documentation queues, or writing/curating documentation, or helping with existing Docs infra issues.
Hope that helps - feel free to work on anything you like in the existing docs/infra - we just aren't ready for taking on the major changes to the online docs right now.
EDIT: ps. Jennifer is on vacation right now, but I'm sure she'll respond once she's home as well.
What Ariane said...
I second what Ariane says... would be happy to have your input and help on the help system project, which will be more DITA-like than the current Handbook, if we can pull it off. I plan to make a post in the next week or so with a task list... watch this space (well, actually, watch the docs group -- I won't post it here, as this post is about the Google docs summit specifically). I'm back in my home office on Sunday...
Drupal programmer - http://poplarware.com
Drupal author - http://shop.oreilly.com/product/0636920034612.do
Drupal contributor - https://www.drupal.org/u/jhodgdon