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!

jhodgdon's picture

Call for Community Docs Moderator volunteers

UPDATE July 2012: If you want to be a Community Documentation Moderator, you can get started without reading this whole discussion! The instructions are now at:
http://drupal.org/node/1588928

--- Here's the original discussion post... ---

Read more
jhodgdon's picture

Open Help Conference and Sprints

Start: 
2014-06-14 (All day) - 2014-06-18 (All day) America/Indiana/Indianapolis

The annual "Open Help" conference will be taking place in Cincinnati, Ohio, June 14-15, with sprints following June 16-18.

This is a gathering of people interested in documentation and support from across many open source projects. I haven't attended before, but I think it's supposed to be pretty good, and the format looks great (part of the day for sessions encouraging discussion; part of the day for just discussion).

See http://openhelpconference.com/ for more information. I might try to attend; anyone else?

batigolix's picture

Documentation Sprint Dev Days Szeged

Start: 
2014-03-27 (All day) - 2014-03-29 (All day) UTC
Organizers: 

The documentation sprint takes places during the Szeged Drupal Developer Days

We want to focus on the different Multilingual issues.

We need people to check the existing help texts to see what functionality and wording has changed and where necessary rewrite them, as well as writing new texts for new modules and functionalities. We also need people to manually test the texts.

Read more

jhodgdon's picture

Proposal for Drupal 8 developer docs

There is a proposal to revamp the Developer API tutorials for Drupal 8, which is being discussed on https://drupal.org/node/2106873 if anyone is interested. Please read/respond there, not here.

DrupalCon Prague Documentation Sprint

28 contributers who took up tasks in 38 issues both at the sprint and working remotely, 32 inital patches and at least one contributer who had his first patch committed to Drupal 8 - that's just the figures from the Documentation Sprint at DrupalCon Prague.

What made it work?

Read more
LeeHunter's picture

Drupalcon Prague Doc Sprint

Start: 
2013-09-27 09:00 - 18:00 Europe/Prague
Organizers: 

Another Drupalcon and another Docs Sprint! Join us in Panorama Hall or on IRC and help get the docs ready for Drupal 8.

Some of the work to be done includes trying out existing (or patched) hook_help, and checking for:

  • Clarity
  • Accuracy (Making sure the text matches what's on the admin screens)
  • Completeness (Covers most or all of what the module does)
  • Style
  • Working links

An issue that lists all the D8 modules is here: https://drupal.org/node/1908570

Read more
yoroy's picture

Building landing pages for Drupal.org

This is the plan for building audience-specific landing pages on drupal.org. Calling all user researchers and content specialist: help us help site builders find their thing on drupal.org. Start with your thoughts on the approach outlined here.

Summary

The current structure and sheer amount of pages on drupal.org make it hard for people to find the specific information they are looking for.

Read more
johntelford's picture

BoF at Portland DrupalCon

Is anyone attending Portland DrupalCon 2013 interested in a BoF session? Could be a good way to get some more momentum or volunteers in this area.

LeeHunter's picture

Panelists for "Structured Content Authoring" session at Design for Drupal Boston?

One of the important challenges facing the effort to improve Drupal as tech comm tool is getting the right user experience for authors especially when we start adding things like conditional text, single-sourced content and DITA-style mapping.

Read more
LeeHunter's picture

Not one, but TWO, sprints in Portland!

I wanted to let everyone know that there will be two sprints immediately after Drupalcon Portland: a doc team sprint focused on the Drupal.org content, followed the next day by a sprint focused on evolving Drupal as a technical communication CMS.

Doc Team Sprint - Friday, May 24

Read more
jhodgdon's picture

Open Help conference

There's a conference coming up in Cincinnati Ohio USA that might be of interest for Drupal Docs folks, in June:
http://openhelpconference.com/

I probably won't be able to attend (just got back from "WriteTheDocs" in Portland), but it sounds interesting.

LeeHunter's picture

Drupal Docs Sprint Weekend

Start: 
2013-03-09 09:00 - 2013-03-10 04:00 America/Montreal

This doc sprint is timed to coincide with and support the various Sprint Weekend events (http://groups.drupal.org/node/277768) which are taking place on March 9 and 10. This will allow attendees at any of those local events to also be a part of a global doc sprint.

There's plenty of work to be done, including general activity on the issue queue:
https://drupal.org/project/issues/documentation

Getting started on the Drupal 8 docs:
https://drupal.org/project/issues/search/documentation?issue_tags=d8docs

Or performing the heroic work of cleaning up comments:

Read more
kimmel's picture

Docs session at upcoming ApacheCon

ApacheCon NA 2013 is February 26th – 28th, in Portland Oregon. There is a "Documentation: Don't be Afraid" session Tuesday 2:45 p.m.–3:45 p.m. http://na.apachecon.com/schedule/presentation/135/

Just a heads up in case anyone in the area wanted to attend.

jhodgdon's picture

Write the Docs Conference in Portland in April

There's a conference coming up in Portland called "Write The Docs". I don't know much about it (Lee tweeted it on the @drupaldocs Twitter feed so I thought I'd post here too)...

They have a web site:
http://conf.writethedocs.org/
and Twitter:
https://twitter.com/writethedocs

I'm considering going, depending on the cost, logistics, etc., since Portland is not too far away from where I live. How about anyone else?

LeeHunter's picture

Drupal 8 Docs: Some Thoughts

With feature freeze for Drupal 8 approaching quickly, I thought it might be a good time to raise the thorny subject of what can/should/will/might be done to update the core documentation on d.o and the online help. At a bare minimum, it would be useful to at least articulate the scope of the work and perhaps identify priorities and challenges.

Read more
RavindraSingh's picture

Drupal 7 Managed File Form API

For managed_file form API the Properties: #prefix and #suffix does not work.

jhodgdon's picture

GSoC Docs Sprint Camp

This is an announcement I received today by email... I met some of last year's attendees at this event, and they all said it was great!

The Documentation Group also applied last year to do a book, and we weren't selected. I'm personally not interested in putting together a proposal for this year (especially since I'm not the Docs Team Leader any more), but if there's a group that wants to make a proposal, you might discuss that here to coordinate. You'd need to make sure to have several people who are free to attend on those dates.

Anyway, here's the announcement:

Read more
andreathegiant's picture

PNW Drupal Summit Docs BoF

For those of you who will be attending the Pacific Northwest Drupal Summit, who would have an interest in participating in a Docs BoF/sprint? I'm new to the Docs team, but I wouldn't mind organizing this (whenever the summit site gets BoFs up and running!). I also wouldn't mind helping someone out if they've got more experience in organizing a BoF of this type.

Thoughts?

kimmel's picture

Introduction to automation for content checking

This message has been cross posted to Drupal.org Improvements, Documentation Team, and Drupal.org Testing Infrastructure.

tl;dr

I want to use automation to improve d.o content quality. I do not have access to do this and I have been unable to get someone with access interested enough to get this project moving.

The long version

My vision for improving the Drupal Documentation and drupal.org can be broken into three equally important ideas:

Read more
batigolix's picture

Display Suite Documentation

I finished writing Documentation for Display Suite:
http://drupal.org/node/644662
(And all child pages)

This initiative was discussed here: http://drupal.org/node/1791210

Feel free to help a hand by reviewing the text & making changes where necessary.

Cheers!

Subscribe with RSS Syndicate content

Documentation Team

Group categories

Event type

Post type

Group events

Add to calendar

Group notifications

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

Hot content this week