CB-13400: Added introduction to installation section #809

gandhirajan · 2018-03-22T14:44:23Z

This PR adds basic 'Introduction to Installation" section in 'Installing a development environment' page.

janpio · 2018-03-22T15:45:34Z

doc/installing-a-development-environment.md

+
+3. Node.js - Needs to be installed in order to install all the required development and javascript dependencies.
+
+4. Make - Needs to be installed in order to build cordova website using Makefile. This installation is optional.


If it is optional it is not "needed".

janpio · 2018-03-22T15:46:18Z

doc/installing-a-development-environment.md

+
+1. Ruby - Needs to be installed in order to install and use Jekyll. Jekyll helps in tranforming plain texts into static websites.
+
+2. Python - Needs to be installed in order to invoke simple HTTP server from Makefile.


If this is only needed for the "simple HTTP server from Makefile" then this is also optional (and should be moved down, after "Make")

janpio · 2018-03-22T18:02:54Z

doc/installing-a-development-environment.md

+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.
+


get rid of the empty lines between list items

janpio · 2018-03-22T18:03:08Z

doc/installing-a-development-environment.md

+
+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.


you can put 1. in all lines, numbering will done automatically

janpio · 2018-03-22T18:03:38Z

doc/installing-a-development-environment.md

+
+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.


python should probably also be sorted last in all the instructions below then, correct?

@janpio you mean in OS specific installations, python should be last?

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?

@janpio agree with you Jan. Implemented and checked in.

janpio

Looks good to me. Would prefer another review before merge though.

gandhirajan · 2018-03-22T19:07:36Z

@janpio You mean from someone else other than you? or you wanna recheck once more?

janpio · 2018-03-22T19:16:25Z

From someone else.

gandhirajan · 2018-03-22T19:17:58Z

@janpio Sure Jan. Will check out. Thanks for your time and support

dblotsky · 2018-03-22T20:38:53Z

doc/installing-a-development-environment.md

+    python --version
+
+The version must be 2.7.x.
+


Nitpick: extra empty line.

dblotsky · 2018-03-22T20:41:55Z

doc/installing-a-development-environment.md

@@ -1,5 +1,14 @@
 ## Installing

+### Introduction to Installation
+
+The development environment setup requires installation of following softwares:


Grammar: "of following softwares" -> "of the following software".

dblotsky · 2018-03-22T20:43:25Z

doc/installing-a-development-environment.md

+
+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.


How about: "Needed by Jekyll. Jekyll is the static site generator that generates the website and docs."

@dblotsky sounds good to me. Will make this change.

dblotsky · 2018-03-22T20:44:07Z

doc/installing-a-development-environment.md

+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.


How about: "Needed by the build tools."

@dblotsky I feel its too short and abstract. Any elaborations?
@janpio Your thoughts?

@janpio @dblotsky Should we elaborate it bit more or just say "Needed by the build tools"? If its clarified, we can close this PR

dblotsky · 2018-03-22T20:44:49Z

doc/installing-a-development-environment.md

+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.


Grammar: "Can to be" -> "Can be".

dblotsky · 2018-03-22T20:45:00Z

doc/installing-a-development-environment.md

@@ -1,5 +1,14 @@
 ## Installing

+### Introduction to Installation


@gandhirajan what is the purpose of this section?

@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.

the headline actually feels pretty redundant - the paragraph can just sit under Installing imo.

@janpio Taken care Jan.

dblotsky · 2018-03-22T20:45:21Z

doc/installing-a-development-environment.md

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


Nitpick: extra empty line.

dblotsky · 2018-03-22T20:45:43Z

doc/installing-a-development-environment.md

+#### 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].
+


Nitpick: extra line.

dblotsky · 2018-03-26T03:16:28Z

doc/installing-a-development-environment.md

+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.


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".

dblotsky · 2018-03-26T03:19:08Z

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


Nitpick: for consistency, this should also be Python (optional).

added introduction to installation section

76510c3

janpio reviewed Mar 22, 2018

View reviewed changes

implemented review comments

f3bccdc

gandhirajan changed the title ~~CB-13275: Added introduction to installation section~~ CB-13400: Added introduction to installation section Mar 22, 2018

janpio reviewed Mar 22, 2018

View reviewed changes

gandhirajan added 2 commits March 22, 2018 23:33

implemented review comments

9752999

implemented review comments

600e33b

janpio approved these changes Mar 22, 2018

View reviewed changes

dblotsky suggested changes Mar 22, 2018

View reviewed changes

gandhirajan added 2 commits March 23, 2018 10:26

implemented review comments

1058b98

implemented review comments

7a6de04

dblotsky approved these changes Mar 26, 2018

View reviewed changes

implemented review comments

b0d45a3

janpio merged commit e3be037 into apache:master Mar 26, 2018

gandhirajan deleted the gandhi-install-doc-updates branch March 28, 2018 17:28

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

CB-13400: Added introduction to installation section #809

CB-13400: Added introduction to installation section #809

gandhirajan commented Mar 22, 2018

janpio Mar 22, 2018

janpio Mar 22, 2018

janpio Mar 22, 2018

janpio Mar 22, 2018

janpio Mar 22, 2018

gandhirajan Mar 22, 2018

janpio Mar 22, 2018

gandhirajan Mar 22, 2018

janpio left a comment

gandhirajan commented Mar 22, 2018

janpio commented Mar 22, 2018

gandhirajan commented Mar 22, 2018

dblotsky Mar 22, 2018

gandhirajan Mar 23, 2018

dblotsky Mar 22, 2018

gandhirajan Mar 23, 2018

dblotsky Mar 22, 2018

gandhirajan Mar 23, 2018

dblotsky Mar 22, 2018

gandhirajan Mar 23, 2018

gandhirajan Mar 25, 2018

dblotsky Mar 22, 2018

gandhirajan Mar 23, 2018

dblotsky Mar 22, 2018

gandhirajan Mar 23, 2018

janpio Mar 23, 2018

gandhirajan Mar 25, 2018

dblotsky Mar 22, 2018

gandhirajan Mar 23, 2018

dblotsky Mar 22, 2018

gandhirajan Mar 23, 2018

dblotsky Mar 26, 2018

dblotsky Mar 26, 2018


		3. Node.js - Needs to be installed in order to install all the required development and javascript dependencies.

		4. Make - Needs to be installed in order to build cordova website using Makefile. This installation is optional.


		1. Ruby - Needs to be installed in order to install and use Jekyll. Jekyll helps in tranforming plain texts into static websites.

		2. Python - Needs to be installed in order to invoke simple HTTP server from Makefile.

		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. 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.

		@@ -1,5 +1,14 @@
		## Installing

		### Introduction to Installation


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

		#### 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].

		@@ -87,6 +86,9 @@ Follow the instructions on [this site][linux_node].

		Make is installed by default on Linux.

		#### Python

CB-13400: Added introduction to installation section #809

CB-13400: Added introduction to installation section #809

Conversation

gandhirajan commented Mar 22, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

janpio left a comment

Choose a reason for hiding this comment

gandhirajan commented Mar 22, 2018

janpio commented Mar 22, 2018

gandhirajan commented Mar 22, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment