Documentation

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.

We have a new project! We're creating a User Guide to Drupal 8. That page has information about how to participate in writing or editing, and we're posting in this group about our meetings (every two weeks) and status updates.

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.

jhodgdon's picture

User Guide sprint at DrupalCon?

I was looking at the Sprints page for DrupalCon New Orleans and noticed that on the accompanying sign-up spreadsheet, there is not yet a Documentation sprint listed. (Sprints are times at DrupalCon where people get together to work on projects.) I can't complain about this too much, since I will not be at DrupalCon and will also not be available remotely to help out...

Read more
jhodgdon's picture

New copy editing opportunities (not requiring patches) for User Guide

I made a post last week about copy editing the User Guide. Thanks everyone who has already gotten involved! We still could use more help -- and there are new tasks that do not require making "patch" files, and updated instructions.

Details:

Read more
jhodgdon's picture

Indexing expertise needed for the User Guide

We've been working on creating a User Guide -- the project page is here:
https://www.drupal.org/project/user_guide

One of the things we decided early on is that it should have an index. So, as the topics were written (by a variety of people), each one was given one or more index entries. This has resulted in an index that is sort of OK, but has some problems, because it was created by many people instead of a single professional indexer. You can currently see the index (as it is now) at:
https://userguide_new-drupal.dev.devdrupal.org/d8guide/en/_index.html

Read more
jhodgdon's picture

User Guide - Copy editing time!

I'm pleased to announce that the User Guide has an all-but-complete first draft! (There are 3 topics that haven't been written, but they are all just about done.) So, it's time for the next phase: copy editing and testing. There were many people who, when we originally announced the User Guide project, said they were interested in helping during the editing phase -- now is your chance!

Read more
jhodgdon's picture

Advomatic User Guide sprint - thanks!

A big thanks to Advomatic, who hosted a 4-hour User Guide sprint today! From my perspective, it went very well; I hope the participants will comment here with their thoughts. Oliver/oseldman organized the sprint, and he contacted me ahead of time to ask if I had any suggestions. Then they picked a time (and notified me ahead of time), so that Joe and I could try to be available in IRC while they were sprinting.

Read more
jhodgdon's picture

Drupal 8 is out -- let's get the User Guide done!

As I'm sure most of you know, Drupal 8.0.0 was released a few weeks ago (and 8.0.1 has already followed). There was much rejoicing, after several years of development!

Read more
batigolix's picture

This month in Drupal Documentation

This is your long awaited update from the Documentation Working Group (DocWG) on what has been happening in Drupal Documentation in the last month or so.

Because this is posted in the Core group as well as Documentation, comments are disabled. If you have comments or suggestions, please see the DocWG home page for how to contact us.

Read more
Amber Himes Matz's picture

D8 User Guide IRC Meeting

Start: 
2015-09-17 09:00 - 09:30 America/Los_Angeles
Event type: 
Online meeting (eg. IRC meeting)

Let's get ready for sprints at DrupalCon Barcelona!

Instead of meeting this week, we are moving the IRC meeting to next week, September 17. Please join us in the IRC #drupal-docs channel to get up to speed with the latest developments in the D8 User Guide.

If you are new to IRC, please see https://www.drupal.org/irc/setting-up

Read more
Amber Himes Matz's picture

