Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.
Contribute to open-source
projects through documentation
Rhonda Glennon
Technical Publications Manager
Mapzen
Contribute through documentation
• Fix simple problems, typographic errors, and broken links
• Improve content
• Write tut...
Find the documentation source files
Make content changes
• Sign in to your GitHub account
• Click Edit this file button
• Automatically creates a version that...
Save edits and propose updating the source
• Follow contribution guidelines
• Commit changes in your own branch
• Open a p...
Open documentation to users
• Foster community engagement
• Make a connection with users
• Discover user needs based on wh...
www.mapzen.com/documentation
@rmglennon @mapzen
Rhonda glennon-contribute-to-open-source-with-docs
Upcoming SlideShare
Loading in …5
×

Rhonda glennon-contribute-to-open-source-with-docs

138 views

Published on

presentation for write the docs SF, march 2016

Published in: Software
  • Be the first to comment

  • Be the first to like this

Rhonda glennon-contribute-to-open-source-with-docs

  1. 1. Contribute to open-source projects through documentation Rhonda Glennon Technical Publications Manager Mapzen
  2. 2. Contribute through documentation • Fix simple problems, typographic errors, and broken links • Improve content • Write tutorials and expand steps • Write localized content or translations • Resolve bugs tagged with “Help Wanted” (used to indicate community assistance is welcomed) Workflow example using mapzen.com/documentation and github.com
  3. 3. Find the documentation source files
  4. 4. Make content changes • Sign in to your GitHub account • Click Edit this file button • Automatically creates a version that you can edit • Make updates – markdown (.md) format
  5. 5. Save edits and propose updating the source • Follow contribution guidelines • Commit changes in your own branch • Open a pull request to propose changes • Community managers review and accept
  6. 6. Open documentation to users • Foster community engagement • Make a connection with users • Discover user needs based on what gets updated in documentation • Empower users • Increase speed of documentation improvements • Improve documentation quality and coverage
  7. 7. www.mapzen.com/documentation @rmglennon @mapzen

×