Skip to content

Commit 90bedd3

Browse files
brrusselburgCvX
andauthored
DEV: Removes out-of-date install script mentions (#51)
I put up a PR to update something in the install-ruby repo, but CVX noticed how out-of-date the files were. We are archiving that repo, so this PR updates the installation docs to remove any mention or links to the scripts. --------- Co-authored-by: Jarek Radosz <[email protected]>
1 parent eacb8db commit 90bedd3

File tree

5 files changed

+56
-63
lines changed

5 files changed

+56
-63
lines changed

docs/02-development-environments/04-macos-setup.md

Lines changed: 12 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -12,28 +12,22 @@ We'll assume that you don't have Ruby/Rails/Postgres/Redis installed on your Mac
1212

1313
## Install Discourse Dependencies
1414

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

17-
```sh
18-
bash <(curl -s https://raw.githubusercontent.com/discourse/install-rails/main/mac)
19-
```
20-
21-
This script will install following new packages on your system:
22-
23-
- Homebrew
2417
- [Git][git_link]
25-
- [rbenv][rbenv_link]
18+
- [rbenv][rbenv_link] or [asdf][asdf_link]
2619
- [ruby-build][ruby_build_link]
2720
- [Ruby][ruby_link] (latest stable)
2821
- [Rails][rails_link]
2922
- [PostgreSQL][pg_link]
23+
- [SQLite][sqlite_link]
3024
- [Redis][redis_link]
31-
- [Bundler][bundler_link]
32-
- Node
25+
- [Node.js][node_link]
3326
- [pnpm][pnpm_link]
34-
- [MailHog][mh]
27+
- [MailHog][mh_link]\*\*
28+
- [ImageMagick][imagemagick_link]\*\*
3529

36-
_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._
30+
_\*\* optional_
3731

3832
> restart your terminal
3933
@@ -135,17 +129,16 @@ Congratulations! You are now the admin of your own Discourse installation!
135129

136130
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).
137131

138-
[mac_script]: https://github.com/discourse/install-rails/blob/main/mac
139132
[git_link]: http://git-scm.com/
140133
[rbenv_link]: https://github.com/sstephenson/rbenv
134+
[asdf_link]: https://asdf-vm.com/guide/getting-started.html
135+
[node_link]: https://nodejs.org/en
141136
[ruby_build_link]: https://github.com/sstephenson/ruby-build
142137
[ruby_link]: https://www.ruby-lang.org/
143138
[rails_link]: http://rubyonrails.org/
144139
[pg_link]: http://www.postgresql.org/
145-
[phantom_link]: http://phantomjs.org/
140+
[sqlite_link]: https://sqlite.org/
146141
[redis_link]: http://redis.io/
147-
[bundler_link]: http://bundler.io/
142+
[imagemagick_link]: http://www.imagemagick.org/
148143
[pnpm_link]: https://pnpm.io/
149-
[docker_guide]: https://meta.discourse.org/t/beginners-guide-to-deploy-discourse-on-digital-ocean-using-docker/12156
150-
[short_name]: http://forums.macrumors.com/showthread.php?t=898855
151-
[mh]: https://github.com/mailhog/MailHog
144+
[mh_link]: https://github.com/mailhog/MailHog

docs/02-development-environments/05-ubuntu-debian-setup.md

Lines changed: 12 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -28,27 +28,22 @@ We suggest having at least 4 GB RAM and 2 CPU cores.
2828

2929
## Install Discourse Dependencies
3030

31-
As regular user run [this script][linux_script] in terminal, to setup Rails development environment:-
32-
33-
```sh
34-
bash <(wget -qO- https://raw.githubusercontent.com/discourse/install-rails/main/linux)
35-
```
36-
37-
This will install the following new packages on your system:
31+
You will need the following packages on your system:
3832

3933
- [Git][git_link]
40-
- [rbenv][rbenv_link]
34+
- [rbenv][rbenv_link] or [asdf][asdf_link]
4135
- [ruby-build][ruby_build_link]
42-
- [Ruby][ruby_link] (stable)
36+
- [Ruby][ruby_link] (latest stable)
4337
- [Rails][rails_link]
4438
- [PostgreSQL][pg_link]
4539
- [SQLite][sqlite_link]
4640
- [Redis][redis_link]
47-
- [Bundler][bundler_link]
48-
- [MailHog][mg]
49-
- [ImageMagick][imagemagick_link]
41+
- [Node.js][node_link]
42+
- [pnpm][pnpm_link]
43+
- [MailHog][mh_link]\*\*
44+
- [ImageMagick][imagemagick_link]\*\*
5045

51-
_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._
46+
_\*\* optional_
5247

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

@@ -64,7 +59,6 @@ _`~` indicates home folder, so Discourse source code will be available in your h
6459

6560
## Setup Database
6661

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

