contributing to drupal docu
TRANSCRIPT
Contributing To Drupal
DocumentationMidCamp
Saturday March 21st, 2015
Presented by: Tim Erickson (StPaulTim)
Sunday, March 22, 15
Where do you get your info about Drupal?
• Name
• Where are you from?
• What is your favorite source of information to answer your Drupal questions?
• What if anything prevents you from contributing to Drupal Documentation?
Sunday, March 22, 15
About Me:• Online Facilitator - Online Community
E-Democracy.org(1997 - 2010)
• Mr. Tai’s Restaurant (2010 - 2011)
• Drupal Freelancer(2012 - 2014)
• Triplo, Founding Partner(May 2014 - Present)
Sunday, March 22, 15
• Tim Erickson stpaultim• Barry Madore bmadore• David Needham davidneedham
Build • Train • Mentor • Support • Community
Sunday, March 22, 15
Sunday, March 22, 15
My Drupal Motto
Come for the community
Stay for the code
Sunday, March 22, 15
1. Good documentation is a important and vital part of the overall Drupal experience.
2. Contributing to Drupal documentation is a selfish act that serves us all.
3. There are many ways to contribute to Drupal documentation.
4. You can and should be contributing to Drupal documentation is some way or another.
Key points:
Sunday, March 22, 15
My First Documentation Edit
Sunday, March 22, 15
Should I edit this?
Sunday, March 22, 15
Don’t worry - there is a history...
Sunday, March 22, 15
Since my first edit:
1. The openlayers module has undergone changes.
2. Others have added incorrect information to the page.
3. Someone else has added detailed variations in the comments section.
4. The page is still out of date and needs additional work.
Sunday, March 22, 15
Why Contribute?
• Self-document what you’ve learned for future use
• Increase your own understanding of Drupal
• Build your reputation in the community
• Gain experience in technical writing and editing
• “Give Back” to the Drupal community
Sunday, March 22, 15
Definition
the usually printed written instructions, comments,
and information for using a particular piece or
system of computer software or hardware
Sunday, March 22, 15
Old School Documentation
Limited opportunities for contribution.
Sunday, March 22, 15
Online Documentation1. “Official” Documentation on Drupal.org
Sunday, March 22, 15
Online Documentation
1. “Official” Documentation on Drupal.org
2. Documentation in code (i.e. Zen Theme)
Sunday, March 22, 15
Sunday, March 22, 15
Online Documentation
1. “Official” Documentation on Drupal.org
2. Documentation in code (i.e. Zen Theme)
3. Issues queue
Sunday, March 22, 15
Ways to “document” in the issues queue.
• If you find a solution in the issues queue, let others know that it worked for you.
• If the provided solution does not work for you and you figure it out yourself or find a solution elsewhere. Post a comment
• If there are multiple solutions in the issues queue, edit the issue summary to summarize the discussion (see next slide).
Sunday, March 22, 15
Sunday, March 22, 15
Online Documentation
1. “Official” Documentation on Drupal.org
2. Documentation in code (i.e. Zen Theme)
3. Issues queue
4. Third party sites like - Drupal Answers
Sunday, March 22, 15
Sunday, March 22, 15
Online Documentation
1. “Official” Documentation on Drupal.org
2. Documentation in code (i.e. Zen Theme)
3. Issues queue
4. Third party sites like - Drupal Answers
5. Drupal planet - or blogs in general
Sunday, March 22, 15
Sunday, March 22, 15
“That's why it's so important that you take that thing that you just figured out, copy and paste it into a body field, and click publish.”
Sunday, March 22, 15
“We need more voices, and we need more diverse voices. We need voices from the southern hemisphere. We need voices that worry that their English isn't good enough. We need the voices of people just starting out and feeling slow and stupid. You just learned where the logout button was? Cool. Tell us about it. You made a mistake and blew up your site? Bummer. Tell us about it. Whatever you're working on, I want you to tell us about it because if you get in the habit of telling us about it, then that habit will pay dividends over time and everybody will benefit together.”
http://www.bryanbraun.com/2013/09/21/please-stop-stewing-and-start-blogging-about-drupal
Sunday, March 22, 15
Online Documentation
1. “Official” Documentation on Drupal.org
2. Documentation in code (i.e. Zen Theme)
3. Issues queue
4. Third party sites like - Drupal Answers
5. Drupal planet - or blogs in general
6. Other.....
Sunday, March 22, 15
How to Get Involved:
Sunday, March 22, 15
Sunday, March 22, 15
Sunday, March 22, 15
Sunday, March 22, 15
Sunday, March 22, 15
Sunday, March 22, 15
Sunday, March 22, 15
Sunday, March 22, 15
Sunday, March 22, 15
Sunday, March 22, 15
#drupal-docs#drupalorg
Sunday, March 22, 15
Major Challenges
• Technology (Drupal.org)?
• Lack of attention put on documentation at sprints and public events?
• Emphasis at sprints on Drupal 8 (as opposed to encouraging people to start where they are comfortable).
Sunday, March 22, 15
Additional Resources• Drupal Best Practice: Document Your Way to Understanding
Angie Byronhttps://www.lullabot.com/blog/article/drupal-best-practice-document-your-way-understanding
• Please, Stop Stewing, and Start Blogging about DrupalBryan Braunhttp://www.bryanbraun.com/2013/09/21/please-stop-stewing-and-start-blogging-about-drupal
• Drupal.org Documentation (Intro Video - 10 min)Addison Berryhttps://drupalize.me/videos/drupalorg-documentation
Sunday, March 22, 15
Sunday, March 22, 15