Export or edit this event...

Write The Docs PDX: Enabling Walkup Contributions to Your Project Documentation

eBay Community Lounge
1400 SW 5th Avenue, 3rd Floor
Portland, OR 97201, US (map)

Access Notes

ADA Accessible - The building is wheelchair accessible via the main doors on SW 5th. (Automatic openers are on the pillar on the left in front of the doors.) The Community Lounge and restrooms associated with the Community Lounge are also wheelchair accessible. Seating for events can easily be removed or arranged as necessary to accommodate any needs.

1400 SW 5th Avenue, 3rd Floor, Portland, OR

Please arrive by 6pm. I want to start sort of promptly, by 6:05.

The building entry doors will be locked at 7pm.

I'll appreciate help cleaning up, so we can depart by 8:30.

Website

Description

Everett Toews, Developer Advocate at Rackspace Hosting, will share his experience using Git and Markdown to make it easier for the community to propose changes to their documentation. Please arrive by 6pm. I want to start sort of promptly, by 6:05. (I'll be there by 5:30.) The building entry doors will be locked at 7pm. I'll appreciate help cleaning up, so we can depart by 8:30.


A common complaint against many open source projects is documentation. Insufficient, incorrect, non-existent, hard to find, and difficult to update are things we typically all hear. There are a lot of different ways to tackle these problems. There's no silver bullet but one of my favorite tactics is lowering the barriers for absolutely anyone to contribute documentation.

Ideally, lowering the barriers means:

  • using a common and well understood documentation markup language

  • using documentation editors that are commonly available

  • not requiring your contributors to install and configure tools

  • providing a preview of the updates to make reviews reviews easier

Learn how Apache jclouds has enabled walkup contributions to our project documentation. We've benefited from better documentation, shorter review times, and building community through contribution.

Share

Tags