Skip to content

DEV: Removes out-of-date install script mentions #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 11 additions & 20 deletions docs/02-development-environments/04-macos-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,28 +12,20 @@ We'll assume that you don't have Ruby/Rails/Postgres/Redis installed on your Mac

## Install Discourse Dependencies

Run [this script][mac_script] in your Terminal (or equivalent), to setup your machine for Discourse development:
You will need the following new packages on your system:

```sh
bash <(curl -s https://raw.githubusercontent.com/discourse/install-rails/main/mac)
```

This script will install following new packages on your system:

- Homebrew
- [Git][git_link]
- [rbenv][rbenv_link]
- [rbenv][rbenv_link] or [asdf][asdf_link]
- [ruby-build][ruby_build_link]
- [Ruby][ruby_link] (latest stable)
- [Rails][rails_link]
- [PostgreSQL][pg_link]
- [SQLite][sqlite_link]
- [Redis][redis_link]
- [Bundler][bundler_link]
- Node
- [Node.js][node_link]
- [pnpm][pnpm_link]
- [MailHog][mh]

_In case you have any of this package pre-installed and don't want to run entire script, see the [script][mac_script] and pick the packages you don't have currently installed. The script is fine-tuned for Discourse, and includes all the packages required for Discourse installation._
- [MailHog][mh_link]
- [ImageMagick][imagemagick_link]

> restart your terminal

Expand Down Expand Up @@ -135,17 +127,16 @@ Congratulations! You are now the admin of your own Discourse installation!

