README.md: Modify steps of Usage #700

sanchit48 · 2019-01-26T09:09:59Z

Closes #477

budukhyash

The modifications are good.Just suggesting a minor change in the commit body.

This modifies the steps required for the
usage of the repository .

Replacing "usage of the repository" with building project website or something similar to it would make more sense according to me.

sanchit48 · 2019-01-26T09:52:38Z

@budukhyash plz review.

TravisBuddy · 2019-01-26T09:54:38Z

Travis tests have failed

Hey @sanchit48,
Please read the following log in order to understand the failure reason.
It'll be awesome if you fix what's wrong and commit the changes.

Ruby: 2.5.1

View build log

docker run -v=$(pwd):/app --workdir=/app coala/base coala --ci

Unable to find image 'coala/base:latest' locally
latest: Pulling from coala/base
















Digest: sha256:125d6cf24929d39db47b3ccd83d6ed1b6a231fc7e8afbf70bc4b5bd87653b0ff
Status: Downloaded newer image for coala/base:latest
Executing section global...
[ERROR][09:54:26] The bear InvalidLinkBear does not fulfill all requirements. You are not connected to the internet.
Executing section commit...
Executing section linecount...
Executing section filenames...
Executing section markdown_filenames...
Executing section spacing...
Executing section html...
Executing section yml...
Executing section new_linelength_projects...
Executing section old_linelength_projects...
Executing section cli...
nothing changed, not updating cache


Done. Your build exited with 1.

TravisBuddy Request Identifier: 62363210-2150-11e9-af85-47c84d506d52

frextrite · 2019-01-26T18:28:36Z

README.md

@@ -29,9 +29,13 @@ Why?

 ## Usage

-To clone the repository and run this website on your local machine, [install Jekyll](https://jekyllrb.com/docs/installation/) for your OS and type the following commands:
+To clone the repository and run this website on your local machine, install
+[Jekyll](https://jekyllrb.com/docs/installation/) and [rbenv](https://www.digitalocean.comcommunity/tutorials/how-to-install-ruby-on-rails)


I don't think it's a good idea to link an external installation guide to install anything. The official installation guide for rbenv should be linked here.

@frextrite I actually can't find the official installation guide for rbnev but i did find it's github repo. plz check if it's ok https://github.com/rbenv/rbenv#basic-github-checkout

That should work. Please consult other reviewers as well.

@li-boxuan @utkarsh2102 @shashank-b @akshatkarani plz review

While we are doing this, lets switch to @asdf-vm , which wraps rbenv and others. And they have a moderately sane website at https://asdf-vm.github.io/asdf/#/ . Iit should work ok on windows even, and ive added asdf-vm/asdf#450 to add CI for that.

Anmolbansal1

LGTM 👍

jayvdb · 2019-01-31T08:10:00Z

README.md

@@ -29,9 +29,13 @@ Why?

 ## Usage

-To clone the repository and run this website on your local machine, [install Jekyll](https://jekyllrb.com/docs/installation/) for your OS and type the following commands:
+To clone the repository and run this website on your local machine, install
+[Jekyll](https://jekyllrb.com/docs/installation/) and [rbenv](https://www.digitalocean.comcommunity/tutorials/how-to-install-ruby-on-rails)


While we are doing this, lets switch to @asdf-vm , which wraps rbenv and others. And they have a moderately sane website at https://asdf-vm.github.io/asdf/#/ . Iit should work ok on windows even, and ive added asdf-vm/asdf#450 to add CI for that.

TravisBuddy · 2019-01-31T12:08:34Z

Travis tests have failed

Hey @sanchit48,
Please read the following log in order to understand the failure reason.
It'll be awesome if you fix what's wrong and commit the changes.

Ruby: 2.5.1

View build log

docker run -v=$(pwd):/app --workdir=/app coala/base coala --ci

Unable to find image 'coala/base:latest' locally
latest: Pulling from coala/base
















Digest: sha256:125d6cf24929d39db47b3ccd83d6ed1b6a231fc7e8afbf70bc4b5bd87653b0ff
Status: Downloaded newer image for coala/base:latest
Executing section global...
[ERROR][12:08:21] The bear InvalidLinkBear does not fulfill all requirements. You are not connected to the internet.
Executing section commit...
Executing section linecount...
Executing section filenames...
Executing section markdown_filenames...
Executing section spacing...
|    | [NORMAL] SpaceConsistencyBear:
|    | Line contains following spacing inconsistencies:
|    | - Trailing whitespaces.
|----|    | /app/README.md
|    |++++| /app/README.md
|  32|  32| To clone the repository and run this website on your local machine, install
|  33|  33| [asdf-vm](https://asdf-vm.github.io/asdf/#/core-manage-asdf-vm) for your OS and now using asdf-vm,
|  34|  34| install [ruby](https://github.com/asdf-vm/asdf-ruby) and type the following commands:
|  35|    |-    
|    |  35|+
|  36|  36|     $ gem install jekyll bundler
|  37|  37|     $ git clone https://github.com/coala/projects.git
|  38|  38|     $ cd projects
[INFO][12:08:23] Applied 'ShowPatchAction' on 'README.md' from 'SpaceConsistencyBear'.
|    | [NORMAL] SpaceConsistencyBear:
|    | Line contains following spacing inconsistencies:
|    | - Trailing whitespaces.
|----|    | /app/data/locale/en/README.md
|    |++++| /app/data/locale/en/README.md
|  32|  32| To clone the repository and run this website on your local machine, install
|  33|  33| [asdf-vm](https://asdf-vm.github.io/asdf/#/core-manage-asdf-vm) for your OS and now using asdf-vm,
|  34|  34| install [ruby](https://github.com/asdf-vm/asdf-ruby) and type the following commands:
|  35|    |-    
|    |  35|+
|  36|  36|     $ gem install jekyll bundler
|  37|  37|     $ git clone https://github.com/coala/projects.git
|  38|  38|     $ cd projects
[INFO][12:08:23] Applied 'ShowPatchAction' on 'data/locale/en/README.md' from 'SpaceConsistencyBear'.
Executing section html...
Executing section yml...
Executing section new_linelength_projects...
Executing section old_linelength_projects...
Executing section cli...

TravisBuddy Request Identifier: ec09d6f0-2550-11e9-8e3a-a568437420b3

sanchit48 · 2019-01-31T13:01:41Z

@jayvdb plz review

KVGarg · 2019-02-01T10:47:04Z

README.md

-To clone the repository and run this website on your local machine, [install Jekyll](https://jekyllrb.com/docs/installation/) for your OS and type the following commands:
-
-    $ sudo gem install jekyll bundler
+To clone the repository and run this website on your local machine, install


Reading the first line, creates a thought that for cloning this repository we need to install asdf-vm. Possibly you can divide this into two sections - asdf-vm & ruby installation and cloning and running

@KVGarg I agree with you but in the original README.md they asked to install Jekyll with the first line. So maybe they thought it won't create the confusion. What do you think?

In original README.md also, it is creating a confusion too. Now, also it's ok but it is creating some confusion. Don't know about others. Aren't you getting confused ?

yeah, it does creates the confusion. i will change it.

sanchit48 · 2019-02-01T13:00:45Z

@KVGarg plz review

KVGarg · 2019-02-01T13:11:10Z

README.md

-    $ sudo gem install jekyll bundler
+Install [asdf-vm](https://asdf-vm.github.io/asdf/#/core-manage-asdf-vm) for your OS and now using asdf-vm, install [ruby](https://github.com/asdf-vm/asdf-ruby).
+
+### Cloning and running


I used cloning and running because at that time, I didn't get the right word in my mind.
Can we have something more appropriate that describe this section better in two or three words ? IDK whether this will fit to this Build and Developement, if you have better words that can describe this section go with that. Because I am myself doubtful with my suggestion. But something diff. from Cloning and Running
Else everything perfect 👍

ok i will see :)

frextrite · 2019-02-01T13:33:21Z

README.md


-    $ sudo gem install jekyll bundler
+Install [asdf-vm](https://asdf-vm.github.io/asdf/#/core-manage-asdf-vm) for your OS and now using asdf-vm, install [ruby](https://github.com/asdf-vm/asdf-ruby).


Better to break them into 2 points. And since the 2nd point is dependent on the first, number them.

Dependencies: 1. asdf-vm(for installing ruby easily) 2. ruby

But this way we are forcing the developer to install ruby via asdf. I am not sure if that is a good thing or not. Personally, I agree that using scripts makes the installation easier, but these scripts tend to break a lot, and thus prefer a more extensive manual installation.

@frextrite don't know much about that, i was just going according to #700 (comment)

frextrite · 2019-02-01T13:38:51Z

README.md

-    $ sudo gem install jekyll bundler
+Install [asdf-vm](https://asdf-vm.github.io/asdf/#/core-manage-asdf-vm) for your OS and now using asdf-vm, install [ruby](https://github.com/asdf-vm/asdf-ruby).
+
+### Cloning and running


Maybe rename this to Download and Run?

@frextrite but we are not downloading anything. should I use Clone and Run ?

sanchit, go with Clone and Run as clone itself refers to create a copy of repository on your local desktop by downloading it.

Yep Clone and Run works.

frextrite · 2019-02-01T13:46:10Z

README.md

+
+### Cloning and running
+
+To clone the repository and run this website on your local machine, type the following commands:


Instead of this, infom the user to clone the repository followed by the clone command.

Clone the coala Projects repository git clone <link to repository>

and then the steps to run the website

Run coala Projects website $ cmd1 $ cmd2

Clone the coala Projects repository

I think To clone the repository, type the following command would look much better.

I will go with, frexrite. Since, both of them have same meaning but it will convey the meaning in less words in impactful manner

frextrite · 2019-02-01T13:48:40Z

README.md

+
+To clone the repository and run this website on your local machine, type the following commands:
+
+    $ gem install jekyll bundler


Move this somewhere before cloning the repository and after the dependency section, ideally it should be in the dependency section.

Can you plz tell how can i do that like should i make point no. 3 and just write the command ?

Split dependencies section in points, this will create 3 points in the section.

for installing asdf-vm

for installing ruby

for jekyll and bundler

sanchit48 · 2019-02-02T14:05:47Z

@KVGarg plz review

frextrite · 2019-02-02T14:10:40Z

README.md

-    $ sudo gem install jekyll bundler
+1. Install [asdf-vm](https://asdf-vm.github.io/asdf/#/core-manage-asdf-vm) for your OS.
+2. Using asdf-vm, install [ruby](https://github.com/asdf-vm/asdf-ruby).
+3. Install jekyll bundler by typing the following command:


I think(no idea of ruby) jekyll and bundler are 2 gems. In that case add an and between the two and preferably bold them.

@frextrite plz see https://jekyllrb.com/docs/. Here the command gem install jekyll bundler is given

He is trying to say, that where you have writtem Install jekyll nundler there you should write Install jekyll and bundler gems

and try to ommit by typing the following command. It is self-explanatory to user that he has to run this command in the terminal

ohh ok, got it 😅

According to the site Jekyll and Bundler are gems, so you can edit this line to just Install Jekyll by typing ...

I agree with @KVGarg. Omitting by typing the following command would be better.

frextrite · 2019-02-02T14:11:29Z

README.md

@@ -29,15 +29,26 @@ Why?

 ## Usage

-To clone the repository and run this website on your local machine, [install Jekyll](https://jekyllrb.com/docs/installation/) for your OS and type the following commands:
+#### Dependencies


Make this h3

frextrite · 2019-02-02T14:11:37Z

README.md

+
+        $ gem install jekyll bundler
+
+#### Clone and Run


This as well.

frextrite · 2019-02-02T14:12:11Z

README.md

+
+#### Clone and Run
+
+Clone the coala Projects repository


frextrite · 2019-02-02T15:01:03Z

Take a look at this and make the CI happy :)

sanchit48 · 2019-02-02T15:06:12Z

Take a look at this and make the CI happy :)

Done. plz review :D
Unable to make the CI happy. The reason is this, similar to the issue you opened earlier i guess

This modifies the steps required to build and run the website on the local machine by suggesting not to use sudo in the command to install jekyll and bundler and prefer asdf-vm to install ruby. Closes #477

TravisBuddy · 2019-02-04T18:11:16Z

Travis tests have failed

Hey @sanchit48,
Please read the following log in order to understand the failure reason.
It'll be awesome if you fix what's wrong and commit the changes.

Ruby: 2.5.1

View build log

docker run -v=$(pwd):/app --workdir=/app coala/base coala --ci

Unable to find image 'coala/base:latest' locally
latest: Pulling from coala/base
















Digest: sha256:125d6cf24929d39db47b3ccd83d6ed1b6a231fc7e8afbf70bc4b5bd87653b0ff
Status: Downloaded newer image for coala/base:latest
Executing section global...
[ERROR][18:11:04] The bear InvalidLinkBear does not fulfill all requirements. You are not connected to the internet.
Executing section commit...
Executing section linecount...
Executing section filenames...
Executing section markdown_filenames...
Executing section spacing...
|    | [NORMAL] SpaceConsistencyBear:
|    | Line contains following spacing inconsistencies:
|    | - Trailing whitespaces.
|----|    | /app/README.md
|    |++++| /app/README.md
|  34|  34| 1. Install [asdf-vm](https://asdf-vm.github.io/asdf/#/core-manage-asdf-vm) for your OS.
|  35|  35| 2. Using asdf-vm, install [ruby](https://github.com/asdf-vm/asdf-ruby).
|  36|  36| 3. Install Jekyll
|  37|    |-    
|    |  37|+
|  38|  38|         $ gem install jekyll bundler
|  39|  39| 
|  40|  40| ### Clone and Run
|    | [NORMAL] SpaceConsistencyBear:
|    | Line contains following spacing inconsistencies:
|    | - Trailing whitespaces.
|----|    | /app/README.md
|    |++++| /app/README.md
|  40|  40| ### Clone and Run
|  41|  41| 
|  42|  42| Clone coala Projects repository
|  43|    |-    
|    |  43|+
|  44|  44|     $ git clone https://github.com/coala/projects.git
|  45|  45|     
|  46|  46| Run coala Projects website
|    | [NORMAL] SpaceConsistencyBear:
|    | Line contains following spacing inconsistencies:
|    | - Trailing whitespaces.
|----|    | /app/README.md
|    |++++| /app/README.md
|  42|  42| Clone coala Projects repository
|  43|  43|     
|  44|  44|     $ git clone https://github.com/coala/projects.git
|  45|    |-    
|    |  45|+
|  46|  46| Run coala Projects website
|  47|  47| 
|  48|  48|     $ cd projects
[INFO][18:11:06] Applied 'ShowPatchAction' on 'README.md' from 'SpaceConsistencyBear'.
[INFO][18:11:06] Applied 'ShowPatchAction' on 'README.md' from 'SpaceConsistencyBear'.
[INFO][18:11:06] Applied 'ShowPatchAction' on 'README.md' from 'SpaceConsistencyBear'.
|    | [NORMAL] SpaceConsistencyBear:
|    | Line contains following spacing inconsistencies:
|    | - Trailing whitespaces.
|----|    | /app/data/locale/en/README.md
|    |++++| /app/data/locale/en/README.md
|  34|  34| 1. Install [asdf-vm](https://asdf-vm.github.io/asdf/#/core-manage-asdf-vm) for your OS.
|  35|  35| 2. Using asdf-vm, install [ruby](https://github.com/asdf-vm/asdf-ruby).
|  36|  36| 3. Install Jekyll
|  37|    |-    
|    |  37|+
|  38|  38|         $ gem install jekyll bundler
|  39|  39| 
|  40|  40| ### Clone and Run
[INFO][18:11:06] Applied 'ShowPatchAction' on 'data/locale/en/README.md' from 'SpaceConsistencyBear'.
|    | [NORMAL] SpaceConsistencyBear:
|    | Line contains following spacing inconsistencies:
|    | - Trailing whitespaces.
|----|    | /app/data/locale/en/README.md
|    |++++| /app/data/locale/en/README.md
|  40|  40| ### Clone and Run
|  41|  41| 
|  42|  42| Clone coala Projects repository
|  43|    |-    
|    |  43|+
|  44|  44|     $ git clone https://github.com/coala/projects.git
|  45|  45|     
|  46|  46| Run coala Projects website
[INFO][18:11:06] Applied 'ShowPatchAction' on 'data/locale/en/README.md' from 'SpaceConsistencyBear'.
|    | [NORMAL] SpaceConsistencyBear:
|    | Line contains following spacing inconsistencies:
|    | - Trailing whitespaces.
|----|    | /app/data/locale/en/README.md
|    |++++| /app/data/locale/en/README.md
|  42|  42| Clone coala Projects repository
|  43|  43|     
|  44|  44|     $ git clone https://github.com/coala/projects.git
|  45|    |-    
|    |  45|+
|  46|  46| Run coala Projects website
|  47|  47| 
|  48|  48|     $ cd projects
[INFO][18:11:06] Applied 'ShowPatchAction' on 'data/locale/en/README.md' from 'SpaceConsistencyBear'.
Executing section html...
Executing section yml...
Executing section new_linelength_projects...
Executing section old_linelength_projects...
Executing section cli...

TravisBuddy Request Identifier: 40e8b4c0-28a8-11e9-892f-216a8a2cc0ab

jayvdb · 2019-02-05T06:44:46Z

ack 0aee8f7

jayvdb · 2019-02-05T06:45:05Z

@gitmate-bot ff

gitmate-bot · 2019-02-05T06:45:07Z

Hey! I'm GitMate.io! This pull request is being fastforwarded automatically. Please DO NOT push while fastforward is in progress or your changes would be lost permanently ⚠️

gitmate-bot · 2019-02-05T06:46:12Z

Automated fastforward with GitMate.io was successful! 🎉

KVGarg · 2019-02-07T20:50:27Z

@jayvdb @sanchit48 CI wasn't green before getting merged due to which other PR's CI is also getting red because of failed tests over this PR.
Sanchit, please take care of this thing :-)

gitmate-bot added size/XS difficulty/newcomer labels Jan 26, 2019

gitmate-bot assigned sanchit48 Jan 26, 2019