Documentation

Events happening in the community are now at Drupal community events on www.drupal.org.

Welcome! This group is for news and discussions related to Drupal documentation. If you join this group, you'll be signed up to receive email notifications; you can change your preferences on your account page. You can also subscribe to posts via RSS (check the sidebar of this page), and via email using the links at the bottom of this page.

Anyone can contribute to documentation, and the entire Drupal community will benefit from your help! You do not have to formally join a team (or this group) or ask for permission -- just start writing and editing. The Contribute to Documentation section on Drupal.org has more information, and the New Contributors section on Drupal.org has some tasks that will help you get you started.

If you have ideas about how the processes, procedures, and tools for Drupal documentation can be improved, the Documentation Working Group (a committee that is part of the Drupal project governance structure) invites you to make suggestions. Information on how to do that is on the Documentation Working Group home page.

arianek's picture

[Former] Docs office hours Tuesdays

Note: As of April 2012, individual Docs Office Hours events are being posted to http://groups.drupal.org/documentation-team and the schedule has changed, so the post below is not current. You can also find the office hours events on the site-wide Events calendar of IRC meetings.

Hey Team -

Read more
jim0203's picture

Drupalversity, now with added simplicity and fewer unicorns

Early last year I submitted a post to groups.drupal.org about an idea I'd had for a new way in which people could learn how to do Drupal:

Read more
jhodgdon's picture

April-May Programmer-Doc Sprint

Start: 
2011-04-19 (All day) - 2011-04-23 (All day) America/Los_Angeles
Organizers: 
Event type: 
Sprint

I'm hereby launching an April/May sprint for programmer/themer documentation folks! The April/May goal is to complete the Drupal 6 -> 7 module and theme update guides:
http://drupal.org/update/modules/6/7
http://drupal.org/update/themes/6/7

Read more
arianek's picture

IRC office hrs tomorrow... probably

Start: 
2011-04-19 13:00 - 14:00 America/Vancouver
Event type: 
Online meeting (eg. IRC meeting)

Hey Team -

I'm hoping to do "Office Hours" again on IRC tomorrow from 1-2pm PST. If you're working on the couple issues left in the April Sprint or anything else, I should be around on IRC to answer questions and do reviews (or facilitate peer reviews).

Read more
arianek's picture

IRC office hrs tomorrow!

Start: 
2011-04-12 13:00 - 14:00 America/Vancouver
Event type: 
User group meeting

Hey Team -

I'll be holding "Office Hours" on IRC tomorrow from 1-2pm PST. Anyone who's working on the April Sprint or anything else that you need feedback on, I will be hanging out on IRC to answer questions and do reviews (or facilitate peer reviews).

If you need more info on IRC, there's a bunch on the Drupal.org IRC page, and we'll be in the #drupal-docs channel.

Hope to see you then!

Read more
arianek's picture

April 2011 pilot sprint

Hey Docs Teamsters!

Not sure if any of you have been following my posts about trying a more agile/sprint-based method for the online docs work that needs to be done - I wrote a bunch about it here: http://groups.drupal.org/node/134909 (And there's a link to my blog post about it there as well).

Read more
mlangfeld's picture

Idea for an untapped documentation resource

I am a member of the Web Managers group on LinkedIn. A new subgroup is self-forming for Drupal Web Managers by request of several web managers of Drupal sites, with the comment by several that they don't find answers to their questions about managing Drupal websites on drupal.org

It occurs to me that most web managers create documentation, workflows and web governance documents during the course of their work. I know I do. So, as the group develops, I can see definite possibilities for encouraging participation in documentation here on drupal.org

Read more
xtiansimon's picture

Just wanted to say hello...

Hello Doc peeps.
I was thinking of ways I would like to contribute to Drupal. I used to work in marketing at a computer company doing nofin but making documents. And, I'm also learning Drupal. My big idea for contributing is to ask questions like,
"Why is $node or $form, for example, not listed in the Globals API list of variables which includes $user?"

Read more
arianek's picture

Sprint based development for Drupal 8

Hi Drupalfolk -

I documented a bunch of the ideas/discussion points from Dries' D8 core convo on a blog post:

