Documentation

We encourage users to post events happening in the community to the community events group on https://www.drupal.org.

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.

Amber Himes Matz's picture

Bi-weekly group triage of core documentation issues (Slack-only, open 24 hours)

Start: 
2022-09-12 17:00 - 18:00 America/Los_Angeles
Organizers: 
Event type: 
Online meeting (eg. IRC meeting)

Next week we'll have a Slack-only core documentation queue group triage meeting in the Drupal Slack #documentation channel. In this meeting, we'll triage as a group 1 issue at a time from the Drupal core issue queue that has been tagged with the "documentation" component. We hope this will be a way to move core documentation issues forward and get others involved in the effort. All levels of experience with the drupal.org issue queue are welcome. We'll be happy to answer questions on issue etiquette or procedures as they arise.

Read more
jhodgdon's picture

Help us write a new Contributor Guide

How did you first get involved with contributing to the Drupal project? If you're like me, it was at a DrupalCon contribution day, where a wonderful mentor guided me through the pitfalls of joining in to our global project. But not everyone has the chance to attend a DrupalCon or other event with mentors, so many people instead try to navigate through the "Getting Involved Guide" on drupal.org to figure out how they can contribute.

Read more
jhodgdon's picture

Help finish up the Help Topics!

I've made a few posts here in the Documentation group on groups.drupal.org over the past few years about the Help Topics experimental module. Today, I have a very brief update on the project, and a call for help in editing/reviewing the topics for the new Help Topics system!

Read more
hodota's picture

API-First Decoupled Drupal camp Tokyo 2019

Start: 
2019-12-13 10:10 - 2019-12-14 17:00 Asia/Tokyo
Event type: 
Drupalcamp or Regional Summit

API-First Decoupled Drupal camp Tokyo 2019

Concept :

Open source development of API-First, modern Web services and systems leading to 5G

Goals :

Understand Drupal's API-First functionality to work with other systems and build a front end.

Target :

Corporate IT person, System Integration company engineers, Web engineers (front end), etc.

Date:

December 13-14, 2019
Hands-on: Friday, December 13,
Session: Saturday, December 14

Venue :

Read more
rachel_norfolk's picture

Getting Involved Guide refresh

Start: 
2019-07-23 16:00 UTC
Organizers: 
Event type: 
Online meeting (eg. IRC meeting)

For contributors working on refreshing the Getting Involved Guide, the regular meeting takes place in the Drupal Slack #documentation channel on every other Tuesday at 1600UTC.

See the channel at https://drupal.slack.com/app_redirect?channel=documentation and take part!

The meeting will be text-based so people are encouraged to drop by even after the meeting to check on progress.

Issues are managed in the Drupal.org/project/drupal_org_community project under the component "Getting Involved Guide"

Read more
jhodgdon's picture

New help system for core (!!) needs your help!

I'm very pleased to announce that we (hopefully) have a new help system in Core that will actually serve the needs of module, theme, and distribution developers! It is called "Help Topics", and is currently in "Experimental Module" status in Drupal core 8.8.x.

The way it works:

<

ul>

  • Modules, themes, and distributions can have a help_topics subdirectory in their projects, where they can write help topics in the form of Twig template files. Each project can have as many topics as they want/need to document their project.
  • Read more
    jhodgdon's picture

    Plan for new "Contribute" section on drupal.org

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

    Please join us for an on-line meeting to discuss plans for updating and reorganizing the "Getting Involved" pages on drupal.org into a new "Contribute" section. All are welcome!

    Details:
    - The meeting will happen in the #documentation channel on Drupal Slack. For more information on Drupal Slack, see https://www.drupal.org/slack
    - To find the meeting time in your time zone, see https://www.timeanddate.com/worldclock/fixedtime.html?msg=Drupal+%22Cont...

    Read more
    grasmash's picture

    Docs Initiative Community Office Hours

    Start: 
    2018-07-10 11:00 - 12:00 America/New_York
    Organizers: 
    Event type: 
    User group meeting

    Hi Everyone!

    As part of the Documentation Initiative, I am hosting a bi-weekly community office hours to discuss initiative work.

    Community members are invited to attend bi-weekly community “office hours.” This meeting is intended to provide a forum for status updates, discussion, feedback, etc. Feel free to propose agenda items in the #documentation channel on Drupal Slack. The meeting is held via Google Hangout on the first and third Tuesday of each month at 11am ET.

    Hope to see you there.

    Read more
    jhodgdon's picture

    Restructuring Community and Getting Involved sections on drupal.org

    Hello documentation folks!

    There is an initiative that is starting to think about how best to restructure the sections of drupal.org (Community and Getting Involved) that are aimed at getting people involved in the community and becoming contributors to the project. Well, actually it's not a new initiative -- it was started a few years ago, but it stalled and is getting restarted.

    If you're interested, discussions are happening in the #documentation channel in Slack, and in these two issues:
    https://www.drupal.org/project/content/issues/1414988

    Read more
    dgtlmoon's picture

    Tidying up User Guides vs API Documentation vs Resource Guides

    I created an issue here https://www.drupal.org/project/documentation/issues/2966020 , just cross linking to raise awareness.

    Is it acceptable to start purging documentation from the API Documentation where it's already covered in the User Guide?

    Happy to help!

    Read more
    jhodgdon's picture

    In-Drupal Help: Tours and Topics

    Starting in Drupal 4.x, I think, Drupal Core had a capability for a module to provide 1 help topic (which we now in Drupal 8 call a "module overview"), and to add a small amount (typically) of help text at the top of one or more admin pages.

    New in Drupal 8, modules and themes have the capability of also providing "tours", which are guided tours of their administrative pages, via the core Tour module.

    Read more
    jhodgdon's picture

    Add videos to User Guide?

    Joe Shindelar (eojthebrave) has made a proposal that we add videos to the User Guide! We're soliciting input on this proposal on this issue:
    https://www.drupal.org/project/user_guide/issues/2923453
    There's a sample video linked in the issue summary on that page.

    Please take a look at the proposal and sample video, and respond on the issue if you have comments or questions. (You can add comments here too, but on the issue is preferred.) Thanks!

    Read more
    jhodgdon's picture

    User Guide project update

    We haven't written much about the User Guide here lately, so I wanted to post a quick update:

    a) The User Guide has recently been updated, with new screenshots and a few text changes, for Drupal 8.4.0. You can view the User Guide on Drupal.org (English, with links to translations) at:
    https://www.drupal.org/docs/user_guide/en/index.html
    For PDFs, e-books, and other information, always check the User Guide project home page:
    https://www.drupal.org/project/user_guide

    Read more
    jhodgdon's picture

    7.x-2.x version of API module ready for testing

    Neil Drumm (drumm) and I have been working lately on the API module (used to build API documnentation sites like https://api.drupal.org and others). We've made a 7.x-2.x branch of the project, which works quite differently from the 7.x-1.x branch. The major changes are that it uses a different (and external) parsing library for parsing PHP files, and it uses Composer to manage its external library dependencies.

    Read more
    jhodgdon's picture

    Translating the User Guide

    Several of the active Drupal translation groups have noticed that we now have a User Guide on Drupal.org... Today, I'd like to formally announce that the User Guide is open for translation!

    Read more
    jhodgdon's picture

    User Guide is live on Drupal.org (finally!)

    I am very pleased to announce that the English version of the User Guide is live on drupal.org, at last! You can see it at
    https://www.drupal.org/docs/user_guide/en/index.html

    You will also see links on the User Guide pages to Catalan and Hungarian (Magyar) versions of the User Guide. These are in-progress translations, with most images in the target language. Currently, most of the text is still in English, but more complete translations will be coming soon, since these two language teams are hard at work translating.

    Read more
    jhodgdon's picture

    User Guide 8.x-2.0 released!

    At long last, the copy editing of the User Guide is done! (If you've been a member of this group for a while, you should know what I'm talking about; if not, go browse the archives at https://groups.drupal.org/documentation for the last 1.5 years or so). I'd like to thank everyone who helped with editing tasks, and especially Jojy Alphonso (jojyja), who did the vast majority of the copy editing. THANK YOU!

    Read more
    eojthebrave's picture

    This Month in Drupal Documentation

    It's been way too long since we've written one of these, and a lot has happened in the last year. Yeah, that's right, it has been a year since the last "This Month in Drupal Documentation"! I can't even being to summarize the whole year in a single post, so here are some highlights of what is going on right now.

    Read more
    jhodgdon's picture

    Translating the User Guide

    We've been working on a User Guide for Drupal 8 for about a year now, and the English version is in pretty good shape -- it's in the stage now of copy editing and image refinement, and we're working on making a home for it under drupal.org/documentation. (If you are interested in helping with copy editing, see https://groups.drupal.org/node/512211 by the way -- there is still time to help!) So, it's about time to think about translating the guide to some (and hopefully, eventually all) of the 100+ languages that Drupal supports.

    Read more
    jhodgdon's picture

    Editors and proofreaders needed for User Guide

    If you've been following discussions here for a while, you're hopefully aware that for the past year, we've been working on creating a User Guide for Drupal 8, and it is coming along very well. I'd like to thank recent volunteers Anna van Raaphorst, Antje Lorch, Boris Doesborg, Charles Leverington, Grant Dunham, Jojy Alphonso, Michael Lenahan, Zach Carter, and attendees of a Spokane workshop for their help in testing the guide, updating content for accuracy, and copy editing!

    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: