[
https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16413811#comment-16413811
]
ASF GitHub Bot commented on CB-13400:
-------------------------------------
janpio closed pull request #809: CB-13400: Added introduction to installation
section
URL: https://github.com/apache/cordova-docs/pull/809
This is a PR merged from a forked repository.
As GitHub hides the original diff on merge, it is displayed below for
the sake of provenance:
As this is a foreign pull request (from a fork), the diff is supplied
below (as it won't show otherwise due to GitHub magic):
diff --git a/doc/installing-a-development-environment.md
b/doc/installing-a-development-environment.md
index 5020839fe..56f6faebe 100644
--- a/doc/installing-a-development-environment.md
+++ b/doc/installing-a-development-environment.md
@@ -1,5 +1,12 @@
## Installing
+The development environment setup requires installation of the following
software:
+
+1. Ruby - Needed by Jekyll. Jekyll is the static site generator that generates
the website and docs.
+1. Node.js - Needs to be installed in order to install all the required
development and JavaScript dependencies.
+1. Make - Can be installed in order to build Cordova website using Make. This
installation is optional.
+1. Python - Can be installed in order to invoke simple HTTP server from Make.
This installation is optional.
+
### Mac OS X
#### Ruby
@@ -8,13 +15,6 @@ Install Homebrew from [this site][homebrew], and then run:
brew install ruby@2.0
-#### 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.
@@ -25,6 +25,12 @@ Make comes with the Xcode Command Line Tools. To install
them, run:
xcode-select --install
+#### Python (optional)
+
+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.
### Windows
@@ -49,17 +55,6 @@ Follow these steps:
ruby dk.rb install
1. Close `cmd.exe`.
-#### Python
-
-Python 2.7 is also required to build the docs. NOTE: *The docs will not build
with Python 3.0 or greater.*
-
-Follow these steps:
-
-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.
-
#### 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.
@@ -68,6 +63,14 @@ Go to [this site][nodejs], and click the "Install" button.
Then run the download
Make can be installed on Windows from [this page][make_page] by downloading
the [setup tool][make_setup] and running it.
+#### Python (optional)
+
+Follow these steps:
+
+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.
### Linux
@@ -75,10 +78,6 @@ Make can be installed on Windows from [this page][make_page]
by downloading the
Run the commands from [this site][ruby_linux] that apply to your Linux
distribution.
-#### 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].
-
#### Node.js
Follow the instructions on [this site][linux_node].
@@ -87,6 +86,9 @@ Follow the instructions on [this site][linux_node].
Make is installed by default on Linux.
+#### Python (optional)
+
+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].
### Check Installations
@@ -98,16 +100,6 @@ 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.*
-
-Verify your Python installation by running:
-
- python --version
-
-The version must be 2.7.x.
-
#### Verify Node.js
Verify your Node.js installation by running:
@@ -121,6 +113,15 @@ Verify your make installation by running:
make --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.*
+
+Verify your Python installation by running:
+
+ python --version
+
+The version must be 2.7.x.
### Local repo setup
@@ -143,7 +144,6 @@ Finally, install Node.js and JavaScript dependencies by
running:
npm install
-
### Troubleshooting
#### SSL certificate issue while executing `gem install bundler` on Windows
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
> Restructure and test "Installing" instructions
> ----------------------------------------------
>
> Key: CB-13400
> URL: https://issues.apache.org/jira/browse/CB-13400
> Project: Apache Cordova
> Issue Type: Sub-task
> Components: cordova-docs
> Reporter: Jan Piotrowski (Sujan)
> Assignee: Gandhirajan
> Priority: Major
>
> When https://github.com/apache/cordova-docs/pull/745 is merged, the resulting
> "installing-a-development-environment.md" should be a) tested for correctness
> and b) restructure by platform instead of by tech. Makes much more sense, as
> one will only work through the list for one platform. c) might be to add some
> explanation which tech is used for which reason and part of the site.
--
This message was sent by Atlassian JIRA
(v7.6.3#76005)
---------------------------------------------------------------------
To unsubscribe, e-mail: issues-unsubscr...@cordova.apache.org
For additional commands, e-mail: issues-h...@cordova.apache.org
