Setup: Add docker alias to docker docs #359

alexandru-georgescu · 2016-12-17T11:47:18Z

Its added a new line with a alias comand.

Closes http:https://docs.coala.io/en/latest/Users/Docker_Image.html

gitmate-bot · 2016-12-17T11:47:30Z

Thanks for your contribution!

Reviewing pull requests take really a lot of time and we're all volunteers. Please make sure you go through the following check list and complete them all before pinging someone for a review.

I have rebased properly. Please see this for a tutorial.
I have gone through the commit guidelines and I've followed them:
I have followed the guidelines for the commit shortlog.
I have followed the guidelines for the commit body.
I have included the issue URL.
I have used the Fixes keyword if the commit fixes a real bug and the Closes keyword if it adds a feature/enhancement. See more here.
I have run all the tests and they all pass. That includes that all CI (below) is green - if GitMate issues appear you will have to amend your commits, pushing new commits on top is not sufficient!

As you learn things over your Pull Request please help others on the chat and on PRs to get their stuff right as well!

sims1253 · 2016-12-17T11:49:45Z

does it work with the linebreak?

andreidinu · 2016-12-17T11:50:41Z

You have to put a link to the issue not to the docs.

jayvdb · 2016-12-17T12:10:17Z

This needs to add a new paragraph of text and new code block

sils · 2016-12-17T13:03:50Z

Users/Docker_Image.rst

@@ -11,6 +11,13 @@ on your code in the working directory, like this:

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

+Or you cand use only coala cammand with:


sils · 2016-12-17T13:04:15Z

Users/Docker_Image.rst

+::
+
+ alias coala="docker run -ti -v \`pwd\`:/app --workdir=/app coala/base
+ coala"


rather keep it in one line?

gitmate-bot · 2016-12-17T13:16:13Z

Users/Docker_Image.rst

+
+::
+
+ alias coala="docker run -ti -v \`pwd\`:/app --workdir=/app coala/base coala"


Line is longer than allowed. (80 > 79)

LineLengthBear, severity NORMAL, section docs.

sils · 2016-12-17T14:38:36Z

Users/Docker_Image.rst

@@ -11,6 +11,12 @@ on your code in the working directory, like this:

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

+Or you can use only coala cammand with:


also the sentence doesn't sound grammarly complete

sils · 2016-12-17T14:38:55Z

Users/Docker_Image.rst

+
+::
+
+ alias coala="docker run -ti -v \`pwd\`:/app --workdir=/app coala/base coala"


missing indentation

userzimmermann · 2016-12-17T13:30:11Z

Users/Docker_Image.rst

@@ -11,6 +11,12 @@ on your code in the working directory, like this:

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

+Or you can use only coala cammand with:


Typo: cammand --> command

It should also be shortly mentioned what an alias is and to what kind of shells this applies to.

Mixih · 2016-12-17T16:56:19Z

Users/Docker_Image.rst

@@ -11,6 +11,16 @@ on your code in the working directory, like this:

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

+In some computer operating systems and programming languages,
+an alias is an alternative and usually easier-to-understand or 
+more significant name for a defined data object.


Please specify which shell alias syntax you are using here(I think it's bash syntax).

Mixih · 2016-12-17T16:57:20Z

Users/Docker_Image.rst

+an alias is an alternative and usually easier-to-understand or 
+more significant name for a defined data object.
+
+You can use only coala command with:


This sentence is rather confusing. I think what you meant to say was "To run coala from docker using only the coala command, you can use:"

Its added a new line with a alias command. Closes coala#358

jayvdb · 2016-12-17T18:32:05Z

Users/Docker_Image.rst

+
+::
+
+ alias coala="docker run -ti -v \`pwd\`:/app --workdir=/app coala/base coala"


not indented correctly. See other use of :: in this file.

Also, do not use backticks around pwd. Use $(pwd)

actually it's important that you don't use $(pwd) because if you do, it'll be evaluated when you set the alias and not when you execute it!

sils · 2016-12-18T11:34:54Z

Users/Docker_Image.rst

+::
+
+ alias coala="docker run -ti -v \`pwd\`:/app --workdir=/app coala/base coala"
+


we should have a note or so that the alias won't work nicely when using -c or -F

gitmate-bot · 2016-12-25T00:39:09Z