D8 User Guide Mentoring (IRC: #drupal-docs)

Start: 
2015-08-20 09:00 - 09:30 America/Los_Angeles
Event type: 
Online meeting (eg. IRC meeting)

Twice a month, we meet in the #drupal-docs IRC channel to chat about the D8 User Guide.

Do you have questions about the D8 User Guide project? Want to get involved? Need help getting started?

Join the User Guide project team (ambermatz, jhodgdon, and eojthebrave) in the #drupal-docs IRC channel, say hello, ask any questions you might have, and get help finding a section to write.

Read more
eojthebrave's picture

This Month in Drupal Documentation - August 2015

It's been a busy month in Drupal documentation land. Here's an update from the Documentation Working Group (DocWG) on what has been happening in Drupal Documentation in the last month or so. Sorry... because this is posted in the Core group as well as Documentation, comments are disabled.

If you have comments or suggestions, please see the DocWG home page for how to contact us. Thanks!

Read more
Amber Himes Matz's picture

D8 User Guide Q&A (IRC)

Start: 
2015-08-06 09:00 - 09:30 America/Los_Angeles
Organizers: 
Event type: 
Online meeting (eg. IRC meeting)

Have questions about the D8 User Guide project? Want to get involved? Need help getting started?

Join the User Guide project team in IRC, say hello, ask any questions you might have, and get help finding a section to write.

New to IRC? See https://www.drupal.org/irc/setting-up

Meeting time in your timezone

Edit: IRC Log attached

Read more
Amber Himes Matz's picture

D8 Manual Check-In Meeting (IRC)

Start: 
2015-07-23 09:00 - 09:30 America/Los_Angeles
Organizers: 
Event type: 
Online meeting (eg. IRC meeting)

Join us in IRC in the #drupal-docs channel on July 23 for info and updates regarding the Drupal 8 Manual Project.

Edit: IRC log attached.

Read more
ifrik's picture

This Month in Drupal Documentation - June 2015

Here's an update from the Documentation Working Group (DocWG) on what has been happening in Drupal Documentation in the last six weeks: the successful start of the Drupal 8 User Guide and 929 edits on drupal.org.

Read more
jhodgdon's picture

User Guide project - Outline posted!

As you probably know, we're working on creating a User Guide for Drupal 8. We started working on the actual content about two weeks ago, and several topics are in progress. We started writing before we were really sure what the guide should contain, working on a short list of topics we were pretty sure we'd want to include.

Read more
jhodgdon's picture

Drupal 8 User Guide - Inaugural Update

Wow! Thanks to everyone who commented on our proposal to create a Drupal 8 user guide. We read all of the comments carefully, and have made a plan for how to get this manual written, edited, and tested:

Read more
Amber Himes Matz's picture

Kick-Off Meeting: Drupal 8 Manual Project

Start: 
2015-07-02 09:00 - 10:00 America/Los_Angeles
Organizers: 
Event type: 
Online meeting (eg. IRC meeting)

Join us in IRC in the #drupal-docs channel on July 2 to kick-off the Drupal 8 Manual Project.

Agenda:

For information on how to connect to IRC, you can check out this page: Setting up IRC or post a comment here indicating you need help and one of us will be happy to help you.

Read more
jhodgdon's picture

Drupal 8 User Guide Sprint at Twin Cities Drupal Camp (or remote)

Start: 
2015-06-28 09:30 - 17:00 America/Chicago
Organizers: 
Event type: 
Sprint

As you've probably noticed on https://groups.drupal.org/node/470648 -- we're planning to create a new Drupal 8 User Guide. The Twin Cities Drupal Camp is coming up on June 25-28, and they invited me (along with Joe/eojthebrave who was already going to be there), to jump start the User Guide project by holding a documentation sprint on their community sprints day, Sunday June 28. So, we're going to do this!

Read more

Outline for Drupal 8 User Manual

This outline is designed to go along with the conversation and proposal made by jhodgdon and seen on https://groups.drupal.org/node/470648

  1. Welcome to Drupal
    1.1. Overview
    1.2. Basic architecture
  2. Getting started!
    2.1. System requirements
    2.2. Installing Drupal
    A. Your local environment
    B. Try Drupal in a hosted environment (https://www.drupal.org/try-drupal)
    2.3 Basic site settings
  3. Creating Content
  4. Extending Drupal
    4.1 Finding and selecting Drupal modules and themes
    4.2 Installing
    4.3 Updating
Read more
jhodgdon's picture

Proposal to create a Drupal 8 User Manual

Every time someone does a survey of "What does the Drupal project need?", Documentation comes out as one of the top results, even though we have a large amount of Community Documentation and a comprehensive developer reference with topic pages. One key problem is that for Drupal newcomers, the sheer amount of documentation is overwhelming, and what we have is somewhat lacking in organization, so they don't know where to start in order to learn how to use Drupal.

To mitigate this problem, the Documentation Working Group is proposing to create a new Drupal 8 User Guide, with funding (hopefully) from a Community Cultivation Grant from the Drupal Association.

We're posting the entire proposal below.... We'd love to hear from you between now and June 19, at which point we'll apply for grant funding. Please let us know:
- What do you think of the idea?
- Do you have any suggestions?
- Are you interested in being part of the team that develops the initial manual?

Note: June 19 has passed, and this post is now closed to comments. Thanks for all of the suggestions and offers to help! We'll be in touch!

This post contains a follow up to the proposal here as well as some information about how we're planning to proceed with this project based on all the excellent feedback we received: https://groups.drupal.org/node/472728

Read more
batigolix's picture

This month in Drupal Documention (May 2015)

Here we are again with an update from our Documentation Working Group (DocWG) on what has been happening in Drupal Documentation in the last month or so. Because this is posted in the Core group as well as Documentation you can not comment on this post. If you have comments or suggestions, please see the DocWG home page for how to contact us.

Read more
Subscribe with RSS Syndicate content

Documentation

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