Happy hacking! And to get started with that, see [Beginner’s Guide to Creating Discourse Plugins](https://meta.discourse.org/t/beginners-guide-to-creating-discourse-plugins/30515).

[mac_script]: https://github.com/discourse/install-rails/blob/main/mac
[git_link]: http://git-scm.com/
[rbenv_link]: https://github.com/sstephenson/rbenv
[asdf_link]: https://asdf-vm.com/guide/getting-started.html
[node_link]: https://nodejs.org/en
[ruby_build_link]: https://github.com/sstephenson/ruby-build
[ruby_link]: https://www.ruby-lang.org/
[rails_link]: http://rubyonrails.org/
[pg_link]: http://www.postgresql.org/
[phantom_link]: http://phantomjs.org/
[sqlite_link]: https://sqlite.org/
[redis_link]: http://redis.io/
[bundler_link]: http://bundler.io/
[imagemagick_link]: http://www.imagemagick.org/
[pnpm_link]: https://pnpm.io/
[docker_guide]: https://meta.discourse.org/t/beginners-guide-to-deploy-discourse-on-digital-ocean-using-docker/12156
[short_name]: http://forums.macrumors.com/showthread.php?t=898855
[mh]: https://github.com/mailhog/MailHog
[mh_link]: https://github.com/mailhog/MailHog
31 changes: 10 additions & 21 deletions docs/02-development-environments/05-ubuntu-debian-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,28 +28,21 @@ We suggest having at least 4 GB RAM and 2 CPU cores.

## Install Discourse Dependencies

As regular user run [this script][linux_script] in terminal, to setup Rails development environment:-

```sh
bash <(wget -qO- https://raw.githubusercontent.com/discourse/install-rails/main/linux)
```

This will install the following new packages on your system:
You will need the following packages on your system:

- [Git][git_link]
- [rbenv][rbenv_link]
- [rbenv][rbenv_link] or [asdf][asdf_link]
- [ruby-build][ruby_build_link]
- [Ruby][ruby_link] (stable)
- [Ruby][ruby_link] (latest stable)
- [Rails][rails_link]
- [PostgreSQL][pg_link]
- [SQLite][sqlite_link]
- [Redis][redis_link]
- [Bundler][bundler_link]
- [MailHog][mg]
- [Node.js][node_link]
- [pnpm][pnpm_link]
- [MailHog][mh_link]
- [ImageMagick][imagemagick_link]

_In case you have any of this package pre-installed and don't want to run the entire script, see the [script][linux_script] and pick the packages you don't have currently installed. The script is fine-tuned for Discourse, and includes all the packages required for Discourse installation._

Now that we have installed Discourse dependencies, let's move on to install Discourse itself.

## Clone Discourse
Expand All @@ -64,7 +57,6 @@ _`~` indicates home folder, so Discourse source code will be available in your h

## Setup Database

[details="Already completed by the install script"]
Create role **with the same name as your Linux system username**:

```sh
Expand Down Expand Up @@ -141,22 +133,19 @@ Congratulations! You are now the admin of your own Discourse installation!

Happy hacking! And to get started with that, see [Beginner’s Guide to Creating Discourse Plugins](https://meta.discourse.org/t/beginners-guide-to-creating-discourse-plugins/30515).

[linux_script]: https://github.com/discourse/install-rails/blob/main/linux
[git_link]: http://git-scm.com/
[rbenv_link]: https://github.com/sstephenson/rbenv
[asdf_link]: https://asdf-vm.com/guide/getting-started.html
[node_link]: https://nodejs.org/en
[ruby_build_link]: https://github.com/sstephenson/ruby-build
[ruby_link]: https://www.ruby-lang.org/
[rails_link]: http://rubyonrails.org/
[pg_link]: http://www.postgresql.org/
[sqlite_link]: https://sqlite.org/
[redis_link]: http://redis.io/
[bundler_link]: http://bundler.io/
[imagemagick_link]: http://www.imagemagick.org/
[meta]: https://meta.discourse.org/t/developers-guide-to-install-discourse-on-ubuntu/14727
[gh]: https://github.com/techAPJ/discourse-development-ubuntu
[install_guide]: https://github.com/discourse/discourse/blob/master/docs/INSTALL.md
[docker_guide]: https://meta.discourse.org/t/beginners-guide-to-deploy-discourse-on-digital-ocean-using-docker/12156
[mg]: https://github.com/mailhog/MailHog
[pnpm_link]: https://pnpm.io/
[mh_link]: https://github.com/mailhog/MailHog

---

Expand Down
49 changes: 28 additions & 21 deletions docs/02-development-environments/06-windows-10-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,27 +22,20 @@ Let’s begin!

## Install Discourse Dependencies

As regular user run [this script](https://github.com/discourse/install-rails/blob/master/linux) in terminal, to setup Rails development environment:-

```sh
bash <(wget -qO- https://raw.githubusercontent.com/discourse/install-rails/master/linux)
```

This will install following new packages on your system:

- [Git](http://git-scm.com/)
- [rbenv](https://github.com/sstephenson/rbenv)
- [ruby-build](https://github.com/sstephenson/ruby-build)
- [Ruby](https://www.ruby-lang.org/) (stable)
- [Rails](http://rubyonrails.org/)
- [PostgreSQL](http://www.postgresql.org/)
- [SQLite](https://sqlite.org/)
- [Redis](http://redis.io/)
- [Bundler](http://bundler.io/)
- [MailHog](https://github.com/mailhog/MailHog)
- [ImageMagick](http://www.imagemagick.org/)

_In case you have any of this package pre-installed and don’t want to run entire script, see the [script](https://github.com/discourse/install-rails/blob/master/linux) and pick the packages you don’t have currently installed. The script is fine-tuned for Discourse, and includes all the packages required for Discourse installation._
You will need the following packages on your system:

- [Git][git_link]
- [rbenv][rbenv_link] or [asdf][asdf_link]
- [ruby-build][ruby_build_link]
- [Ruby][ruby_link] (latest stable)
- [Rails][rails_link]
- [PostgreSQL][pg_link]
- [SQLite][sqlite_link]
- [Redis][redis_link]
- [Node.js][node_link]
- [pnpm][pnpm_link]
- [MailHog][mh_link]
- [ImageMagick][imagemagick_link]

Now that we have installed Discourse dependencies, let’s move on to install Discourse itself.
[/quote]
Expand Down Expand Up @@ -507,3 +500,17 @@ Any further issues that show up can be addressed in the future.
---

_Last Reviewed by @SaraDev on [date=2022-06-15 time=19:00:00 timezone="America/Los_Angeles"]_

[git_link]: http://git-scm.com/
[rbenv_link]: https://github.com/sstephenson/rbenv
[asdf_link]: https://asdf-vm.com/guide/getting-started.html
[node_link]: https://nodejs.org/en
[ruby_build_link]: https://github.com/sstephenson/ruby-build
[ruby_link]: https://www.ruby-lang.org/
[rails_link]: http://rubyonrails.org/
[pg_link]: http://www.postgresql.org/
[sqlite_link]: https://sqlite.org/
[redis_link]: http://redis.io/
[imagemagick_link]: http://www.imagemagick.org/
[pnpm_link]: https://pnpm.io/
[mh_link]: https://github.com/mailhog/MailHog
Loading