http://affinitybridge.com/blog/drupal-8-git-sprints-efficient-smooth

I am considering making a page/section in the Initiatives section on d.o but would really like a bit more input first - I got a lot of positive tweets and a couple more detailed comments, but I still am not sure exactly how much support there would be for this, nor how much more detail would need to be hashed out for it to become a method that people would be comfortable experimenting with.

Read more
kahunacohen's picture

Trying to get my feet wet.

Hi. After Drupalcon, trying to get my feet wet addressing some doc tickets. I don't have irc at work, so I can't hang out on it. I posted on the doc IRC and contribute IRC yesterday and got no response. So I am getting a little frustrated, because I really do want to help.

Can someone tell me who to talk to in order to confirm this: http://drupal.org/node/1087102

I gathered up some facts, and need to know if they are indeed true and if I left anything out. If the facts are true, how would I edit the page that the ticket refers to. Thanks.

Read more
kvantomme's picture

Documentation is not just for angels

Start: 
2011-03-09 12:00 - 13:00 America/Chicago
Organizers: 
Event type: 
DrupalCon

Our current d.o documentation is maintained by angels: highly altruistic people who give without expecting to receive much. We love our angels, but this is not how it's supposed to be, documentation is just as important if not more than code.

In this BoF we'll explore how we could make documentation modular and reusable so that every single page of documentation you write for a project in the future becomes a potential source for reusable, contributable documentation on drupal.org.

Read more
arianek's picture

DrupalCon Chicago Docs Sprint

Start: 
2011-03-11 09:00 - 17:00 America/Chicago
Event type: 
Sprint

Friday there will be a Docs Sprint parallel with the Code Sprint at the conference center. I think we'll try and get going around 9am (sprint rooms should be open at 8am but I think everyone will be dragging by the end of the week, so 9am should be plenty early!)

Read more
arianek's picture

Pre-DrupalCon update

Hi Docs Teamsters!

Just wanted to drop a quick update here as we ramp up to DrupalCon Chicago, which is now in a couple short weeks!

Read more

Docs topic sub-groups

Important note: The content of this page has been copied into http://drupal.org/node/1538488 (and what was here before preserved for posterity). Please don't edit this page any more -- we'd like to keep the Working Groups listed on Drupal.org in the "Contribute to Documentation" section, instead of here, so go edit that page instead. Thanks for your interest in contributing to documentation!
------------------------------------------------------------------

Read more
perusio's picture

proposal: 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 more
anastasiac's picture

Questions about documentation management

Hello,

My name is Anastasia Cheetham. I'm a developer with and the documentation lead for the Fluid Project (http://fluidproject.org). We're beginning the process of restructuring and redesigning the documentation for our Infusion framework. Part of that process will include migrating to a new platform for the creation and distribution of documentation, and we're interested in learning about the experiences of other open source projects, including Drupal.

Read more
drupa11y's picture

Promote Drupal at the Global Ignite Week 2011

What is Ignite?

Ignite is a geek event in over 100 cities worldwide. At the events Ignite presenters share their personal and professional passions, using 20 slides that auto-advance every 15 seconds for a total of just five minutes.

I made a short summary about this and my talk here: http://www.drupal-rocks.com/node/183

My talk is not focussed on drupal, but of course I´ll finish my talk with the fact, that there´s a modul for Processing in development.

Read more
shrimphead's picture

Drupal 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 more
arianek's picture

Core 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 more
avanraaphorst's picture

DITAmashup (structured/unstructured) example

Hi, All --

Awhile back I suggested a DITA "mash-up" structure and workflow process that I thought might be a candidate for the Drupal docs--this was based on my prior work as a DITA consultant, my reading of the Drupal doc group discussions, and my own understanding of what I assume are typical problems putting together an open-source, structured/unstructured collection of topics.

My business partner and I have put together a model DITAmashup collection on one of our sites that is accompanied by a post explaining how we did it and what we think are its benefits:

Read more
Subscribe with RSS Syndicate content

Documentation

Group categories

Event type

Post type

Group notifications

This group offers an RSS feed. Or subscribe to these personalized, sitewide feeds:

Hot content this week