7064
```sh
@@ -141,22 +135,19 @@ Congratulations! You are now the admin of your own Discourse installation!
141135

142136
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).
143137

144-
[linux_script]: https://github.com/discourse/install-rails/blob/main/linux
145138
[git_link]: http://git-scm.com/
146139
[rbenv_link]: https://github.com/sstephenson/rbenv
140+
[asdf_link]: https://asdf-vm.com/guide/getting-started.html
141+
[node_link]: https://nodejs.org/en
147142
[ruby_build_link]: https://github.com/sstephenson/ruby-build
148143
[ruby_link]: https://www.ruby-lang.org/
149144
[rails_link]: http://rubyonrails.org/
150145
[pg_link]: http://www.postgresql.org/
151146
[sqlite_link]: https://sqlite.org/
152147
[redis_link]: http://redis.io/
153-
[bundler_link]: http://bundler.io/
154148
[imagemagick_link]: http://www.imagemagick.org/
155-
[meta]: https://meta.discourse.org/t/developers-guide-to-install-discourse-on-ubuntu/14727
156-
[gh]: https://github.com/techAPJ/discourse-development-ubuntu
157-
[install_guide]: https://github.com/discourse/discourse/blob/master/docs/INSTALL.md
158-
[docker_guide]: https://meta.discourse.org/t/beginners-guide-to-deploy-discourse-on-digital-ocean-using-docker/12156
159-
[mg]: https://github.com/mailhog/MailHog
149+
[pnpm_link]: https://pnpm.io/
150+
[mh_link]: https://github.com/mailhog/MailHog
160151

161152
---
162153

docs/02-development-environments/06-windows-10-setup.md

Lines changed: 30 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -22,27 +22,22 @@ Let’s begin!
2222

2323
## Install Discourse Dependencies
2424

25-
As regular user run [this script](https://github.com/discourse/install-rails/blob/master/linux) in terminal, to setup Rails development environment:-
26-
27-
```sh
28-
bash <(wget -qO- https://raw.githubusercontent.com/discourse/install-rails/master/linux)
29-
```
30-
31-
This will install following new packages on your system:
32-
33-
- [Git](http://git-scm.com/)
34-
- [rbenv](https://github.com/sstephenson/rbenv)
35-
- [ruby-build](https://github.com/sstephenson/ruby-build)
36-
- [Ruby](https://www.ruby-lang.org/) (stable)
37-
- [Rails](http://rubyonrails.org/)
38-
- [PostgreSQL](http://www.postgresql.org/)
39-
- [SQLite](https://sqlite.org/)
40-
- [Redis](http://redis.io/)
41-
- [Bundler](http://bundler.io/)
42-
- [MailHog](https://github.com/mailhog/MailHog)
43-
- [ImageMagick](http://www.imagemagick.org/)
44-
45-
_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._
25+
You will need the following packages on your system:
26+
27+
- [Git][git_link]
28+
- [rbenv][rbenv_link] or [asdf][asdf_link]
29+
- [ruby-build][ruby_build_link]
30+
- [Ruby][ruby_link] (latest stable)
31+
- [Rails][rails_link]
32+
- [PostgreSQL][pg_link]
33+
- [SQLite][sqlite_link]
34+
- [Redis][redis_link]
35+
- [Node.js][node_link]
36+
- [pnpm][pnpm_link]
37+
- [MailHog][mh_link]\*\*
38+
- [ImageMagick][imagemagick_link]\*\*
39+
40+
_\*\* optional_
4641

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

509504
_Last Reviewed by @SaraDev on [date=2022-06-15 time=19:00:00 timezone="America/Los_Angeles"]_
505+
506+
[git_link]: http://git-scm.com/
507+
[rbenv_link]: https://github.com/sstephenson/rbenv
508+
[asdf_link]: https://asdf-vm.com/guide/getting-started.html
509+
[node_link]: https://nodejs.org/en
510+
[ruby_build_link]: https://github.com/sstephenson/ruby-build
511+
[ruby_link]: https://www.ruby-lang.org/
512+
[rails_link]: http://rubyonrails.org/
513+
[pg_link]: http://www.postgresql.org/
514+
[sqlite_link]: https://sqlite.org/
515+
[redis_link]: http://redis.io/
516+
[imagemagick_link]: http://www.imagemagick.org/
517+
[pnpm_link]: https://pnpm.io/
518+
[mh_link]: https://github.com/mailhog/MailHog

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
"lint": "prettier --check '**/*.{md,json,mjs,yml}'",
66
"lint:fix": "prettier --write '**/*.{md,json,mjs,yml}'"
77
},
8-
"dependencies": {
8+
"devDependencies": {
99
"prettier": "^3.4.2",
1010
"prettier-plugin-ember-template-tag": "^2.0.4"
1111
}

pnpm-lock.yaml

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)