Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Make installation instructions consistent

Aperta
#2,874 1 commento 2 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
35/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
ruby
Ambito
documentation

Direzione di ricerca

Inizia confrontando le istruzioni per macOS raggiunte tramite la call to action per il download di ruby-lang.org con la pagina di documentazione/installazione. Esamina le raccomandazioni concorrenti relative a rbenv, RVM e Homebrew e determina la strategia preferita dal progetto; il lavoro è completato quando un approccio è presentato in modo coerentemente prominente nelle pagine di installazione pubblicate.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

If you do this:

  1. Visit https://www.ruby-lang.org/
  2. Click the large DOWNLOAD RUBY call to action
  3. Scan to he first appearance of macOS

then you are encouraged to use rbenv or RVM to install Ruby.

But if you:

  1. Search the internet for "install ruby"
  2. Land on https://www.ruby-lang.org/en/documentation/installation/
  3. Scan for the first appearance of macOS

then you are encouraged to install Ruby using Homebrew.


These two different ways of installing Ruby are extremely different. And they lead to different outcomes. For example, I have been using Ruby on macOS for 5 or 10 years, contribute to major projects and I still cannot reliably make Ruby work on macOS, especially when using Jekyll or Bundler or even rbenv. Please do not respond to this part, please simply let me make the point without further debate that properly installing Ruby can be frustrating for at least one person.


Recommendation

The Ruby project should internally decide one specific preferred installation strategy for macOS. It should then promote that preferred approach prominently (i.e. above other competing instructions) on all its published pages regarding to installing Ruby.

Completing this will allow people to achieve a supported Ruby installation by using the Universal UNIX Software Installation approach:

  1. Delete the software using all the ways that didn't work.
  2. Find the project's website.
  3. Find some instructions on there.
  4. Follow the first applicable instructions you see.

Currently Ruby is not compatible with the Universal instructions because step 3 results in competing instructions.

After this is complete, please consider opinionated and consistent install instructions platforms other than macOS.

Lingua principale
HTML
Stelle
944
Fork
673
Merge medio
2g 6h
PR unite (30g)
9

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di ruby/www.ruby-lang.org

Tutte le issue di ruby/www.ruby-lang.org

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.