![]()
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.
Contributed Module Code Reviews
Code review of existing contributed modules is frequently cited as a means to improving the quality of existing contributed modules. However, the task of performing a code review falls somewhere between documentation, writing and reviewing patches, reviewing CVS applications, and creating new modules.
This is a proposal to elevate the visibility of module review, and make it easier for newcomers to perform module reviews.
Read moreContent for video on 'How to use the issue queue to contribute'. [wiki - please edit]
Following up on this the issue for the creation of this Video AND Doc (http://drupal.org/node/995326)
Why don't we pool ideas here and pull together an outline? Unless someone wants to dive in and just present it....
NOTE: We'll use this doc as a wiki to collaborate on content development and then pull this back to the issue when we have it together.
There are a number of resources below regarding the issue queue.
It sounds like there are several tasks associated with this issue:
Potential Tasks
- Review existing documentation (see sources below)
Questions, suggestions, and what next
I just finished updating http://drupal.org/upgrade this page just basically explains what a update / upgrade is, and links to other pages. I then found http://drupal.org/node/548922 which is very similar. I'm not sure if /upgrade is now complete or still needs work. How does someone know if it's complete? I personally think the links off of it are not in the best order or work quite right but I didn't know what the focus or intent of the page or links were. Personally I'd like to see the text of the update.txt posted. Why make someone open that file?
Read moreProposal: Improve our issue queue process so docs get taken care of
We all know that our Drupal issue external documentation technique is untenable.
We do internal documentation (the Doxygen comments that are included in the code and result in api.drupal.org) pretty well now in Drupal 7 (Yay!). Documentation of functions and hooks is done in the patch itself and gets reviewed and improved in the process of the patch's development. Drupal 7's internal documentation is incredibly improved over previous versions. Drupal++.
Read moreProposal: Separate handbook into "core" and "contrib"
In Drupal development we have "core", which is carefully tended by a strong, collaborative community, and "contrib", which is pretty much wild west and has extremely low barriers to entry.
I propose that we do the same thing with the handbook.
<
ul>
- Structure determined by docs leadership
- Moderated changes
- Curation managed through an issue queue
- Much higher Apache Solr search rankings than the "contrib" section.
<
ul>
Drupal documentation and motivating volunteers
A long time ago I got to spend a few years watching and learning from a man named Sherwin as he led a church choir. He was an absolute master in the realm of motivating volunteers. Here are some of the things I learned:
<
ul>
What's on your radar?
Hey fellow docs enthusiasts!
As some of you may have seen, there is going to be a big Docs Sprint in Vancouver in December (come join us if you're nearby!) The other part of what's going on that weekend, is that the core Docs Team members traveling here, as well as a few core devs (webchick, chx, and dmitrig01) will be gathering on Friday to discuss the Docs Team structure and initiatives in a dedicated retreat style afternoon.
We'll be discussing and brainstorming about things like:
Read moreSpecification for our dream (DITA) documentation tool
In February LeeHunter posted his wish list of features for "an awesome technical communication CMS". I've copied his list and processed the comments in the discussion and some of my own, and added our current status implementing these features and ideas of how any missing features could be implemented in the near future.
Read moreDocumentation Robot: feedback appreciated
I recently got the opportunity to work on an idea that I've had for a few weeks – some kind of automized technical documentation of Drupal sites. It resulted in a rudimentary but working module Documentation Robot, collecting some technical information about the site where it is installed and summarizing it on a page.
It currently collects information about node types (including CCK fields), installed modules/projects, and user roles. In the pipe is also support for documenting views, panels, better CCK field documentation, and a tonne of other ideas I got. I also want to make the collected information re-usable in a number of different formats (for example DITA or creation of book nodes), but that is further off in the future.
Read moreWhat defines Drupal?
We all use Drupal, build with it, code for it, sometimes even code it. But what is Drupal, really? What gives it its distinct identity? This page tries to gather the defining choices the project team has been focusing on over the course of years.
[Editor's note: If this is going to go into the Handbook, it needs more editing. See the style guide at http://drupal.org/node/338208 ]
Community experience
- The people on IRC channels #drupal, #drupal-contribute, and topical/regional channels
Big Vancouver Docs Sprint!
Big news: Addison Berry from Lullabot (you may also know her from Docs Lead for the last two years fame...) is using the last of her Knight Foundation grant to sponsor a big Drupal Docs sprint in Vancouver!!!
Read moreGoogle Code-In (GHOP v2.0)
Greetings, Documentation Team!
Just wanted to raise to your attention that Google is sponsoring a program to help 13-18 year olds get involved in open source called Google Code-In:http://code.google.com/opensource/gci/2010-11/index.html. The program runs Nov. 22 - January 10, and the past incarnation (GHOP) netted us rockstars such as Jimmy Berry (who wrote the infrastructure for our automated testing bot), Daniel Wehner (who is now a Views co-maintainer), and Charlie Gordon (who has done a bunch of work in core on SimpleTest and D7UX patches).
Read moreDocs Mentors
After a big discussion with some of the core devs who attended the PNW Drupal Summit last weekend, I've created a page for people who don't consider themselves part of the Docs Team to sign up as willing to mentor people working on Docs. http://drupal.org/node/936522
The idea is that people working on docs often need help with technical details of what they're documenting, and don't know who they can ask. The people I was talking to were more than willing to help out, and we also talked about pairing up docs people with contrib maintainers so they can help maintain project-specific docs.
Read moreCreating Accessible Websites in Drupal: Documentation We Need
Drupal's documentation needs a page (or set of pages) that explains how you go from installing Drupal to having an accessible website. This is not intended to explain what accessibility is — we'll have another page that does that. The idea is to give developers the quickest, shortest route possible to an accessible site.
If folks want to make an accessible Drupal site, what is the route that they should choose, starting with Drupal 7.
So let's start throwing some information together in this wiki. Don't worry about polish — that can come later.
Read moreD7 Theme Docs
Can anyone help out on D7 Theme docs? There is a big need for help there, and it's an area I am totally clueless about. 2 issues on my radar:
- http://drupal.org/node/755826 (re: core theme section of handbook)
- http://drupal.org/node/740194 (re: updating theme guide)
I think it needs a lot of love, so if anyone can adopt these and help out, that'd be fantastic!
Read moreDiscussion: Project-izing Handbook Maintenance
At dinner tonight Add1sun and I chewed over the question:
Why does Drupal's contrib maintenance model largely work, and handbook maintenance does not work?
While Drupal's contrib area is certainly not perfect, it has active maintenance on many projects, and a clear sense of ownership, and rules that go with that ownership. Everybody can contribute in the issue queue, and everybody can comment in the issue queue. But the maintainers are responsible for the their project.
Read moreShould the docs style guide apply to interface text?
A ping in #drupal-docs earlier has brought to my attention that the Docs style guide only applies to handbook and not explicitly to interface text in Drupal core/contrib.
I'd think it should apply so we get consistent text and grammar formatting Drupal-wide, but didn't want to make such a sweeping declaration without some consensus from the community at large.
Read moreAnybody else working on Accessibility docs yet?
I'm about to tackle a modest project in the Accessibility pages and just wanted to be sure I wasn't reproducing anyone else's work. Anyone here working on those docs? (Our Accessibility group actually is coordinating a project to improve that content. I am plugged in with [the rest of] them.) If so, please touch base with me so we can collaborate.
Read moreDrupalCon CPH Docs Sprint
There will be a room set aside for Docs Team at the DrupalCon CPH code sprint tomorrow. I will do my best to be there for the day (stomach permitting), but in case I am very late (or only join virtually on IRC) or anyone is looking for an outline of what to work on, I thought it'd be good to put up some info to get started with if you are planning on attending.
Read moreDocumentation-related activities at Drupalcon CPH
With a quick run-through of the program, I didn't see any talks of BoFs related to documentation on the CPH site.
I'm very interested in starting to help out with Drupal documentation, and I know there will be a need for a big push with D7. I'm just not sure where to start. I was hoping to meet up with some people in Copenhagen to give me a quick primer and sketch out some of the areas most in need of work.
Read more




