diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..4d41f302 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,15 @@ +## How to contribute to guides.rubygems.org + +#### If you want to contribute to RubyGems itself, visit [the RubyGems Guides](http://guides.rubygems.org/contributing/) +This guide just covers the details of contributing to the guides themselves. + +### Setting up a local development environment + +The guides are built with [Jekyll](https://github.com/jekyll/jekyll). To run the site locally, you'll first need to install Jekyll via `gem install jekyll`. Once installed, you can start the development server via `jekyll server` and point your browser to [http://localhost:4000](http://localhost:4000) + +### Things you can't update here! + +Most of the site can be modified directly in this repository. However, the files below are generated from the [RubyGems source](https://github.com/rubygems/rubygems). Any changes to them need to be updated there and will get applied here when the next RubyGems version is released. + +* command-reference.md +* specification-reference.md diff --git a/command-reference.md b/command-reference.md index 97abad2c..eb93db86 100644 --- a/command-reference.md +++ b/command-reference.md @@ -1,7 +1,7 @@ --- layout: default title: Command Reference -url: /command-reference +permalink: /command-reference previous: /patterns next: /rubygems-org-api --- diff --git a/contributing.md b/contributing-to-rubygems.md similarity index 99% rename from contributing.md rename to contributing-to-rubygems.md index 1097de2b..7359d31f 100644 --- a/contributing.md +++ b/contributing-to-rubygems.md @@ -1,7 +1,7 @@ --- layout: default title: Contributing to RubyGems -url: /contributing +permalink: /contributing previous: /resources next: /faqs --- diff --git a/faqs.md b/faqs.md index cce17770..223ca524 100644 --- a/faqs.md +++ b/faqs.md @@ -1,7 +1,7 @@ --- layout: default title: Frequently Asked Questions -url: /faqs +permalink: /faqs previous: /contributing next: /plugins --- diff --git a/gems-with-extensions.md b/gems-with-extensions.md index e9991b73..5f436f53 100644 --- a/gems-with-extensions.md +++ b/gems-with-extensions.md @@ -1,7 +1,7 @@ --- layout: default title: Gems with Extensions -url: /gems-with-extensions +permalink: /gems-with-extensions previous: /make-your-own-gem next: /name-your-gem alias: /c-extensions diff --git a/make-your-own-gem.md b/make-your-own-gem.md index b6082771..58902363 100644 --- a/make-your-own-gem.md +++ b/make-your-own-gem.md @@ -1,7 +1,7 @@ --- layout: default title: Make your own gem -url: /make-your-own-gem +permalink: /make-your-own-gem previous: /what-is-a-gem next: /gems-with-extensions --- diff --git a/name-your-gem.md b/name-your-gem.md index ff7addeb..96621e01 100644 --- a/name-your-gem.md +++ b/name-your-gem.md @@ -1,7 +1,7 @@ --- layout: default title: Name your gem -url: /name-your-gem +permalink: /name-your-gem previous: /gems-with-extensions next: /publishing --- diff --git a/patterns.md b/patterns.md index cd15b454..5f256cd3 100644 --- a/patterns.md +++ b/patterns.md @@ -1,7 +1,7 @@ --- layout: default title: Patterns -url: /patterns +permalink: /patterns previous: /ssl-certificate-update next: /specification-reference --- diff --git a/plugins.md b/plugins.md index dbff4286..38adfa85 100644 --- a/plugins.md +++ b/plugins.md @@ -1,7 +1,7 @@ --- layout: default title: Plugins -url: /plugins +permalink: /plugins previous: /faqs next: /credits --- diff --git a/publishing.md b/publishing.md index 4450f687..42597ef6 100644 --- a/publishing.md +++ b/publishing.md @@ -1,7 +1,7 @@ --- layout: default title: Publishing your gem -url: /publishing +permalink: /publishing previous: /name-your-gem next: /security --- diff --git a/resources.md b/resources.md index 543c7639..2a9217a2 100644 --- a/resources.md +++ b/resources.md @@ -1,7 +1,7 @@ --- layout: default title: Resources -url: /resources +permalink: /resources previous: /run-your-own-gem-server next: /contributing --- diff --git a/rubygems-basics.md b/rubygems-basics.md index 6c18aa51..4bf06862 100644 --- a/rubygems-basics.md +++ b/rubygems-basics.md @@ -1,7 +1,7 @@ --- layout: default title: RubyGems Basics -url: /rubygems-basics +permalink: /rubygems-basics previous: / next: /what-is-a-gem --- diff --git a/rubygems-org-api-v2.md b/rubygems-org-api-v2.md index 477514e3..55106111 100644 --- a/rubygems-org-api-v2.md +++ b/rubygems-org-api-v2.md @@ -1,7 +1,7 @@ --- layout: default title: RubyGems.org API V2 -url: /rubygems-org-api-v2 +permalink: /rubygems-org-api-v2 previous: /rubygems-org-api next: /run-your-own-gem-server --- diff --git a/rubygems-org-api.md b/rubygems-org-api.md index 9cf48afc..72d64bad 100644 --- a/rubygems-org-api.md +++ b/rubygems-org-api.md @@ -1,7 +1,7 @@ --- layout: default title: RubyGems.org API -url: /rubygems-org-api +permalink: /rubygems-org-api previous: /command-reference next: /rubygems-org-api-v2 --- diff --git a/run-your-own-gem-server.md b/run-your-own-gem-server.md index 2433572b..23c5e2d1 100644 --- a/run-your-own-gem-server.md +++ b/run-your-own-gem-server.md @@ -1,7 +1,7 @@ --- layout: default title: Run your own gem server -url: /run-your-own-gem-server +permalink: /run-your-own-gem-server previous: /rubygems-org-api-v2 next: /resources --- diff --git a/security.md b/security.md index 3341f3e2..9da4ca3a 100644 --- a/security.md +++ b/security.md @@ -1,7 +1,7 @@ --- layout: default title: Security -url: /security +permalink: /security previous: /publishing next: /ssl-certificate-update --- diff --git a/specification-reference.md b/specification-reference.md index a090ef2b..38f249bf 100644 --- a/specification-reference.md +++ b/specification-reference.md @@ -1,7 +1,7 @@ --- layout: default title: Specification Reference -url: /specification-refence +permalink: /specification-refence previous: /patterns next: /command-reference --- diff --git a/ssl-certificate-update.md b/ssl-certificate-update.md index 9f28e567..8dd88750 100644 --- a/ssl-certificate-update.md +++ b/ssl-certificate-update.md @@ -1,7 +1,7 @@ --- layout: default title: SSL Certificate Update -url: /ssl-certificate-update +permalink: /ssl-certificate-update previous: /security next: /patterns --- diff --git a/what-is-a-gem.md b/what-is-a-gem.md index a487bfc6..bad8cce8 100644 --- a/what-is-a-gem.md +++ b/what-is-a-gem.md @@ -1,7 +1,7 @@ --- layout: default title: What is a gem? -url: /what-is-a-gem +permalink: /what-is-a-gem previous: /rubygems-basics next: /make-your-own-gem ---