https://github.com/rubygems/guides
An effort to provide awesome documentation for the RubyGems ecosystem.
https://github.com/rubygems/guides
rubygems
Last synced: 2 months ago
JSON representation
An effort to provide awesome documentation for the RubyGems ecosystem.
- Host: GitHub
- URL: https://github.com/rubygems/guides
- Owner: rubygems
- License: other
- Created: 2011-04-26T23:03:54.000Z (over 14 years ago)
- Default Branch: main
- Last Pushed: 2025-02-17T18:45:37.000Z (11 months ago)
- Last Synced: 2025-02-17T19:40:48.003Z (11 months ago)
- Topics: rubygems
- Language: SCSS
- Homepage: https://guides.rubygems.org
- Size: 5.43 MB
- Stars: 154
- Watchers: 25
- Forks: 189
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- License: MIT-LICENSE
- Security: security.md
Awesome Lists containing this project
- awesome-list - guides
README
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!
* Pick one from [the repo issues](https://github.com/rubygems/guides/issues)
* 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
-----
First, run `bundle install` and `bundle exec rake`. This will launch both Jekyll and
Sass in "watch" mode.
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:
$ bundle exec 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 bundle exec rake spec_guide --trace
Thanks
------
Huge thanks to [thoughtbot](https://thoughtbot.com) whose [playbook](https://thoughtbot.com/playbook) 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.