diff --git a/CHANGES.md b/CHANGES.md index 7332b37e3a..34fcf680a1 100644 --- a/CHANGES.md +++ b/CHANGES.md @@ -44,7 +44,7 @@ Core Stability and Driver Updates - SSH keys persistent across reboots - Stop now gracefully stops VM - vCPUs now match host CPUs -- Softlayer +- SoftLayer - Fixed provision bug where `curl` was not present - VirtualBox - Correct power operations with Saved VM state diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 77c42ba9d5..8cb49984fd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -33,7 +33,7 @@ compilation by overriding the default argument that the build script passes to [gox](https://github.com/mitchellh/gox). This is very useful if you want to iterate quickly on a new feature, bug fix, etc. -For instance, if you only want to compile for use on OSX with the x86_64 arch, +For instance, if you only want to compile for use on OS X with the x86_64 arch, run: $ script/build -osarch="darwin/amd64" @@ -66,7 +66,7 @@ the code that you have added or modified in the same pull request. ## Code Coverage Machine includes a script to check for missing `*_test.go` files and to generate -an [HTML-based repesentation of which code is covered by tests](http://blog.golang.org/cover#TOC_5.). +an [HTML-based representation of which code is covered by tests](http://blog.golang.org/cover#TOC_5.). To run the code coverage script, execute: diff --git a/ROADMAP.md b/ROADMAP.md index 5c1be4a0f8..f9d367fb6f 100644 --- a/ROADMAP.md +++ b/ROADMAP.md @@ -6,7 +6,7 @@ environments. This is not a simple task -- production is inherently far more complex than development -- but there are three things which are big steps towards that goal: -**client/server achitecture**, **swarm integration** and **flexible +**client/server architecture**, **swarm integration** and **flexible provisioning**. (Note: this document is a high-level overview of where we are taking Machine. @@ -20,7 +20,7 @@ Currently there are only a few things that can be configured in the Docker Engin Currently both Machine and Boot2Docker provider similar functionality. This will enable users to migrate from boot2docker to machine. ### Expand Provisioner -Machine currently supports running Boot2Docker for "local" providers and Ubuntu for "remote" providers. This will expand the provisioning capabilities to include other base operating systems such as RedHat like distributions and possibly other "just enough" operating systems. +Machine currently supports running Boot2Docker for "local" providers and Ubuntu for "remote" providers. This will expand the provisioning capabilities to include other base operating systems such as Red Hat-like distributions and possibly other "just enough" operating systems. ### Windows Experience Currently, the Machine on Windows experience is not as good as the Mac / Linux. There is no "recommended" path to use Machine and there are several inconsistencies on Windows such as logging and output formatting. diff --git a/docs/index.md b/docs/index.md index 80f0e28d72..0f485fbe3c 100644 --- a/docs/index.md +++ b/docs/index.md @@ -39,7 +39,7 @@ For more information and resources, please visit ## Installation -Docker Machine is supported on Windows, OSX, and Linux and is installable as one +Docker Machine is supported on Windows, OS X, and Linux and is installable as one standalone binary. The links to the binaries for the various platforms and architectures are below: @@ -1004,7 +1004,7 @@ A file created remotely! Files are copied recursively by default (`scp`'s `-r` flag). -In the case of transfering files from machine to machine, they go through the +In the case of transferring files from machine to machine, they go through the local host's filesystem first (using `scp`'s `-3` flag). #### start @@ -1227,7 +1227,7 @@ Environment variables and default values: | `--google-auth-token` | `GOOGLE_AUTH_TOKEN` | - | | `--google-scopes` | `GOOGLE_SCOPES` | `devstorage.read_only,logging.write` | | `--google-disk-size` | `GOOGLE_DISK_SIZE` | `10` | -| `--google-disk-type` | `GOOGLE_DISK_TYPE` | `pd-statdard` | +| `--google-disk-type` | `GOOGLE_DISK_TYPE` | `pd-standard` | #### IBM Softlayer Create machines on [Softlayer](http://softlayer.com). @@ -1242,7 +1242,7 @@ Options: - `--softlayer-user`: **required** Username for your SoftLayer account, api key needs to match this user. - `--softlayer-api-key`: **required** API key for your user account. - `--softlayer-region`: SoftLayer region. - - `--softlayer-cpu`: Number of CPU's for the machine. + - `--softlayer-cpu`: Number of CPUs for the machine. - `--softlayer-hostname`: Hostname for the machine. - `--softlayer-domain`: **required** Domain name for the machine. - `--softlayer-api-endpoint`: Change SoftLayer API endpoint. @@ -1369,10 +1369,10 @@ Options: - `--openstack-insecure`: Explicitly allow openstack driver to perform "insecure" SSL (https) requests. The server's certificate will not be verified against any certificate authorities. This option should be used with caution. - `--openstack-domain-name` or `--openstack-domain-id`: Domain to use for authentication (Keystone v3 only) - - `--openstack-username`: User identifer to authenticate with. + - `--openstack-username`: User identifier to authenticate with. - `--openstack-password`: User password. It can be omitted if the standard environment variable `OS_PASSWORD` is set. - `--openstack-tenant-name` or `--openstack-tenant-id`: Identify the tenant in which the machine will be created. - - `--openstack-region`: The region to work on. Can be omitted if there is ony one region on the OpenStack. + - `--openstack-region`: The region to work on. Can be omitted if there is only one region on the OpenStack. - `--openstack-endpoint-type`: Endpoint type can be `internalURL`, `adminURL` on `publicURL`. If is a helper for the driver to choose the right URL in the OpenStack service catalog. If not provided the default id `publicURL` - `--openstack-net-name` or `--openstack-net-id`: Identify the private network the machine will be connected on. If your OpenStack project project contains only one private network it will be use automatically. @@ -1597,7 +1597,7 @@ Options: - `--exoscale-disk-size`: Disk size for the host in GB. - `--exoscale-image`: exoscale disk size. (10, 50, 100, 200, 400) - `--exoscale-security-group`: Security group. It will be created if it doesn't exist. - - `--exoscale-availability-zone`: exoscale availibility zone. + - `--exoscale-availability-zone`: exoscale availability zone. - `--exoscale-keypair`: exoscale keypair name. If a custom security group is provided, you need to ensure that you allow TCP ports 22 and 2376 in an ingress rule.