Skip to content

clarify Compose install prerequisites#4130

Merged
londoncalling merged 7 commits intodocker:masterfrom
londoncalling:compose-install-clarify
Aug 9, 2017
Merged

clarify Compose install prerequisites#4130
londoncalling merged 7 commits intodocker:masterfrom
londoncalling:compose-install-clarify

Conversation

@londoncalling
Copy link
Contributor

@londoncalling londoncalling commented Aug 9, 2017

What's changed

  • Re-organized topic to highlight that Docker Engine (server) is a prerequisite for Compose install
  • Provided more useful links
  • Changed from numbered lists to sections that call out Mac and Windows installs vs Linux

Related

#4126

Direct link to updated topic in Netlify preview

https://deploy-preview-4130--docker-docs-vnext-engine.netlify.com/compose/install/

Reviewers fyi

@mstanleyjones @barrystaes @shin- @dnephin

Signed-off-by: Victoria Binalas victoria.bialas@docker.com

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
Victoria Bialas added 3 commits August 9, 2017 11:55
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
## Prerequisites

1. Install Docker Engine:
You need to install Docker first, before you install and run Docker Compose.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Technically that is not true - you can install Compose without having Docker installed first. You'll need access to a Docker engine to do anything useful with Compose, but that engine could be installed on a remote server.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

okay thanks I'll try to clarify this


* [Windows installation](/docker-for-windows/index.md){: target="_blank" class="_"}
- On Linux systems, first install the
[Docker server](/engine/installation/index.md#server){: target="_blank" class="_"}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think "the Docker server" should just be "Docker" here (or maybe "the Docker engine", but I think we're deprecating that term now?)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shin- I think we are gently trying to deprecate it so I changed it to just "Docker"

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
Copy link

@mdlinville mdlinville left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One question and one nit, otherwise looking good!


* [Mac installation](/docker-for-mac/index.md){: target="_blank" class="_"}
- On desktop systems like Docker for Mac and Windows, Docker Compose is
included as part of those desktop installs. Skip down to [Install Compose on Linux systems](#install-compose-on-linux-systems).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why would you skip down to the Linux install section if you're on a desktop?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

arggh! :-) okay I'll fix it.

If so, your `/usr/local/bin` directory probably isn't writable and
you'll need to install Compose as the superuser. Run `sudo -i`, then
run the download and install commands below, then `exit`.
On **Linux**, you can download the Docker Compose binary from the [Compose

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: double space

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixing

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

1. Install Docker Engine:
Docker Compose relies on Docker Engine for any meaningful work, so make sure you
have Docker Engine installed either locally or remote, depending on your setup.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@shin- Okay I'm not sure if this is well-worded to convey the right thing, but let me know what you think.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think that's fine 👍

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yay! Here are some cute animal drawings.
animals

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
@londoncalling
Copy link
Contributor Author

Brilliant! Thanks everyone, the topic is much better now.

@londoncalling londoncalling merged commit 85d70ff into docker:master Aug 9, 2017
@londoncalling londoncalling deleted the compose-install-clarify branch August 18, 2017 04:52
shin- pushed a commit to shin-/docker.github.io that referenced this pull request Aug 19, 2017
* clarify Compose install prerequisites

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* organized install on Microsoft Server into steps

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* better highlighting and organization for the desktop systems section

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* copyedit for consistency

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* changed Docker server --> Docker per review

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* attempt to clarify Compose / Docker Engine dependencies per reviews

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>

* copyedits per reviews

Signed-off-by: Victoria Bialas <victoria.bialas@docker.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants