An effort to provide awesome documentation for the RubyGems ecosystem.
Switch branches/tags
Nothing to show
Clone or download
indirect Merge pull request #216 from rubygems/segiddins/release-docs
Add a guide for releasing rubygems
Latest commit 550acf6 Jul 1, 2018
Permalink
Failed to load latest commit information.
_layouts Add a guide for releasing rubygems Jul 1, 2018
_plugins Replace old C extensions page with redirect Aug 6, 2013
fonts More styles from rubygems.org Nov 5, 2014
images Update footer sponsers Aug 11, 2016
javascripts Fix assets Nov 3, 2014
rdoc/generator/template/jekdoc fix permalink: /specification-refence → /specification-reference Jan 9, 2018
stylesheets Update footer sponsers Aug 11, 2016
.gitignore Ignore files from my_malloc branch Aug 6, 2013
.travis.yml Fix Travis CI build. Nov 21, 2014
CC-LICENSE add some thanks and licenses Apr 27, 2011
CNAME Revert "Point docs.rubygems.org at guides.rubygems.org" Sep 9, 2013
MIT-LICENSE add some thanks and licenses Apr 27, 2011
README.md Change headers level in README document Nov 25, 2017
Rakefile Update to non-deprecated arguments for `jekyll` Sep 14, 2013
_config.yml Switch to recommended markdown formatter Apr 18, 2014
command-reference.erb Resolve conflicts from rebase Nov 3, 2014
command-reference.md Revert "create a CONTRIBUTING.md to explain how to contribute to this… Jan 9, 2018
contributing.md Update contributing.md Feb 28, 2018
credits.md Resolve conflicts from rebase Nov 3, 2014
cve.md move RubyGems' CVEs documentation into the guides Feb 17, 2018
faqs.md Fix FAQ command to print Gem.user_dir Apr 19, 2018
favicon.icns Fix favicon linking Nov 21, 2014
favicon.ico Fix favicon linking Nov 21, 2014
gems-with-extensions.md Update gems-with-extensions.md Jan 9, 2018
index.md Fix wording of a few guides to help improve readability Jul 25, 2017
make-your-own-gem.md Revert "create a CONTRIBUTING.md to explain how to contribute to this… Jan 9, 2018
name-your-gem.md Revert "create a CONTRIBUTING.md to explain how to contribute to this… Jan 9, 2018
patterns.md Revert "create a CONTRIBUTING.md to explain how to contribute to this… Jan 9, 2018
plugins.md Revert "create a CONTRIBUTING.md to explain how to contribute to this… Jan 9, 2018
publishing.md Revert "create a CONTRIBUTING.md to explain how to contribute to this… Jan 9, 2018
releasing-rubygems.md Add a guide for releasing rubygems Jul 1, 2018
resources.md Merge pull request #211 from pboling/patch-1 Jun 5, 2018
rubygems-basics.md Revert "create a CONTRIBUTING.md to explain how to contribute to this… Jan 9, 2018
rubygems-org-api-v2.md Revert "create a CONTRIBUTING.md to explain how to contribute to this… Jan 9, 2018
rubygems-org-api.md Revert "create a CONTRIBUTING.md to explain how to contribute to this… Jan 9, 2018
run-your-own-gem-server.md Revert "create a CONTRIBUTING.md to explain how to contribute to this… Jan 9, 2018
security.md Revert "create a CONTRIBUTING.md to explain how to contribute to this… Jan 9, 2018
specification-reference.md fix permalink: /specification-refence → /specification-reference Jan 9, 2018
ssl-certificate-update.md Remove outdated SSL troubleshoot information Mar 15, 2018
what-is-a-gem.md Revert "create a CONTRIBUTING.md to explain how to contribute to this… Jan 9, 2018

README.md

RubyGems Guides

An effort to provide awesome documentation for the RubyGems ecosystem.

Goals

  • Be the definitive place for RubyGems knowledge
  • Help out those new to RubyGems get started and get things done
  • Make it easy to contribute more guides

Want to help?

If a guide is empty, start filling it out! Or, make a new one! Pull requests are gladly accepted!

  • Port content from docs.rubygems.org
  • Port content from rubygems.org/pages/docs
  • Port content from help.rubygems.org knowledge base
  • Find lots of StackOverflow/ruby-talk questions and get their common answers in here
  • Fill out more guides!

Setup

Make sure you have jekyll installed (gem install jekyll), and run:

$ jekyll serve

The pages will be available at http://localhost:4000/

Every guide except for the Command and Specification Reference is just a straight up markdown page, so just go edit it!

For the Command Guide (command-reference.md), edit command-reference.erb and run:

$ rake command_guide

For the Specification Guide, the documentation comes directly from the Gem::Specification class in RubyGems. Edit it, set your RUBYGEMS_DIR to where your code directory is, and run:

$ RUBYGEMS_DIR=~/Dev/ruby/rubygems rake spec_guide --trace

Thanks

Huge thanks to thoughtbot whose handbook this is based off of.

Legal

The actual content of the articles is licensed under Creative Commons. The code that this project consists of is licensed under MIT.