docs: Clarify the coala in a container docs #470

acashmkj · 2017-10-21T21:23:11Z

Added explanation for Docker.

Closes #30

For short term contributors: we understand that getting your commits well
defined like we require is a hard task and takes some learning. If you
look to help without wanting to contribute long term there's no need
for you to learn this. Just drop us a message and we'll take care of brushing
up your stuff for merge!

Checklist

I read the commit guidelines and I've followed
them.
I ran coala over my code locally. (All commits have to pass
individually. It is not sufficient to have "fixup commits" on your PR,
our bot will still report the issues for the previous commit.) You will
likely receive a lot of bot comments and build failures if coala does not
pass on every single commit!

After you submit your pull request, DO NOT click the 'Update Branch' button.
When asked for a rebase, consult coala.io/rebase
instead.

Please consider helping us by reviewing other peoples pull requests as well:

pick up any PR at https://coala.io/review
review it (check https://coala.io/reviewing for more info)
if you are sure that it needs work, use cobot mark wip <URL> to get it out
of the review queue.

The more you review, the more your score will grow at coala.io and we will
review your PRs faster!

IpshitaC

Hi! Could you please change the commit message to add a shortlog as a short description of your change as well?
Marking this wip.

acashmkj · 2017-10-23T07:40:51Z

@IpshitaC please review

khanchi97

Changes LGTM 👍

Makman2 · 2017-10-23T14:28:27Z

Users/Docker_Image.rst

+dependencies, and ship it all out as a single package.
+
+With the help of containers, the developer can rest assured that
+the application will run on other machine regardless of any


either

on another machine
or

on other machines

Would prefer 2nd 👍

Makman2 · 2017-10-23T14:28:42Z

Users/Docker_Image.rst

+dependencies, and ship it all out as a single package.
+
+With the help of containers, the developer can rest assured that
+the application will run on other machine regardless of any


Would prefer 2nd 👍

Makman2 · 2017-10-23T14:29:45Z

Users/Docker_Image.rst

+
+Unlike a virtual machine, rather than creating a whole virtual operating
+system, Docker allows applications to use the same kernel as the system
+that they're running on and only requires applications be shipped


be --> being

Makman2 · 2017-10-23T14:30:31Z

Users/Docker_Image.rst

+Whats is a Docker Image and how is it different from a container ?
+------------------------------------------------------------------
+
+Image is an immutable file and a running instance of an image is called a


--> An image

Makman2 · 2017-10-23T14:31:08Z

Users/Docker_Image.rst

+with things not already running on the host computer. This gives a
+significant performance boost and reduces the size of the application.
+
+Whats is a Docker Image and how is it different from a container ?


Makman2 · 2017-10-23T14:32:11Z

Users/Docker_Image.rst

+with things not already running on the host computer. This gives a
+significant performance boost and reduces the size of the application.
+
+Whats is a Docker Image and how is it different from a container ?


Redundant space before question mark

Makman2 · 2017-10-23T14:38:10Z

Users/Docker_Image.rst

+
+With the help of containers, the developer can rest assured that
+the application will run on other machine regardless of any
+customized settings that machine might have that could differ from the


maybe "that" --> "his" (the machine of the developer)

Makman2 · 2017-10-23T14:38:35Z

Users/Docker_Image.rst

+Image is an immutable file and a running instance of an image is called a
+container. Images are composed of layers of other images. Images are created
+when we run ``build`` command and conatiners are formed from these images
+when we use ``run`` command. There can be many containers for the


the run command

Makman2 · 2017-10-23T14:40:57Z

Users/Docker_Image.rst

+-----------------
+
+  Docker installation guide for various operating systems can be found
+  `here <https://docs.docker.com/engine/installation/>`__.


Redundant leading spaces

Makman2 · 2017-10-23T14:41:08Z

Users/Docker_Image.rst

+when we use ``run`` command. There can be many containers for the
+same image.
+
+  For more imformation about Docker see the


Again:
imnformation

Makman2 · 2017-10-23T14:41:41Z

Users/Docker_Image.rst

@@ -1,3 +1,44 @@
+What is Docker ?


redundant space before question mark

Makman2 · 2017-10-23T14:42:36Z

unack 1bb2d15

acashmkj · 2017-10-23T18:00:50Z

@Makman2 @IpshitaC please review

Makman2 · 2017-10-23T18:10:33Z

Users/Docker_Image.rst

+significant performance boost and reduces the size of the application.
+
+What is a Docker Image and how is it different from a container?
+------------------------------------------------------------------


dashes not aligned to title :) (two dashes too much)

Makman2 · 2017-10-23T18:11:21Z

Users/Docker_Image.rst

+------------------------------------------------------------------
+
+An image is an immutable file which contains required binaries and libraries
+needed to build a container and a running instance of an image is called


maybe
build --> make
to not confuse it with the build command of docker below.

or maybe just omit the part:
... needed ~~to build a container~~ and a running ...

Makman2 · 2017-10-23T18:16:41Z

