diff --git a/_layouts/default.html b/_layouts/default.html index 1c9fd9e..39201c5 100644 --- a/_layouts/default.html +++ b/_layouts/default.html @@ -145,12 +145,12 @@
- Status + Status Uptime Code Discuss Stats - Blog + Blog About Help
diff --git a/contributing.md b/contributing.md index fd9dafa..83ef70d 100644 --- a/contributing.md +++ b/contributing.md @@ -168,7 +168,7 @@ The central home for RubyGems documentation, including tutorials and reference m User-contributed guides are more than welcome and encouraged!
- Site + Site Issues
@@ -187,7 +187,7 @@ User-contributed guides are more than welcome and encouraged! Gem Whisperer An example of how to use [RubyGems.org's -webhooks](http://guides.rubygems.org/rubygems-org-api/#webhook-methods) to listen to every gem being +webhooks](https://guides.rubygems.org/rubygems-org-api/#webhook-methods) to listen to every gem being pushed.
@@ -250,13 +250,13 @@ These projects are outside of the RubyGems core, but work closely with RubyGems RubyDoc.info -A fantastic provider of [YARD](http://yardoc.org) documentation for every +A fantastic provider of [YARD](https://yardoc.org) documentation for every RubyGem available. Push a gem, and you get docs created instantly! RubyGems.org links to this site and it uses [RubyGems.org's -webhooks](http://guides.rubygems.org/rubygems-org-api/#webhook-methods) as well. +webhooks](https://guides.rubygems.org/rubygems-org-api/#webhook-methods) as well.
- Site + Site Issues Mailing List
diff --git a/credits.md b/credits.md index 809e88b..44f3bc0 100644 --- a/credits.md +++ b/credits.md @@ -39,14 +39,14 @@ Acknowledgments Material for the Guides was adapted from these sources: -* [Gem Packaging: Best Practices](http://weblog.rubyonrails.org/2009/9/1/gem-packaging-best-practices) +* [Gem Packaging: Best Practices](https://weblog.rubyonrails.org/2009/9/1/gem-packaging-best-practices) * [Gem Sawyer, Modern Day Ruby Warrior](http://rubylearning.com/blog/2010/10/06/gem-sawyer-modern-day-ruby-warrior/) * [How to Name Gems](http://blog.segment7.net/2010/11/15/how-to-name-gems) -* [Rubygems Good Practice](http://yehudakatz.com/2009/07/24/rubygems-good-practice/) +* [Rubygems Good Practice](https://yehudakatz.com/2009/07/24/rubygems-good-practice/) * [Writing Ruby C extensions: Part 1](http://tenderlovemaking.com/2009/12/18/writing-ruby-c-extensions-part-1) * [Writing Ruby C extensions: Part 2](http://tenderlovemaking.com/2010/12/11/writing-ruby-c-extensions-part-2) Hosting ------- -Hosted by [GitHub Pages](http://pages.github.com/). +Hosted by [GitHub Pages](https://pages.github.com/). diff --git a/gems-with-extensions.md b/gems-with-extensions.md index b81545c..fbc391a 100644 --- a/gems-with-extensions.md +++ b/gems-with-extensions.md @@ -13,10 +13,10 @@ Many gems use extensions to wrap libraries that are written in C with a ruby wrapper. Examples include [nokogiri][nokogiri] which wraps [libxml2 and libxslt](http://www.xmlsoft.org), [pg](https://rubygems.org/gems/pg) which is an interface to the [PostgreSQL -database](http://www.postgresql.org) and the +database](https://www.postgresql.org) and the [mysql](https://rubygems.org/gems/mysql) and [mysql2](https://rubygems.org/gems/mysql2) gems which provide an interface to -the [MySQL database](http://www.mysql.com). +the [MySQL database](https://www.mysql.com). Creating a gem that uses an extension involves several steps. This guide will focus on what you should put in your gem specification to make this as easy and @@ -268,13 +268,13 @@ Further Reading * [rake-compiler][rake-compiler] integrates building C and Java extensions into your Rakefile in a smooth manner. * [Writing C extensions part - 1](http://tenderlovemaking.com/2009/12/18/writing-ruby-c-extensions-part-1.html) - and [part 2](http://tenderlovemaking.com/2010/12/11/writing-ruby-c-extensions-part-2.html)) + 1](https://tenderlovemaking.com/2009/12/18/writing-ruby-c-extensions-part-1.html) + and [part 2](https://tenderlovemaking.com/2010/12/11/writing-ruby-c-extensions-part-2.html)) by Aaron Patterson * Interfaces to C libraries can be written using ruby and [fiddle](https://docs.ruby-lang.org/en/master/Fiddle.html) (part of the standard library) or [ruby-ffi](https://github.com/ffi/ffi) -* [Extending Ruby](http://ruby-doc.com/docs/ProgrammingRuby/html/ext_ruby.html) +* [Extending Ruby](https://ruby-doc.com/docs/ProgrammingRuby/html/ext_ruby.html) is a [Programming Ruby](http://docs.ruby-doc.com/docs/ProgrammingRuby/) book chapter about building C extensions. _Please note_: this content is somewhat older and some C extension APIs have changed. diff --git a/name-your-gem.md b/name-your-gem.md index 0b5c2d1..018829e 100644 --- a/name-your-gem.md +++ b/name-your-gem.md @@ -26,7 +26,7 @@ is objectionable, violates intellectual property or the contents of the gem meet these criteria. You can report such a gem to [support@rubygems.org](mailto:support@rubygems.org) via email. -[rubygems]: http://rubygems.org +[rubygems]: https://rubygems.org Use underscores for multiple words ---------------------------------- @@ -53,7 +53,7 @@ The user will `require 'net/http/digest_auth'` to use the extension (in class `Net::HTTP::DigestAuth`). [digest-gem]: https://rubygems.org/gems/net-http-digest_auth -[digest-standard]: http://tools.ietf.org/html/rfc2617 +[digest-standard]: https://tools.ietf.org/html/rfc2617 Don't use UPPERCASE letters --------------------------- @@ -69,4 +69,4 @@ Credits This guide was expanded from [How to Name Gems][how-to-name-gems] by Eric Hodel. -[how-to-name-gems]: https://web.archive.org/web/20130821183311/http://blog.segment7.net/2010/11/15/how-to-name-gems +[how-to-name-gems]: https://web.archive.org/web/20130821183311/https://blog.segment7.net/2010/11/15/how-to-name-gems diff --git a/patterns.md b/patterns.md index 200e014..cefb22c 100644 --- a/patterns.md +++ b/patterns.md @@ -18,7 +18,7 @@ Consistent naming ----------------- > There are only two hard things in Computer Science: cache invalidation and naming things. -> -[Phil Karlton](http://martinfowler.com/bliki/TwoHardThings.html) +> -[Phil Karlton](https://martinfowler.com/bliki/TwoHardThings.html) ### File names @@ -45,7 +45,7 @@ can easily jump in and call `require 'hola'` with no problems. ### Naming your gem Naming your gem is important. Before you pick a name for your gem, do a -quick search on [RubyGems.org](http://rubygems.org) and +quick search on [RubyGems.org](https://rubygems.org) and [GitHub](https://github.com/search) to see if someone else has taken it. Every published gem must have a unique name. Be sure to read our [naming recommendations](/name-your-gem) when you've found a name you like. @@ -60,7 +60,7 @@ it can be really strange (Knuth’s TeX project had version numbers: 3, 3.1, 3.14, 3.141, 3.1415; each successive version added another digit to PI). The RubyGems team urges gem developers to follow the -[Semantic Versioning](http://semver.org) standard for their gem's versions. The +[Semantic Versioning](https://semver.org) standard for their gem's versions. The RubyGems library itself does not enforce a strict versioning policy, but using an "irrational" policy will only be a disservice to those in the community who use your gems. @@ -99,8 +99,8 @@ other. RubyGems provides two main "types" of dependencies: runtime and development. Runtime dependencies are what your gem needs to work (such as -[rails](http://rubygems.org/gems/rails) needing -[activesupport](http://rubygems.org/gems/activesupport)). +[rails](https://rubygems.org/gems/rails) needing +[activesupport](https://rubygems.org/gems/activesupport)). Development dependencies are useful for when someone wants to make modifications to your gem. When you specify development dependencies, another @@ -134,7 +134,7 @@ RubyGems can handle loading the dependency instead of the user. ### Pessimistic version constraint -If your gem properly follows [semantic versioning](http://semver.org) with its +If your gem properly follows [semantic versioning](https://semver.org) with its versioning scheme, then other Ruby developers can take advantage of this when choosing a version constraint to lock down your gem in their application. @@ -174,7 +174,7 @@ excludes the versions that might break your code: gem 'library', '>= 2.2.0', '< 3.0' RubyGems provides a shortcut for this, commonly known as the -[twiddle-wakka](http://robots.thoughtbot.com/post/2508037841/twiddle-wakka): +[twiddle-wakka](https://robots.thoughtbot.com/post/2508037841/twiddle-wakka): # gemspec spec.add_runtime_dependency 'library', @@ -243,7 +243,7 @@ means that the gem can be easily used without needing the RubyGems client to run. For more information please check out [Ryan -Tomayko's](http://tomayko.com/writings/require-rubygems-antipattern) original +Tomayko's](https://tomayko.com/writings/require-rubygems-antipattern) original post about the subject. Loading code @@ -366,5 +366,5 @@ Credits Several sources were used for content for this guide: -* [Rubygems Good Practice](http://yehudakatz.com/2009/07/24/rubygems-good-practice/) -* [Gem Packaging: Best Practices](http://weblog.rubyonrails.org/2009/9/1/gem-packaging-best-practices) +* [Rubygems Good Practice](https://yehudakatz.com/2009/07/24/rubygems-good-practice/) +* [Gem Packaging: Best Practices](https://weblog.rubyonrails.org/2009/9/1/gem-packaging-best-practices) diff --git a/resources.md b/resources.md index ece1f91..a067939 100644 --- a/resources.md +++ b/resources.md @@ -16,37 +16,37 @@ Tutorials * [Making Ruby Gems](http://timelessrepo.com/making-ruby-gems) * [Gemcutter & Jeweler](http://railscasts.com/episodes/183-gemcutter-jeweler) -* [MicroGems: five minute RubyGems](http://jeffkreeftmeijer.com/2011/microgems-five-minute-rubygems/) - Gems so small that you can store them in a gist. +* [MicroGems: five minute RubyGems](https://jeffkreeftmeijer.com/2011/microgems-five-minute-rubygems/) - Gems so small that you can store them in a gist. * [Let's Write a Gem: Part 1](http://rakeroutes.com/blog/lets-write-a-gem-part-one/) and [Part 2](http://rakeroutes.com/blog/lets-write-a-gem-part-two/) * [Polishing Rubies](https://wayback.archive.org/web/20151009055337/https://www.intridea.com/blog/tag/polishing%20rubies) * [A Practical Guide to Using Signed Ruby Gems - Part 1: Bundler](http://blog.meldium.com/home/2013/3/3/signed-rubygems-part) * [Basic RubyGem Development](http://tech.pro/tutorial/1226/basic-rubygem-development) and [Intermediate RubyGem Development](http://tech.pro/tutorial/1277/intermediate-rubygem-development) -* [How to make a Rubygem](http://www.alexedwards.net/blog/how-to-make-a-rubygem) and [How to make a Rubygem: Part Two](http://www.alexedwards.net/blog/how-to-make-a-rubygem-part-two) +* [How to make a Rubygem](https://www.alexedwards.net/blog/how-to-make-a-rubygem) and [How to make a Rubygem: Part Two](https://www.alexedwards.net/blog/how-to-make-a-rubygem-part-two) * [Crafting Gems](http://railsconftutorials.com/2013/sessions/crafting_gems.html) - A tutorial from RailsConf 2013. -* [How to cryptographically sign your RubyGem](http://www.benjaminfleischer.com/2013/11/08/how-to-sign-your-rubygem-cert/) - Step-by-step guide +* [How to cryptographically sign your RubyGem](https://www.benjaminfleischer.com/2013/11/08/how-to-sign-your-rubygem-cert/) - Step-by-step guide Presentations ------------- -* [History of RDoc and RubyGems](https://web.archive.org/web/20110527141407/http://blog.segment7.net/2011/01/17/history-of-rdoc-and-rubygems) -* [Building a Gem](http://www.slideshare.net/sarah.allen/building-a-ruby-gem) -* [Gemology](http://www.slideshare.net/copiousfreetime/gemology) +* [History of RDoc and RubyGems](https://web.archive.org/web/20110527141407/https://blog.segment7.net/2011/01/17/history-of-rdoc-and-rubygems) +* [Building a Gem](https://www.slideshare.net/sarah.allen/building-a-ruby-gem) +* [Gemology](https://www.slideshare.net/copiousfreetime/gemology) Philosophy ---------- -* [Semantic Versioning](http://semver.org/) -* [Ruby Packaging Standard](https://web.archive.org/web/20170704013540/http://chneukirchen.github.io/rps/) -* [Why `require 'rubygems'` Is Wrong](http://tomayko.com/writings/require-rubygems-antipattern) +* [Semantic Versioning](https://semver.org/) +* [Ruby Packaging Standard](https://web.archive.org/web/20170704013540/https://chneukirchen.github.io/rps/) +* [Why `require 'rubygems'` Is Wrong](https://tomayko.com/writings/require-rubygems-antipattern) * [How to Name Gems](https://web.archive.org/web/20130821183311/http://blog.segment7.net:80/2010/11/15/how-to-name-gems) -* [Make the world a better place; put a license in your gemspec](http://www.benjaminfleischer.com/2013/07/12/put-a-license-in-your-gemspec/) +* [Make the world a better place; put a license in your gemspec](https://www.benjaminfleischer.com/2013/07/12/put-a-license-in-your-gemspec/) Patterns -------- -* [Gem Packaging: Best Practices](http://weblog.rubyonrails.org/2009/9/1/gem-packaging-best-practices) -* [Rubygems Good Practice](http://yehudakatz.com/2009/07/24/rubygems-good-practice/) -* [Gem Development Best Practices](http://blog.carbonfive.com/2011/01/22/gem-development-best-practices/) +* [Gem Packaging: Best Practices](https://weblog.rubyonrails.org/2009/9/1/gem-packaging-best-practices) +* [Rubygems Good Practice](https://yehudakatz.com/2009/07/24/rubygems-good-practice/) +* [Gem Development Best Practices](https://blog.carbonfive.com/2011/01/22/gem-development-best-practices/) Creating -------- @@ -61,7 +61,7 @@ Tools to help build gems. * [RStack](https://github.com/jrun/rstack) - Generator intended for use on private gems. * [rubygems-tasks](https://github.com/postmodern/rubygems-tasks) - Rake tasks for building, installing, and releasing Ruby Gems. * [ore](https://github.com/ruby-ore/ore) - Project generator with a variety of templates. -* [Omnibus](https://github.com/opscode/omnibus-ruby) - Generate full-stack installers for ruby code (see this [Omnibus tutorial](http://blog.scoutapp.com/articles/2013/06/21/omnibus-tutorial-package-a-standalone-ruby-gem) for instructions on using it to package a standalone RubyGem.) +* [Omnibus](https://github.com/opscode/omnibus-ruby) - Generate full-stack installers for ruby code (see this [Omnibus tutorial](https://blog.scoutapp.com/articles/2013/06/21/omnibus-tutorial-package-a-standalone-ruby-gem) for instructions on using it to package a standalone RubyGem.) Monitoring ---------- diff --git a/rubygems-org-api.md b/rubygems-org-api.md index 6974781..07eec0c 100644 --- a/rubygems-org-api.md +++ b/rubygems-org-api.md @@ -30,7 +30,7 @@ API Authorization ----------------- Some API calls require an Authorization header. To create or view existing API keys, click on -your username when logged in to [RubyGems.org](http://rubygems.org), 'Settings', and then 'API Keys'. Here's an example of +your username when logged in to [RubyGems.org](https://rubygems.org), 'Settings', and then 'API Keys'. Here's an example of using an API key: $ curl -H 'Authorization:YOUR_API_KEY' \ diff --git a/security.md b/security.md index 3d9b06a..1706943 100644 --- a/security.md +++ b/security.md @@ -25,7 +25,7 @@ by the gem's author. Because of this, the security of gem code is a topic of active discussion within the Ruby community. RubyGems has had the ability to [cryptographically sign -gems](http://docs.seattlerb.org/rubygems/Gem/Security.html) since version +gems](https://docs.seattlerb.org/rubygems/Gem/Security.html) since version 0.8.11. This signing works by using the `gem cert` command to create a key pair, and then packaging signing data inside the gem itself. The `gem install` command optionally lets you set a security policy, and you can verify the @@ -130,7 +130,7 @@ Add cert paths to your gemspec ------- -### OpenPGP signing is [not recommended due to lack of support (archive)](https://web.archive.org/web/20131125012205/http://www.rubygems-openpgp-ca.org/blog/nobody-cares-about-signed-gems.html). +### OpenPGP signing is [not recommended due to lack of support (archive)](https://web.archive.org/web/20131125012205/https://www.rubygems-openpgp-ca.org/blog/nobody-cares-about-signed-gems.html). For details, see discussion [with Yorick Peterse](https://github.com/rubygems/guides/pull/70#issuecomment-29007487). @@ -143,7 +143,7 @@ Reporting Security vulnerabilities If you spot a security vulnerability in someone else's gem, then you first step should be to check whether this is a known vulnerability. -One way is by searching for an advisory on [RubySec](http://rubysec.com). +One way is by searching for an advisory on [RubySec](https://rubysec.com). If this looks like a newly discovered vulnerability, then you should contact the author(s) privately (i.e., not via a pull request or issue on a @@ -182,10 +182,10 @@ Credits Several sources were used for content for this guide: -* [How to cryptographically sign your RubyGem](http://www.benjaminfleischer.com/2013/11/08/how-to-sign-your-rubygem-cert/) - Step-by-step guide +* [How to cryptographically sign your RubyGem](https://www.benjaminfleischer.com/2013/11/08/how-to-sign-your-rubygem-cert/) - Step-by-step guide * [Signing rubygems - Pasteable instructions (archive)](https://web.archive.org/web/20130218074304/https://developer.zendesk.com/blog/2013/02/03/signing-gems/) * [metric_fu gem gemspec](https://github.com/metricfu/metric_fu/blob/master/metric_fu.gemspec) * [RubyGems Trust Model Overview](https://github.com/rubygems-trust/rubygems.org/wiki/Overview), [doc](https://goo.gl/ybFIO) * [Let's figure out a way to start signing RubyGems](https://tonyarcieri.com/lets-figure-out-a-way-to-start-signing-rubygems) -* [A Practical Guide to Using Signed Ruby Gems - Part 3: Signing your Own (archive)](https://web.archive.org/web/20131125020053/http://blog.meldium.com/home/2013/3/6/signing-gems-how-to) +* [A Practical Guide to Using Signed Ruby Gems - Part 3: Signing your Own (archive)](https://web.archive.org/web/20131125020053/https://blog.meldium.com/home/2013/3/6/signing-gems-how-to) * Also see the [Resources](/resources) page. diff --git a/setting-up-multifactor-authentication.md b/setting-up-multifactor-authentication.md index 411e6f6..494efd7 100644 --- a/setting-up-multifactor-authentication.md +++ b/setting-up-multifactor-authentication.md @@ -28,7 +28,7 @@ will see a dropdown menu with these options: - **UI and API**: UI operations, `gem signin`, `push`, `owner --add` and `owner --remove` will require OTP code. Note: If you are on the "UI only" or "UI and gem signin" authentication level, -you can selectively enable MFA on specific API keys (see [API key scopes](http://guides.rubygems.org/api-key-scopes/#enable-mfa-on-specific-api-keys)). +you can selectively enable MFA on specific API keys (see [API key scopes](https://guides.rubygems.org/api-key-scopes/#enable-mfa-on-specific-api-keys)). This is different from the "UI and API" level as MFA is enabled on all API keys by default and cannot be selectively enabled. Steps to change your MFA level: