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!

Sree's picture

Learning series page

Hi all,

These days we see quiet many learning series / articles coming out on drupal.
All these are getting listed under drupal planet along with other articles as well.

Can we have a doccumentation page like we have for success stories, case studies where in we all list / aggregate feeds from all these learning series (another planet kind of page but, dedicatedly contains all the learning series / learning initiatives) ?
I am sure this will improve the ease of finding drupal related materials easily for a new comer.
Right now its hard to search these within planet.

Read more
iannozzi's picture

Information Architect/Interaction Designer | Message Agency

Employment type: 
Full time
Telecommute: 
Allowed

Message Agency is an open source design and development shop located in Center City, Philadelphia, that is looking for a full-time information architect, interactive designer, and web producer. The right candidate would have an absolute obsession for developing precise documentation that reflects industry best practices and respects our clients' specific needs.

Read more

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

Contributed modules documentation

This might be a wrong group to ask, but I will try anyway :)

Why can't we have a simple link to the contributed module's README on top of the module page, beside the "Version control" link ? And a similar "Documentation link".

Read more
jhodgdon's picture

GSoC Doc Sprint Summit

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

Read more
Cliff's picture

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

Takin a break for summer

Hey Team -

I just wanted to let you all know I'm going to be scaling back my duties for the remainder of the summer (until DrupalCon London). I'll still be around-ish - will keep an eye on the docs queue for urgent business and probably work on some docs independently, but I won't be doing much team management until closer to the Con.

If you need my feedback on something more urgent, feel free to email me through the contact form, or leave a message for me on IRC (though I may be slower than usual to respond).

Read more
kimmel's picture

Building a mentoring guide/a new user howto

Before diving into this post let me tl;dr: Fostering good communication with new users.

So I asked around on #drupal-contribute to see if there was a guide for helping and guiding users who want to help out with Drupal. There does not appear to be one so here is an attempt to make one. The goal of this discussion is to create an outline which will then get folded into the Drupal documentation for mentoring users. Lets play out a scenario to show where guidelines could help.

A user comes into the irc channel and states they want to help with a project and asks "Where should I start?"

Read more
jhodgdon's picture

Host a doc sprint!

Ariane and I have been getting inquiries lately about whether we can come to various regional events to host a documentation sprint. It's always exciting when people are interested in working on documentation, and we're glad that there is so much interest in sprints -- they are a great way to get some work done and introduce new people to contributing to documentation. But unfortunately, being a Documentation Team co-lead is a completely volunteer position, and neither of us has unlimited travel time or budget (even if the regional camp offers to pay travel expenses).

Read more
kimmel's picture

linux server / dev environments, opensuse and others

I started writing an OpenSUSE tutorial for drupal: http://drupal.org/node/1180202

What I want to do is get feedback and develop a template/checklist to follow to make sure no important information is left out of a server config.

So far I have these categories some of which are not written on the above page yet:

<

ul>

  • Downloading and Installing the software
  • Config file locations
  • Configuring the software
  • Example config files
  • Application locations
  • Checking version numbers
  • Log file locations
  • Read more
    arianek's picture

    Docs hour tomorrow + Docs team block is back!

    Two announcements:

    Docs hour Tuesday (tomorrow!)

    June is Bring a friend to Docs month! Join us tomorrow for Docs hour, bring a friend if you can, and we'll work on getting pages set back to "No known problems" (or review/discuss anything else needed).

    Tuesday, June 7, 1pm PST/4pmEST in #drupal-docs on IRC.

    Documentation contributor links block is back!

    Read more
    arianek's picture

    June is "Bring a friend to Docs" month!

    During Docs Hour on IRC today, we thought up something a bit different to do for June...

    June is "Bring a friend to Docs" month!

    There are no issues tagged for a June sprint this time round, instead we're going to do a fun team building sprint to help get new people introduced and oriented with how to work on docs! Here's how it works:

    Read more
    arianek's picture

    Docs Hour - planning for June

    Start: 
    2011-05-31 13:00 - 14:00 America/Vancouver
    Organizers: 

    Just a quick reminder that we'll be talking about priorities for June during today's docs hour at 1pm PST, #drupal-docs on IRC.

    Please join us to help pick out some issues/areas to work on!

    arianek's picture

    Communications

    Hi all!

    So, I've been pondering communications - mainly because I have a pretty hefty backlog of emails that have been sent through my contact form that is only growing. I wish I could spend the time it would take to write really helpful, personalized responses back to everyone, but as the quantity has been growing that's proving to be unrealistic.

    Read more
    arianek's picture

    May 2011 online docs sprint

    Hey Team!

    As many of you know, the April pilot month-long sprint has been going really well - several people have stepped up to help out with the issues I'd selected, and 3 of 5 are currently done. A few of us are still sprinting on the two remaining issues, and hoping to close out the sprint on time.

    Read more
    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: 

    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

    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

    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!

    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