Users/Docker_Image.rst

@@ -33,6 +72,9 @@ on your code with a ``.gitlab-ci.yml``, like this:
  For more information about GitLab CI configuration, consult the
  `official documentation <https://docs.gitlab.com/ce/ci/>`__.

+Downloading Docker images and pushing images over low bandwidth connections
+is very slow.


Okay my bad, it doesn't fit here nicely as well :3

However, I would actually rephrase it, to something like:

Docker images are usually very large. Downloading or pushing them over low bandwidth connections can be very slow.

What do you say? :)

And maybe we put it inside a note:: back into ""What is a docker image and how is it different from a container?"

@Makman2 yes I think we should put it back in What is a docker image section

acashmkj · 2017-10-23T18:37:56Z

@Makman2 @IpshitaC please review

Makman2 · 2017-10-24T15:13:27Z

Users/Docker_Image.rst

+.. note::
+
+  Downloading Docker images and pushing images over low bandwidth connections
+  is very slow.


What about

Docker images are usually very large. Downloading or pushing them over low bandwidth connections can be very slow.

instead? :)
your choice 👍

Agree with you. Done necessary changes

Added information about Docker Closes #30

acashmkj · 2017-10-24T16:13:51Z

@Makman2 please review

Makman2 · 2017-10-24T16:17:19Z

ack 5839e8d

Makman2 · 2017-10-24T16:17:53Z

@rultor merge

rultor · 2017-10-24T16:18:23Z

@rultor merge

@Makman2 OK, I'll try to merge now. You can check the progress of the merge here

rultor · 2017-10-24T16:20:10Z

@rultor merge

@Makman2 Done! FYI, the full log is here (took me 2min)

jayvdb · 2017-11-02T00:50:37Z

See #482

gitmate-bot added process/pending review size/XS area/documentation difficulty/low status/stale labels Oct 21, 2017

gitmate-bot assigned acashmkj Oct 21, 2017

gitmate-bot added status/stale and removed status/stale labels Oct 21, 2017

IpshitaC suggested changes Oct 22, 2017

View reviewed changes

co-robo added process/wip and removed process/pending review labels Oct 22, 2017

gitmate-bot added the process/pending review label Oct 23, 2017

khanchi97 approved these changes Oct 23, 2017

View reviewed changes

Makman2 reviewed Oct 23, 2017

View reviewed changes

Makman2 reviewed Oct 24, 2017

View reviewed changes

docs: Clarify the coala in a container docs

5839e8d

Added information about Docker Closes #30

gitmate-bot added process/approved and removed process/pending review labels Oct 24, 2017

rultor merged commit 5839e8d into coala:master Oct 24, 2017

gitmate-bot removed the process/approved label Oct 24, 2017

gitmate-bot added the process/approved label Oct 24, 2017

jayvdb mentioned this pull request Nov 2, 2017

Copyright violation in Users/Docker_Image.rst #482

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Clarify the coala in a container docs #470

docs: Clarify the coala in a container docs #470

acashmkj commented Oct 21, 2017

IpshitaC left a comment •

edited

Loading

acashmkj commented Oct 23, 2017

khanchi97 left a comment

Makman2 Oct 23, 2017

Makman2 Oct 23, 2017

Makman2 Oct 23, 2017

Makman2 Oct 23, 2017

Makman2 Oct 23, 2017

Makman2 Oct 23, 2017

Makman2 Oct 23, 2017

Makman2 Oct 23, 2017

Makman2 Oct 23, 2017

Makman2 Oct 23, 2017

Makman2 Oct 23, 2017

Makman2 Oct 23, 2017

Makman2 commented Oct 23, 2017

acashmkj commented Oct 23, 2017

Makman2 Oct 23, 2017

Makman2 Oct 23, 2017

Makman2 Oct 23, 2017

Makman2 Oct 23, 2017

acashmkj Oct 23, 2017

acashmkj commented Oct 23, 2017

Makman2 Oct 24, 2017

acashmkj Oct 24, 2017

acashmkj commented Oct 24, 2017

Makman2 commented Oct 24, 2017

Makman2 commented Oct 24, 2017

rultor commented Oct 24, 2017

rultor commented Oct 24, 2017

jayvdb commented Nov 2, 2017

docs: Clarify the coala in a container docs #470

docs: Clarify the coala in a container docs #470

Conversation

acashmkj commented Oct 21, 2017

Checklist

IpshitaC left a comment • edited Loading

Choose a reason for hiding this comment

acashmkj commented Oct 23, 2017

khanchi97 left a 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

Makman2 commented Oct 23, 2017

acashmkj commented Oct 23, 2017

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

acashmkj commented Oct 23, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

acashmkj commented Oct 24, 2017

Makman2 commented Oct 24, 2017

Makman2 commented Oct 24, 2017

rultor commented Oct 24, 2017

rultor commented Oct 24, 2017

jayvdb commented Nov 2, 2017

IpshitaC left a comment •

edited

Loading