Skip to content

CB-13400 Restructure and test "Installing" instructions(part b) - Categorizing installation steps according to OSes #802

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Mar 5, 2018
Merged

CB-13400 Restructure and test "Installing" instructions(part b) - Categorizing installation steps according to OSes #802

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
122 changes: 65 additions & 57 deletions doc/installing-a-development-environment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,34 @@
## Installing

### Ruby
### Mac OS X

Ruby 2.0 is required to build the docs. NOTE: *The docs will not build with Ruby 1.8, 1.9 or 2.4.*

#### Mac OS X
#### Ruby

Install Homebrew from [this site][homebrew], and then run:

brew install ruby@2.0

#### Windows
#### Python

Mac OS X comes with Python 2.7 pre-installed. Else, follow these steps:

1. Download [this installer][python_installer_mac] from [this page][python_downloads].
2. Run the downloaded file.

#### Node.js

Go to [this site][nodejs], and click the "Install" button. Then run the downloaded file and follow the on-screen instructions. Make sure that the option to **install NPM** is enabled, if you see one.

#### Make (optional)

Make comes with the Xcode Command Line Tools. To install them, run:

xcode-select --install


### Windows

#### Ruby

Follow these steps:

Expand All @@ -31,57 +49,64 @@ Follow these steps:
ruby dk.rb install
1. Close `cmd.exe`.

#### Linux

Run the commands from [this site][ruby_linux] that apply to your Linux distribution.
#### Python

#### Verify Ruby
Python 2.7 is also required to build the docs. NOTE: *The docs will not build with Python 3.0 or greater.*

Verify your Ruby installation by running:
Follow these steps:

ruby --version
1. Download [this installer][python_installer_windows] from [this page][python_downloads].
2. Run the downloaded file.
1. Use the default installation path
1. Make sure the **'add executable to path'** option is checked.

### Python
#### Node.js

Python 2.7 is also required to build the docs. NOTE: *The docs will not build with Python 3.0 or greater.*
Go to [this site][nodejs], and click the "Install" button. Then run the downloaded file and follow the on-screen instructions. Make sure that the option to **install NPM** is enabled, if you see one.

#### Mac OS X
#### Make (optional)

Mac OS X comes with Python 2.7 pre-installed. Else, follow these steps:
Make can be installed on Windows from [this page][make_page] by downloading the [setup tool][make_setup] and running it.

1. Download [this installer][python_installer_mac] from [this page][python_downloads].
2. Run the downloaded file.

#### Windows
### Linux

Follow these steps:
#### Ruby

1. Download [this installer][python_installer_windows] from [this page][python_downloads].
2. Run the downloaded file.
1. Use the default installation path
1. Make sure the **'add executable to path'** option is checked.
Run the commands from [this site][ruby_linux] that apply to your Linux distribution.

#### Linux
#### Python

The latest version of CentOS, Fedora, Redhat Enterprise (RHEL) and Ubuntu come with Python 2.7 pre-installed. Else, follow the steps from [this site][python_linux].

#### Verify Python
#### Node.js

Verify your Python installation by running:
Follow the instructions on [this site][linux_node].

python --version
#### Make

The version must be 2.7.x.
Make is installed by default on Linux.

### Node.js

#### Mac OS X & Windows
### Check Installations

Go to [this site][nodejs], and click the "Install" button. Then run the downloaded file and follow the on-screen instructions. Make sure that the option to **install NPM** is enabled, if you see one.
#### Verify Ruby

Ruby 2.0 is required to build the docs. NOTE: *The docs will not build with Ruby 1.8, 1.9 or 2.4.*

Verify your Ruby installation by running:

ruby --version

#### Verify Python

Python 2.7 is also required to build the docs. NOTE: *The docs will not build with Python 3.0 or greater.*

#### Linux
Verify your Python installation by running:

Linux, follow the instructions on [this site][linux_node].
python --version

The version must be 2.7.x.

#### Verify Node.js

Expand All @@ -90,6 +115,13 @@ Verify your Node.js installation by running:
node --version
npm --version

#### Verify make

Verify your make installation by running:

make --version


### Local repo setup

Clone the [cordova-docs] GitHub repo to a local folder.
Expand All @@ -111,30 +143,6 @@ Finally, install Node.js and JavaScript dependencies by running:

npm install

### Make (optional)

The website can be built with Gulp or Make. The Gulp workflow is enabled by just installing all the JavaScript dependencies. The Make workflow usually allows for faster builds, but requires installation of the `make` tool.

#### Windows

Make can be installed on Windows from [this page][make_page] by downloading the [setup tool][make_setup] and running it.

#### Mac OS X

Make comes with the Xcode Command Line Tools. To install them, run:

xcode-select --install

#### Linux

Make is installed by default on Linux.

#### Verify make

Verify your make installation by running:

make --version


### Troubleshooting

Expand Down