Documentation

Events happening in the community are now at Drupal community events on www.drupal.org.
Tresler's picture

We're getting some great feedback and collecting some amazing pieces to be used in documentation, and I'm looking to start aggregating this into a single place. I'm not positive I'm the one to do this so speak up if anyone has a better plan.

What I'd like to start doing, structured around the lessons. Is the folowing process.

Pre-lesson:

A) Collect all the handbook pages, api.drupal.org pages, and various tutorials found around the web to a single place (a thread here). This will constitute 'pre-reading' for anyone who wants it, so that we can go into the lessons with a better idea of what to expect.

B) Anyone who can should point out vague areas in the documentation before the esson - this will give josh_k and company some input as to what needs clarification from an xpert.

Post-lesson

A) Start the feedback thread as we did this time.

B) Start the wiki of the class notes as VicktorKane was nice enough to do this time around.

C) Roll all the 'pre-reading', screen-casts, audio logs, and outside web tutorials back into a handbook page - perhaps ust a revision of an existing handbook page.

To me, this creates a product outside the dojo that we can point to when we get new users who want to catch up.

Also, and perhpaps more importantly, it clears the waters of the drupal handbook. The documentation team doea an amazing job, but it would be impossible for them to create the type of Robust lessons that we are creating as simple record-keeping. Adding a screencast and audio to the handbook (perhaps not hosted on d.o), would be a huge benefit. Also, rolling disparate tutorials and handbook pages back into a more reduced - clear version, would help a lot of new users out.

Thoughts?

As soon as I can I want to start doing this retroactively for the first lesson. To that end...

Anyone interested in this effort should read this to start: http://drupal.org/node/14279

More threads on Forms API:

http://drupal.org/node/37775 - and its children
http://jeff.viapositiva.net/drupal/dynamic-forms
http://natrak.net/node/330
http://www.lullabot.com/articles/forms_api_2_0_cheat_sheet - this one is priceless -
http://www.drupal.org.uk/forms - and its children
http://drupalcon.org/node/31
http://www.hiveminds.co.uk/node/923 - worthwhile? - need to read the reasoning further.

Add to these in comments and I'll roll it back into the body of this.

Finally, this is a bit of a monumental task - I don't know that I can do it weekly, as it involves a lot of reading, and editing, and getting involved. At the moment, the only 'solution' I have to that, would be a two o three team effort where team A oes week one, four, seven, etc... although first let me guage interest. ..

Comments

Screencast

webavant's picture

Yes I did add the screencast here: http://www.webavant.com/drupaldojo/2007_01_04_swf.

Also, this is off topic, but I've added a browser-based VNC viewer, the technology we're using instead of WebHuddle for the live screen sharing. I've added a snippet to a screen that will list any Skypecasts, scheduled or live, with the phrase "drupaldojo" in the tags. So when whoever creates the skypecast, make sure to fill in the tags field. I have also added a java IRC client for those who don't care to tinker with software, it logs you right into the chan and can be hidden by shrinking it's frame for those that don't need it. Check it out here: http://www.webavant.com/vncviewer/

Sweet!

Not sure where else to post this but ...

ambereyes's picture

I cannot seem to get further than 12 minutes and 19 seconds. Is it possible to create a downloadable version?

Katrina


ambereyes.net

Download++

joshk's picture

Hopefully we will get all these released in MPEG-4 format so that people with video-editing ideas can also remix them.

http://www.chapterthreellc.com | http://www.outlandishjosh.com

Thank you

sgomez's picture

Josh, thanks for the great instructional video. The pace was fast but good. Keep it up. I look forward to more.

webavant, thanks for the flash video. I missed the live session, and was happy to find your message on my email.

Yes, some thoughts

glendac's picture

Sounds like a good process, Tresler. I would like to volunteer for the more ‘predictable’ parts of the process – collecting relevant resources from many locations in d.o and the wider web out there and integrating pre-, live, and post- documentations into one page.

Since most of the challenges of documentation in a community effort like Drupal lie in keeping open many channels of content input while also creating an organized framework for its later retrieval and use, perhaps we can identify more explicitly which documentation is open for threaded comments and which ones just for additions or edits to the main text. For every lesson, we can specify the following documentations and its content format:

  1. Lesson Announcement - Forum.
  2. Pre-lesson 'reading list' - Page. Editable (added to in the form of more resources or abstract/criticism of a resource in main body of list).
  3. Capture of live lesson
  • Narrative - Wiki page.
  • IRC Log - editable page.
  • Screencast - external link?
  • Audio - external link?
  • Post-lesson integration - handbook page (sort of a TOC of links to the above resources following the structure of the lesson and part of a larger table of content for all dojo lessons?)
  • Redundancy will creep into the process (e.g. resources in a list and same resources referenced in context in a narrative) but perhaps we can make this work to emphasize parts of the lesson rather than wasting precious time on merely 'freezing' content. Also, there's the danger that extensive resource lists distract rather than focus attention on actual doing but then again they might help address different levels of expertise within the group. We'll see.

    Speaking of documentation, I

    anthonyoliver's picture

    Speaking of documentation, I did a huge (like 10 page w/ screenshots) write up on using views. I haven't heard back from Merlin yet, was awaiting him to post it.

    I will try and make the meet up.


    http://xamox.NET

    Sounds sweet!

    joshk's picture

    wanna give a lesson? I totally want to get people into views, but I also totally want to start decentralizing the responsibilities for stuff here.

    You could post the doc here, and then we could work with earl and the doc team to move it into drupal handbook...

    http://www.chapterthreellc.com | http://www.outlandishjosh.com

    +1

    Walt Esquivel's picture

    I, and a lot of folks, could most definitely benefit from a lesson on views.

    And CCK as well. :)

    Walt Esquivel, MBA; MA; President, Wellness Corps; Captain, USMC (Veteran)
    $50 Hosting Discount Helps Projects Needing Financing

    Walt Esquivel, MBA; MA; President, Wellness Corps; Captain, USMC (Veteran)
    $50 Hosting Discount Helps Projects Needing Financing