[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16413812#comment-16413812 ] ASF subversion and git services commented on CB-13400: -- Commit e3be03784f75040e0d63ff9af030ea99341b286a in cordova-docs's branch refs/heads/master from [~Gandhirajan] [ https://gitbox.apache.org/repos/asf?p=cordova-docs.git;h=e3be037 ] CB-13400: Added introduction to installation section (#809) * added introduction to installation section * implemented review comments * implemented review comments * implemented review comments * implemented review comments * implemented review comments * implemented review comments > 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
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ 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.* + +
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16413315#comment-16413315 ] ASF GitHub Bot commented on CB-13400: - dblotsky commented on a change in pull request #809: CB-13400: Added introduction to installation section URL: https://github.com/apache/cordova-docs/pull/809#discussion_r176972827 ## File path: doc/installing-a-development-environment.md ## @@ -87,6 +86,9 @@ Follow the instructions on [this site][linux_node]. Make is installed by default on Linux. + Python Review comment: Nitpick: for consistency, this should also be `Python (optional)`. 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
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16413314#comment-16413314 ] ASF GitHub Bot commented on CB-13400: - dblotsky commented on a change in pull request #809: CB-13400: Added introduction to installation section URL: https://github.com/apache/cordova-docs/pull/809#discussion_r176972275 ## File path: 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 Makefile. This installation is optional. +1. Python - Can be installed in order to invoke simple HTTP server from Makefile. This installation is optional. Review comment: Grammar nitpick: please capitalise proper names for consistency. So: - "cordova" -> "Cordova" - "javascript" -> "JavaScript" - etc. Also: "using Makefile" should either be "using Make", or "using the Makefile". 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
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16413123#comment-16413123 ] ASF GitHub Bot commented on CB-13400: - gandhirajan commented on a change in pull request #809: CB-13400: Added introduction to installation section URL: https://github.com/apache/cordova-docs/pull/809#discussion_r176949385 ## File path: doc/installing-a-development-environment.md ## @@ -1,5 +1,14 @@ ## Installing +### Introduction to Installation + +The development environment setup requires installation of following softwares: + +1. Ruby - Needs to be installed in order to install and use Jekyll. Jekyll helps in tranforming plain texts into static websites. +1. Node.js - Needs to be installed in order to install all the required development and javascript dependencies. Review comment: @janpio @dblotsky Should we elaborate it bit more or just say "Needed by the build tools"? If its clarified, we can close this PR 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
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16413122#comment-16413122 ] ASF GitHub Bot commented on CB-13400: - gandhirajan commented on a change in pull request #809: CB-13400: Added introduction to installation section URL: https://github.com/apache/cordova-docs/pull/809#discussion_r176949334 ## File path: doc/installing-a-development-environment.md ## @@ -1,5 +1,14 @@ ## Installing +### Introduction to Installation Review comment: @janpio Taken care Jan. 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
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16411190#comment-16411190 ] ASF GitHub Bot commented on CB-13400: - janpio commented on a change in pull request #809: CB-13400: Added introduction to installation section URL: https://github.com/apache/cordova-docs/pull/809#discussion_r176695995 ## File path: doc/installing-a-development-environment.md ## @@ -1,5 +1,14 @@ ## Installing +### Introduction to Installation Review comment: the headline actually feels pretty redundant - the paragraph can just sit under `Installing` imo. 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
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16410810#comment-16410810 ] ASF GitHub Bot commented on CB-13400: - gandhirajan commented on a change in pull request #809: CB-13400: Added introduction to installation section URL: https://github.com/apache/cordova-docs/pull/809#discussion_r176639084 ## File path: doc/installing-a-development-environment.md ## @@ -1,5 +1,14 @@ ## Installing +### Introduction to Installation + +The development environment setup requires installation of following softwares: + +1. Ruby - Needs to be installed in order to install and use Jekyll. Jekyll helps in tranforming plain texts into static websites. +1. Node.js - Needs to be installed in order to install all the required development and javascript dependencies. Review comment: @dblotsky I feel its too short and abstract. Any elaborations? @janpio Your thoughts? 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
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16410809#comment-16410809 ] ASF GitHub Bot commented on CB-13400: - gandhirajan commented on a change in pull request #809: CB-13400: Added introduction to installation section URL: https://github.com/apache/cordova-docs/pull/809#discussion_r176638959 ## File path: doc/installing-a-development-environment.md ## @@ -1,5 +1,14 @@ ## Installing +### Introduction to Installation Review comment: @dblotsky Its a kind of heads up to the developer about what he/she is gonna install for this environment and why it is required. Jan and Myself have agreed that it will give more insight for the developer as to why he/she is doing it. 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
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16410806#comment-16410806 ] ASF GitHub Bot commented on CB-13400: - gandhirajan commented on a change in pull request #809: CB-13400: Added introduction to installation section URL: https://github.com/apache/cordova-docs/pull/809#discussion_r176638758 ## File path: doc/installing-a-development-environment.md ## @@ -1,5 +1,14 @@ ## Installing +### Introduction to Installation + +The development environment setup requires installation of following softwares: + +1. Ruby - Needs to be installed in order to install and use Jekyll. Jekyll helps in tranforming plain texts into static websites. +1. Node.js - Needs to be installed in order to install all the required development and javascript dependencies. +1. Make - Can to be installed in order to build cordova website using Makefile. This installation is optional. +1. Python - Can to be installed in order to invoke simple HTTP server from Makefile. This installation is optional. Review comment: Taken care 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
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16410805#comment-16410805 ] ASF GitHub Bot commented on CB-13400: - gandhirajan commented on a change in pull request #809: CB-13400: Added introduction to installation section URL: https://github.com/apache/cordova-docs/pull/809#discussion_r176638740 ## File path: doc/installing-a-development-environment.md ## @@ -1,5 +1,14 @@ ## Installing +### Introduction to Installation + +The development environment setup requires installation of following softwares: Review comment: Taken care 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
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16410808#comment-16410808 ] ASF GitHub Bot commented on CB-13400: - gandhirajan commented on a change in pull request #809: CB-13400: Added introduction to installation section URL: https://github.com/apache/cordova-docs/pull/809#discussion_r176638775 ## File path: doc/installing-a-development-environment.md ## @@ -87,6 +90,10 @@ Follow the instructions on [this site][linux_node]. Make is installed by default on 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]. + Review comment: Taken care 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
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16410804#comment-16410804 ] ASF GitHub Bot commented on CB-13400: - gandhirajan commented on a change in pull request #809: CB-13400: Added introduction to installation section URL: https://github.com/apache/cordova-docs/pull/809#discussion_r176638728 ## File path: doc/installing-a-development-environment.md ## @@ -121,6 +118,16 @@ 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. + Review comment: Taken care 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
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16410807#comment-16410807 ] ASF GitHub Bot commented on CB-13400: - gandhirajan commented on a change in pull request #809: CB-13400: Added introduction to installation section URL: https://github.com/apache/cordova-docs/pull/809#discussion_r176638768 ## File path: doc/installing-a-development-environment.md ## @@ -25,6 +27,13 @@ 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. + Review comment: Taken care 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
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16410802#comment-16410802 ] ASF GitHub Bot commented on CB-13400: - gandhirajan commented on a change in pull request #809: CB-13400: Added introduction to installation section URL: https://github.com/apache/cordova-docs/pull/809#discussion_r176638436 ## File path: doc/installing-a-development-environment.md ## @@ -1,5 +1,14 @@ ## Installing +### Introduction to Installation + +The development environment setup requires installation of following softwares: + +1. Ruby - Needs to be installed in order to install and use Jekyll. Jekyll helps in tranforming plain texts into static websites. Review comment: @dblotsky sounds good to me. Will make this change. 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
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16410266#comment-16410266 ] ASF GitHub Bot commented on CB-13400: - dblotsky commented on a change in pull request #809: CB-13400: Added introduction to installation section URL: https://github.com/apache/cordova-docs/pull/809#discussion_r176566470 ## File path: doc/installing-a-development-environment.md ## @@ -1,5 +1,14 @@ ## Installing +### Introduction to Installation Review comment: @gandhirajan what is the purpose of this section? 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
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16410271#comment-16410271 ] ASF GitHub Bot commented on CB-13400: - dblotsky commented on a change in pull request #809: CB-13400: Added introduction to installation section URL: https://github.com/apache/cordova-docs/pull/809#discussion_r176566246 ## File path: doc/installing-a-development-environment.md ## @@ -1,5 +1,14 @@ ## Installing +### Introduction to Installation + +The development environment setup requires installation of following softwares: + +1. Ruby - Needs to be installed in order to install and use Jekyll. Jekyll helps in tranforming plain texts into static websites. +1. Node.js - Needs to be installed in order to install all the required development and javascript dependencies. Review comment: How about: "Needed by the build tools." 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
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16410268#comment-16410268 ] ASF GitHub Bot commented on CB-13400: - dblotsky commented on a change in pull request #809: CB-13400: Added introduction to installation section URL: https://github.com/apache/cordova-docs/pull/809#discussion_r176565690 ## File path: doc/installing-a-development-environment.md ## @@ -1,5 +1,14 @@ ## Installing +### Introduction to Installation + +The development environment setup requires installation of following softwares: Review comment: Grammar: "of following softwares" -> "of the following software". 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
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16410273#comment-16410273 ] ASF GitHub Bot commented on CB-13400: - dblotsky commented on a change in pull request #809: CB-13400: Added introduction to installation section URL: https://github.com/apache/cordova-docs/pull/809#discussion_r176566425 ## File path: doc/installing-a-development-environment.md ## @@ -1,5 +1,14 @@ ## Installing +### Introduction to Installation + +The development environment setup requires installation of following softwares: + +1. Ruby - Needs to be installed in order to install and use Jekyll. Jekyll helps in tranforming plain texts into static websites. +1. Node.js - Needs to be installed in order to install all the required development and javascript dependencies. +1. Make - Can to be installed in order to build cordova website using Makefile. This installation is optional. +1. Python - Can to be installed in order to invoke simple HTTP server from Makefile. This installation is optional. Review comment: Grammar: "Can to be" -> "Can be". 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
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16410272#comment-16410272 ] ASF GitHub Bot commented on CB-13400: - dblotsky commented on a change in pull request #809: CB-13400: Added introduction to installation section URL: https://github.com/apache/cordova-docs/pull/809#discussion_r176566692 ## File path: doc/installing-a-development-environment.md ## @@ -87,6 +90,10 @@ Follow the instructions on [this site][linux_node]. Make is installed by default on 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]. + Review comment: Nitpick: extra line. 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
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16410267#comment-16410267 ] ASF GitHub Bot commented on CB-13400: - dblotsky commented on a change in pull request #809: CB-13400: Added introduction to installation section URL: https://github.com/apache/cordova-docs/pull/809#discussion_r176564891 ## File path: doc/installing-a-development-environment.md ## @@ -121,6 +118,16 @@ 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. + Review comment: Nitpick: extra empty line. 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
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16410269#comment-16410269 ] ASF GitHub Bot commented on CB-13400: - dblotsky commented on a change in pull request #809: CB-13400: Added introduction to installation section URL: https://github.com/apache/cordova-docs/pull/809#discussion_r176566070 ## File path: doc/installing-a-development-environment.md ## @@ -1,5 +1,14 @@ ## Installing +### Introduction to Installation + +The development environment setup requires installation of following softwares: + +1. Ruby - Needs to be installed in order to install and use Jekyll. Jekyll helps in tranforming plain texts into static websites. Review comment: How about: "Needed by Jekyll. Jekyll is the static site generator that generates the website and docs." 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
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16410270#comment-16410270 ] ASF GitHub Bot commented on CB-13400: - dblotsky commented on a change in pull request #809: CB-13400: Added introduction to installation section URL: https://github.com/apache/cordova-docs/pull/809#discussion_r176566579 ## File path: doc/installing-a-development-environment.md ## @@ -25,6 +27,13 @@ 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. + Review comment: Nitpick: extra empty line. 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
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16410150#comment-16410150 ] ASF GitHub Bot commented on CB-13400: - gandhirajan commented on issue #809: CB-13400: Added introduction to installation section URL: https://github.com/apache/cordova-docs/pull/809#issuecomment-375426563 @janpio Sure Jan. Will check out. Thanks for your time and support 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
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16410147#comment-16410147 ] ASF GitHub Bot commented on CB-13400: - janpio commented on issue #809: CB-13400: Added introduction to installation section URL: https://github.com/apache/cordova-docs/pull/809#issuecomment-375426094 From someone else. 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
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16410133#comment-16410133 ] ASF GitHub Bot commented on CB-13400: - gandhirajan commented on issue #809: CB-13400: Added introduction to installation section URL: https://github.com/apache/cordova-docs/pull/809#issuecomment-375423596 @janpio You mean from someone else other than you? or you wanna recheck once more? 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
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16410093#comment-16410093 ] ASF GitHub Bot commented on CB-13400: - gandhirajan commented on a change in pull request #809: CB-13400: Added introduction to installation section URL: https://github.com/apache/cordova-docs/pull/809#discussion_r176530766 ## File path: doc/installing-a-development-environment.md ## @@ -1,5 +1,17 @@ ## Installing +### Introduction to Installation + +The development environment setup requires installation of following softwares: + +1. Ruby - Needs to be installed in order to install and use Jekyll. Jekyll helps in tranforming plain texts into static websites. + +2. Node.js - Needs to be installed in order to install all the required development and javascript dependencies. + +3. Make - Can to be installed in order to build cordova website using Makefile. This installation is optional. + +4. Python - Can to be installed in order to invoke simple HTTP server from Makefile. This installation is optional. Review comment: @janpio agree with you Jan. Implemented and checked in. 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
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16410087#comment-16410087 ] ASF GitHub Bot commented on CB-13400: - janpio commented on a change in pull request #809: CB-13400: Added introduction to installation section URL: https://github.com/apache/cordova-docs/pull/809#discussion_r176530457 ## File path: doc/installing-a-development-environment.md ## @@ -1,5 +1,17 @@ ## Installing +### Introduction to Installation + +The development environment setup requires installation of following softwares: + +1. Ruby - Needs to be installed in order to install and use Jekyll. Jekyll helps in tranforming plain texts into static websites. + +2. Node.js - Needs to be installed in order to install all the required development and javascript dependencies. + +3. Make - Can to be installed in order to build cordova website using Makefile. This installation is optional. + +4. Python - Can to be installed in order to invoke simple HTTP server from Makefile. This installation is optional. Review comment: would make sense to match the order of "software" to the order here, right? especially if it is optional, it should not really be listed before a really required one, right? 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
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16410020#comment-16410020 ] ASF GitHub Bot commented on CB-13400: - gandhirajan commented on a change in pull request #809: CB-13400: Added introduction to installation section URL: https://github.com/apache/cordova-docs/pull/809#discussion_r176520424 ## File path: doc/installing-a-development-environment.md ## @@ -1,5 +1,17 @@ ## Installing +### Introduction to Installation + +The development environment setup requires installation of following softwares: + +1. Ruby - Needs to be installed in order to install and use Jekyll. Jekyll helps in tranforming plain texts into static websites. + +2. Node.js - Needs to be installed in order to install all the required development and javascript dependencies. + +3. Make - Can to be installed in order to build cordova website using Makefile. This installation is optional. + +4. Python - Can to be installed in order to invoke simple HTTP server from Makefile. This installation is optional. Review comment: @janpio you mean in OS specific installations, python should be last? 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
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16410014#comment-16410014 ] ASF GitHub Bot commented on CB-13400: - janpio commented on a change in pull request #809: CB-13400: Added introduction to installation section URL: https://github.com/apache/cordova-docs/pull/809#discussion_r176518975 ## File path: doc/installing-a-development-environment.md ## @@ -1,5 +1,17 @@ ## Installing +### Introduction to Installation + +The development environment setup requires installation of following softwares: + +1. Ruby - Needs to be installed in order to install and use Jekyll. Jekyll helps in tranforming plain texts into static websites. + +2. Node.js - Needs to be installed in order to install all the required development and javascript dependencies. + +3. Make - Can to be installed in order to build cordova website using Makefile. This installation is optional. + +4. Python - Can to be installed in order to invoke simple HTTP server from Makefile. This installation is optional. Review comment: python should probably also be sorted last in all the instructions below then, correct? 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
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16410003#comment-16410003 ] ASF GitHub Bot commented on CB-13400: - janpio commented on a change in pull request #809: CB-13400: Added introduction to installation section URL: https://github.com/apache/cordova-docs/pull/809#discussion_r176518756 ## File path: doc/installing-a-development-environment.md ## @@ -1,5 +1,17 @@ ## Installing +### Introduction to Installation + +The development environment setup requires installation of following softwares: + +1. Ruby - Needs to be installed in order to install and use Jekyll. Jekyll helps in tranforming plain texts into static websites. + +2. Node.js - Needs to be installed in order to install all the required development and javascript dependencies. Review comment: you can put `1.` in all lines, numbering will done automatically 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
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16410002#comment-16410002 ] ASF GitHub Bot commented on CB-13400: - janpio commented on a change in pull request #809: CB-13400: Added introduction to installation section URL: https://github.com/apache/cordova-docs/pull/809#discussion_r176518683 ## File path: doc/installing-a-development-environment.md ## @@ -1,5 +1,17 @@ ## Installing +### Introduction to Installation + +The development environment setup requires installation of following softwares: + +1. Ruby - Needs to be installed in order to install and use Jekyll. Jekyll helps in tranforming plain texts into static websites. + Review comment: get rid of the empty lines between list items 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
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16386681#comment-16386681 ] ASF GitHub Bot commented on CB-13400: - janpio closed pull request #802: CB-13400 Restructure and test "Installing" instructions(part b) - Categorizing installation steps according to OSes URL: https://github.com/apache/cordova-docs/pull/802 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 48f8a3151..5020839fe 100644 --- a/doc/installing-a-development-environment.md +++ b/doc/installing-a-development-environment.md @@ -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: @@ -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 @@ -90,6 +115,13 @@ Verify your Node.js installation by running: node --version npm --version + Verify make + +Verify your make installa
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16384748#comment-16384748 ] Gandhirajan commented on CB-13400: -- Correctness of "installing-a-development-environment.md" is taken care for mac as well. > 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) >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
[jira] [Commented] (CB-13400) Restructure and test "Installing" instructions
[ https://issues.apache.org/jira/browse/CB-13400?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16380536#comment-16380536 ] Gandhirajan commented on CB-13400: -- Correctness of "installing-a-development-environment.md" is taken care for windows. > 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) >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
