Skip to content
This repository has been archived by the owner on Sep 26, 2021. It is now read-only.

First stage of splitting out #1490

Merged
merged 1 commit into from Jul 15, 2015
Merged

Conversation

moxiegirl
Copy link

Splitting out docs
Fixing location of help
entering in changes from testing

You can find an example of how it will look: http://docker-manthony.s3-website-us-east-1.amazonaws.com/

Individual files are easier to contribute to and manage than competing for a single large file.

Signed-off-by: Mary Anthony mary@docker.com

@moxiegirl
Copy link
Author

ping @aanand @nathanleclaire

$ docker-machine -v
machine version 0.3.0
```
Once you install Docker Machine, you can create and mangage machines. A very
Copy link

Choose a reason for hiding this comment

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

"mangage"

@aanand
Copy link

aanand commented Jul 8, 2015

This looks really good - I hadn't realised the Machine docs had gotten so big, so it's high time they were split out.

I think get-started-cloud.md and the driver pages could stand to be a bit more discoverable - I could only find one link to drivers/index.md, at the very bottom of the overview. I can see a lot of people wanting to immediately know what cloud providers are supported, or to find the page for their particular provider.

@moxiegirl
Copy link
Author

Thanks @aanand! Splitting the material out took more effort than I thought. The bulk of the single page was basically reference material, without any contextual how does this thing work.

Some of it I filled with the new section in the middle with the simple workflow. I think the base operating material needs better context as it associates to the providers/drivers. But I only have so much time so hopefully @ehazlett or @nathanleclaire will want to fill that in.

@moxiegirl
Copy link
Author

Filled in some more connective tissue.

@nathanleclaire
Copy link
Contributor

Will fill out comments as I review this.

The "install" link in the left sidebar (Install => Docker Machine) now is its own section, isn't that a little confusing? Or are Compose, Swarm, etc. going to move there as well?

dev virtualbox Stopped
my-docker-machine virtualbox Running tcp://192.168.99.100:2376
machine-2 virtualbox Running tcp://192.168.99.106:2376
machine-3 * virtualbox Running tcp://192.168.99.107:2376
Copy link
Contributor

Choose a reason for hiding this comment

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

The * is not aligned with the column correctly here

@nathanleclaire
Copy link
Contributor

Hm, it's really quite confusing to try and figure out where things have simply moved around and where the content has actually changed. In the future I'd appreciate it if we could do them in separate PRs, please (for this PR it's OK to keep how it is).

configures the Docker client to talk to them.
inside your own data center. It automatically creates hosts, installs Docker on
them, then configures the `docker` client to talk to them. A "machine" is the
combination of a Docker Host and a configured client.
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 casing of "Docker Host" implies it's some sort of special entity or concept, we should probably always case it as "Docker host".

@nathanleclaire
Copy link
Contributor

In the left-hand menu, under "Provision & set up Docker hosts", the links "Create multi-container applications" and "Cluster Docker containers" are there, but they just go to /machine/get-started-cloud, so I'm not sure what's up with that.

@nathanleclaire
Copy link
Contributor

"Adding a host without a driver" and the swarm section is included in the Getting Started Using a Cloud Provider section, which seems like a big misnomer (the swarm demo uses Virtualbox).


# Supported Docker Machine subcommands

* [active](active.md))
Copy link
Contributor

Choose a reason for hiding this comment

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

There's an extra ) here.

@nathanleclaire
Copy link
Contributor

The subcommands page is really difficult to find, I would expect it to be in the left sidebar. Same for the driver options pages - I'm not even sure how to navigate to them.

# Amazon Web Services
Create machines on [Amazon Web Services](http://aws.amazon.com). You will need
an Access Key ID, Secret Access Key and a VPC ID. To find the VPC ID, login to
the AWS console and go to Services -> VPC -> Your VPCs. Select the one where you
Copy link
Member

Choose a reason for hiding this comment

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

Just glancing over this; please check if -> is properly converted to -> in the generated docs

Copy link
Author

Choose a reason for hiding this comment

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

@thaJeztah seems to be:

image

@moxiegirl moxiegirl force-pushed the split-out-docs branch 2 times, most recently from 6b554f0 to 996252e Compare July 9, 2015 15:46
@moxiegirl
Copy link
Author

@nathanleclaire Regarding your comments on the menu, I'm not seeing the behavior you refer to. Are you using my staging bucket or a local build?

I didn't touch the Getting Started with a cloud provider material. It stands as it was. As you are already concerned with the breadth of this pr, we should save that until another one. It also makes sense as I don't have time to test that procedure at the moment.

@moxiegirl
Copy link
Author

Regarding listing the subcommands in the menu, all the reference is in the reference section and in lists:
image

Splitting out docs
Fixing location of help
entering in changes from testing
Filling in some missing structure
Updating with the comments from Nathan
Updating with the comments from Nathan
Updating after talk with Evan/Nathan

Signed-off-by: Mary Anthony <mary@docker.com>
@moxiegirl
Copy link
Author

ping @ehazlett @nathanleclaire incorporated changes from our discussion see my S3 Bucket for updates: http://docker-manthony.s3-website-us-east-1.amazonaws.com/

@nathanleclaire
Copy link
Contributor

Cool. Thanks for your persistence on this @moxiegirl

LGTM

nathanleclaire added a commit that referenced this pull request Jul 15, 2015
@nathanleclaire nathanleclaire merged commit e054d06 into docker:master Jul 15, 2015
@moxiegirl
Copy link
Author

Yay! Thanks guys for the help. Make sure you read that new middle section --- if you haven't. I think it is a good step. I didn't like any of my existing images for the material. Let me know if you have something better in a presentation I can steal. Otherwise, I'll have to get back to it after 1.8 with a cool image.

@ghost ghost mentioned this pull request Jul 17, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

7 participants