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

Better time for Docs Office Hours?

We've been having weekly Docs Office Hours for a while now, on Tuesday at 1pm (US/Pacific time) -- see http://groups.drupal.org/node/145039 for more details.

That particular time/day was chosen because it worked well with Ariane's and my schedules, and seemed like it might be good for others as well. But I'm wondering if people would prefer another time? My schedule is fairly flexible (within the constraints of my time zone), and I'm open to changing the time.

Post comments/thoughts here... if no one has a strong preference, I'll probably leave the time as it is. Thoughts?

jhodgdon's picture

Seeking Assistant or Co-Leader for Docs Team

Ariane has just officially left her position as the co-leader of the Drupal Documentation Team, leaving me as the sole leader (see http://drupal.org/node/1402190)... I've agreed to stay on as Leader for the time being, but since I've been acting in a leadership role in the Documentation Team for a couple of years, and with the official title for more than a year, I'd like to put a time limit on my tenure as Documentation Team Leader.

Read more
arianek's picture

Stepping down

Hi Team!

Some of you may have already heard through the frontpage or Twitter, but the announcement has just gone up that I'm stepping down as Docs Co-Lead: http://drupal.org/node/1402190

Read more
jhodgdon's picture

Association is prioritizing site builders...

In case you didn't notice, the Drupal Association has made a list of 6 priorities for 2012. Number 6 is "Make Drupal.org awesome for site builders", and Documentation is a large component of this.

So I just thought I'd make sure the Documentation Team was aware of this discussion:
Original page discussing the 2012 priorities: http://groups.drupal.org/node/197558
Sub-page specifically about this priority: http://groups.drupal.org/node/198708
Association group home page (which also lists these priorities): http://groups.drupal.org/drupal-association

Read more
TR's picture

API docs for contributed modules

One thing I find conspicuously missing from drupal.org is API documentation for contributed projects. We've put a lot of effort into coding and documentation standards, and this is paying off in improving Drupal core. But we are not seeing any benefit of this in the contrib space. Contrib modules really have no incentive to provide extensive Doxygen documentation because no-one ever sees it.

Read more
sirtet's picture

what about dynamic tables (views?) for module comparison?

I am relatively new to drupal, and i've been evaluating some Module-types like lightbox- or imagecropping- Modules.

There are quite some comparison pages, and even a list of them.
Very usefull.
But i think as static text, they will always be outdated.

So, did someone ever think about dynamic comparison tables for modules?
I'd imagine a view that can pull compatibility, installs, activity etc. directly from the projects, so they would never outdate...

Maybe that's harder than i think?

Danielle Sheffler's picture

Template for Contrib documentation

Unfortunately contrib documentation sometimes seems to be few and far between. I understand this is because people are busy and a lot of people are working on Drupal modules on their own time. That being said, I think if we had a template, it would be a lot easier for people who aren't used to writing documentation and who need guidance to write documentation, and it would also bring some consistency to the documentation that is on drupal.org.

Ia anyone interested in helping me create a template for contrib module documentation?

jhodgdon's picture

Core API documentation issue squad needed!

For the past several years, I have been the person who has managed the documentation component of the Drupal core issue queue.

Several people besides me have recently started contributing to Drupal's API documentation by patching issues, and I'm very happy about that! What I'd like to do now is also get a few people to take on the issue queue management tasks as well.

Read more
techgirlgeek's picture

One More Week Left to Submit Sessions for DrupalCon Denver

Session proposals are still being accepted for the next DrupalCon, being held at the Colorado Convention Center in Denver, March 19 -23, 2012. The conference theme is "Collaborative Publishing for Every Device" and the deadline to submit sessions is October 26, 2011 23:59:59 UTC/GMT -7. Submit your session today!

Read more
jhodgdon's picture

API docs sprint!

Some of you may have heard that I wanted to organize an API docs cleanup sprint... Well, here it is:

(issue) http://drupal.org/node/1310084

The idea is to have a sprint over the next couple of weeks, and get the Drupal Core API documentation to conform better to our documentation standards. All the instructions are on the issue... please feel free to post general questions here, but otherwise, discussions about specific documentation, standards, etc. are better off on the issue queue.

Let's get this done!

pillarsdotnet's picture

Standard needed for what is a "disruptive" patch

<

dl>

Posted by jhodgdon on October 3, 2011 at 5:26pm
Coming from http://drupal.org/node/1295500#comment-5068622

There is frustration among new developers about how to make issues and patches that cause a minimum of disruption and a maximum of ease for reviewers/committers.

So we need to make a page explaining this. Suggested outline is on the above comment, and suggested place to put it is either:
http://drupal.org/patch
or
http://drupal.org/patch/review

Read more
pillarsdotnet's picture

Clarify scope of PHP coding standards for core (major version) and contrib code

Posted by sun on October 1, 2011 at 8:09pm:

Problem

  • Uncertainty about when or how to apply coding standards across Drupal core versions and core vs. contrib code.

Goal

  • Clarify the scope of coding standards with regard to:

    1. major versions of core
    2. core vs. contrib code
  • Explicitly specify/state which particular coding standards have been different for earlier versions.

Read more
pillarsdotnet's picture

Move all core Drupal files into /core folder

Start: 
2011-11-01 (All day) Europe/London
Organizers: 

On November 1, 2011, all Drupal 8.x core files will be moved into a /core folder. This will break nearly every patch in the 8.x queue, requiring them at least to be re-rolled against the updated directory structure.

After that date, backporting 8.x patches to 7.x will no longer be trivial.

Dries announced in #22336-254:

Read more
chris55's picture

Documentation pages for core modules

Coming back to drupal after taking a year's break I could NOT find the documentation pages for the core modules. It's taken me some time to find that if I want to find, say, documentation for the tracker module I need to type in drupal.org/documentation/modules/tracker.

Read more
jhodgdon's picture

Documentation and Docs Team Proposed Restructuring

As a (partial) follow-up to Towards Docs Sustainability... Here is a proposal (or the beginnings of a proposal) for a major structural revision to how we do documentation on Drupal.org, and to the Documentation team.

Your suggestions and ideas are welcome! Please comment below, and then I'll go back and edit this proposal to incorporate the great suggestions I'm sure you will have.

Note: This is a work in progress, and may have been edited since you last looked at it, or since someone made a particular comment... sorry for any confusion!

Read more
falonshrokman's picture

Senior Durpal Developer | CDI Corp

Employment type: 
Contract
Telecommute: 
Not allowed

Senior Durpal Developer in Great Boston, MA Area (contract)
Job Description

looking for a SR DRUPAL Developer. Needs to be onsite and will be building out existing website.
Degree Required: Bachelors in Computer Science desired or a related field
Experience Required: demonstrated development experience with multiple Drupal websites.

Summary

Read more
jhodgdon's picture

Call for programmers and site builders to help with docs infrastructure!

If you are an experienced site builder, or a medium-to-experience PHP programmer, the Docs Team needs your help! We have several things that we’d like to get done that will improve the infrastructure for documentation and for contributing to documentation in the Drupal project.

EDIT: I'm marking tasks "taken" if someone has spoken up to do them.
Update Sept 23 - new tasks added!!
Update November 15 - task list edited

Site Builder Tasks

Read more
arianek's picture

Towards Docs Sustainability

Compiling a bunch of the ideas that have come up over the last week in discussions with the Docs Team folks at Drupalcon London. It's been a running theme that the docs are no longer manageable, and some concrete suggestions to deal with that are as follows. Note they are all options and need not all be adopted, some are exclusive of others:

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