Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Link getting started in readme to installation instructions #18438

Merged
merged 1 commit into from Dec 13, 2015

Conversation

bfirsh
Copy link
Contributor

@bfirsh bfirsh commented Dec 4, 2015

No description provided.

@thaJeztah
Copy link
Member

Should we point users to the Linux, Mac and Windows "getting started" guides? https://docs.docker.com/linux/started/, https://docs.docker.com/mac/started/, https://docs.docker.com/windows/started/

Or the install guides, which also feature Docker Toolbox; https://docs.docker.com/engine/installation/mac/, https://docs.docker.com/engine/installation/windows/, https://docs.docker.com/engine/installation/

There's a lot of overlap between those (getting started / installation guide)

@moxiegirl which one do you think is more appropriate?

Toolbox](https://www.docker.com/docker-toolbox). It is an installer for Mac OS X
and Windows that installs everything you need to build apps with Docker.

To install on Linux or on servers, check out the [full installation instructions
Copy link
Contributor

Choose a reason for hiding this comment

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

Toolbox is only intended for Mac and Windows, so I think this is misleading for users. The audience for the README on GitHub is expected to be more technical not less. So, I think we should point them here:

http://docs.docker.com/engine/installation/

@bfirsh bfirsh force-pushed the update-getting-started-in-readme branch from 1d77110 to 77e54df Compare December 9, 2015 14:27
@bfirsh bfirsh changed the title Add Toolbox to getting started section in readme Link getting started to installation instructions Dec 9, 2015
@bfirsh bfirsh changed the title Link getting started to installation instructions Link getting started in readme to installation instructions Dec 9, 2015
@bfirsh
Copy link
Contributor Author

bfirsh commented Dec 9, 2015

@thaJeztah @moxiegirl Updated with your comments. Thanks!

Linux systems, or as a VM on Windows, Mac and other systems.
Docker can be installed either on your computer for building applications or
on servers for running them. To get started, [check out the installation
instructions in the documentation](http://docs.docker.com/engine/installation/).
Copy link
Member

Choose a reason for hiding this comment

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

can you change this to https:// ?

@thaJeztah
Copy link
Member

One nit, but LGTM when fixed

Signed-off-by: Ben Firshman <ben@firshman.co.uk>
@bfirsh bfirsh force-pushed the update-getting-started-in-readme branch from 77e54df to 32402a7 Compare December 9, 2015 15:55
@bfirsh
Copy link
Contributor Author

bfirsh commented Dec 9, 2015

fixed!

@thaJeztah
Copy link
Member

Thanks!

ping @moxiegirl for a final look :)

moxiegirl pushed a commit that referenced this pull request Dec 13, 2015
Link getting started in readme to installation instructions
@moxiegirl moxiegirl merged commit 34e3831 into moby:master Dec 13, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants