Documentation Team

Welcome! This group is the main location for news and discussions about what Drupal community members are doing to improve 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.

The Documentation Team leadership also puts out quarterly status posts that appear in the Drupal.org home page news (these posts are meant for the entire Drupal community, not just the Documentation Team). The Drupal.org home page news has an RSS feed too.

You can find more information about how to contribute to documentation on Drupal.org. There's also information there about the Documentation team leadership and other means of communication. Join us!

arianek's picture

Does anyone care to track Handbook stats?

Neil (drumm) just responded on an old issue I'd filed, http://drupal.org/node/780982 - I've got enough occupying my brain that I don't think I'm the right person to be tracking stats, but I thought I'd post here in case anyone would be interested in trying to get access to Google Analytics, and occasionally checking in on stats to see if there's any useful info about oft-used handbook pages and such.

If you are interested, drop a note here and we'll see if we can get access to the analytics account.

arianek's picture

DrupalDocs Twitter account

I'm going to be working on a push for help with the D7 docs in the next little bit and thought it might be helpful to register a proper Docs Twitter account https://twitter.com/drupaldocs to announce sprints, ask for help with specific tasks, point out major discussions that happen, etc.

If anyone else wants the password so they can use the account, just send me a message or ping me on IRC and (as long as I know who you are) I'm happy to have multiple people use it.

tsvenson's picture

Better structured modules list page

Hi all,

Most of us is very enthusiastic about the user experience improvements for Drupal 7. The restructure and renaming is very welcomed and I am sure it will make it much easier for newbies to get started.

There is though one area that I still see as untouched, namely the Modules list page. After installing a number of modules it is quickly becoming a bit of a chaos list, especially since a lot of modules aren't using the "package" field in the [module].info file and thus their module end up in the Other category.

Read more
chachasikes's picture

Looking for Documentation Mentors/Teachers for Summer Garden Technology Project

This summer, we are doing a project in which we learn Drupal/Open Source skills while helping gardening initiatives. Participants will build Drupal projects that foster "Garden Storytelling." Technically, we might create: recipes for Drupal sites, glue modules, and simple sites that act as web services. Our audience is primarily Drupallers & Community Gardeners. There are about 40 participants overall, half of whom are already involved with Drupal in some form.

An important part of what we will be learning will be documentation.

Read more
heather's picture

Documentation related DrupalCon proposals?

Deadlines for submissions to DC Copenhagen are approaching...

In addition to BoFs, I wondered if other people might have ideas for submitting sessions at DrupalCon Copenhagen to get people interested in Documentation, or make contributions to documentation, in addition to the sprint model?

I proposed a session which will first talk about how to communicate ideas visually, then we'll look at some tough Drupal concepts new users struggle with, and we'll actually make stuff. That 'stuff' can be contributed as documentation or used by others to help teach/evangelize Drupal.

Read more
arianek's picture

How to kill handbook comments

Just had a bit of a lightbulb moment (and maybe this idea has come up before?) about how to eventually kill comments on handbook pages. Someone asked how we could make sure conversations about a particular page were still visible if they were happening in the issue queue instead of as comments.

I thought, and this is what seemed like a good idea:

  • add a field on the issue node-add form for a referenced d.o NID (to reference the handbook page the issue is about)
  • build a view block for the handbook pages that displays any issues related to the page

Ta-da?

Read more
Mindy's picture

Editing module pages on drupal.org

I tried searching, but I couldn't find the answer. Forgive me if I'm posting in the wrong place...

I see that I can edit handbook pages. I'm wondering why I can't edit module pages. Many times I've found a module on drupal.org and the module's page is less than stellar. It would be great if I could edit them to help make them easier for others to understand. Since there is revisioning, I don't see the harm (though perhaps an approval workflow moderated by the module's maintainer might be better). Who IS allowed to edit a module's main page?

kevee's picture

Technical Communication System with Drupal

Per a conversation at the documentation BOF about how we are approaching managing documentation at CSU Monterey Bay, here's a screencast and additional information about our approach. Sorry it's been a week, but after the figurative "Drupal Fever" of last week I had a literal fever that laid me up for a while.

Read more
rfay's picture

Examples Project Code Sprint for Thursday

In San Francisco we're going to sprint on improving the Examples for Developers project. You're welcome to join us wherever you are in the world. We'll be meeting 9-5, see meeting information. See you there!

Here's a list of fun things we can work on:

Read more
jhodgdon's picture

Technical Communication System in Drupal - notes from BOF at DrupalCon SF

LeeHunter organized a BOF gathering today at DrupalCon San Francisco related to his thread here about building an awesome technical communication system.

Here are my notes from the session. Enjoy, discuss, etc. They are a bit rough, but hopefully readable...

Lee's Goal: Make a tech communication platform that everyone will want to use, based on Drupal

Addison's Goal: docs.drupal.org, new IA, new tools (not necessarily the same thing as Lee's platform)

Read more
Shai's picture

How Can We Take Advantage of Drupalcon

Hey doc folks,

Saturday was great... but the task is BIG.

How can we take advantage of Drupalcon to get more people to help?

Should we do a BOF?

Shai

Shai's picture

Doc Sprint Happening at Drupalcon - Join Us

Come by to help with docs, I'll Photoshop (actually "skitch") you into the picture!

We'll be in 305 after lunch.

Doc tool user stories

This page is for gathering user stories for the development of technical communication tools within Drupal.

Read more

GSoC 2010 proposal: Development of technical communication capabilities

This wiki page is an outgrowth of this discussion. Its purpose is to give us a place to collaborate on the creation of a proposal for Google Summer of Code 2010. Please leave all new feedback here.

We're aiming to put together a proposal that looks something like this. This means we need

Overview:
Description:
Timeline:
Mentors:
Contact Details:
Difficulty:

Why this project is needed

Read more
LeeHunter's picture

Docs events at Drupalcon

With Drupalcon coming up soon, (and thanks to the prompting of rfay on IRC) I wanted to start a thread to share some thoughts about what might be happening from a docs perspective.

The Drupalcon site is a little confusing because they talk about doc sprints on both Sunday and Thursday, (http://sf2010.drupal.org/conference/drupal-sprints) but then on the same page it just shows one sprint on Thursday. So my first question, is there actually a docs sprint on Sunday? I'll be around on Sunday myself, so I'd be happy to participate if there's something happening.

Read more
arianek's picture

Merging Beginner Docs into Main Docs

I just noticed this group: http://groups.drupal.org/beginner-documentation because someone started cross posting to the (recently opened) main docs group: http://groups.drupal.org/documentation-team

I'm not sure who's actually keeping tabs on this beginner docs group, but I wonder if it wasn't created because of the main docs group having been closed to posting prior to a month or so ago. Anyhow, it seems pretty redundant and the docs team aren't monitoring it as far as I know, so I'm thinking it'd be nice to merge it into the main docs group.

Read more
jim0203's picture

Drupalversity BoF session

Start: 
2010-04-17 12:00 - 2010-04-22 12:00 UTC
Organizers: 

Drupalversity seems to be building quite a bit of momentum, so it would be good to hold a BoF session at DrupalconSF so we can discuss how we're going to get it started. I don't know when or where the BoF will take place, but we can work that out later.

For details on what Drupalversity is, see the blurb below. It was written with n00bs in mind but it should be clear in there that there is work that can be done by Drupalistas from lots of different backgrounds and with various skillsets and levels of experience.

Read more
jhodgdon's picture

Getting Drupal 7 documented

I organized some Drupal 7 documentation sprints the last few Tuesdays (http://groups.drupal.org/node/50403)... They were successful, in that we got a couple of new people going in documentation, and a few patches filed (I'll shout out to trevjs especially, for coming to all of the sprints and patiently working on some patches).

However, the sprints were not very well attended, and we still have a lot to do to get the documentation of Drupal 7 ready for its release (http://drupal.org/node/515870), so I'm wondering how we can get it done.

My questions:

Read more
jablko's picture

when to use what HTML markup documentation/style guide?

Is there some Drupal documentation or a style guide which explains when to use what HTML markup?

For example, when to use <div class="section">, <div class="content">, <p>

  • or when to use <h1>, <h2>, <h3>, etc.

  • or when to use <div class="description">

I found the Drupal Markup Style Guide, http://groups.drupal.org/node/6355

^ which has some excellent "high level" guide lines - what I can't find is a catalog of Drupal classes and when to use them or what their purpose/meaning/rationale is

Does this exist?

LeeHunter's picture

Building an awesome technical communication CMS

In the not too distant future - perhaps soon after D7 work is finished - the Drupal handbooks will move to their own site within Drupal.org and hopefully the doc folks will then have much more control over their tools and templates. While it's very exciting to think that we'll finally be able to address some of our challenges - just adding Views would be amazing - I've been thinking that there's an opportunity here to do something that is WAY more awesome. Something that could return huge dividends to the Drupal docs.

Read more
Subscribe with RSS Syndicate content

Documentation Team

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