README Changes for v1.0.0 #370
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… configure information.
PettitWesley
force-pushed
the
v1readme
branch
from
6214c93
to
2868e96
Compare
PettitWesley
force-pushed
the
v1readme
branch
2 times, most recently
from
0989492
to
fb6dff0
Compare
PettitWesley
force-pushed
the
v1readme
branch
from
fb6dff0
to
df51e1d
Compare
SoManyHs
reviewed
Nov 13, 2017
README.md
Outdated
|
|
||
| ### Cluster Configurations | ||
|
|
||
| A cluster configuration is a set of fields that describes an Amazon ECS cluster including the name of the cluster and the region. These configurations can then be referenced when you run Amazon ECS CLI commands using the `--cluster-config` flag otherwise the default configuration is used. |
There was a problem hiding this comment.
- A cluster configuration is the* set of fields
- comma before "including"
- Semicolon after
--cluster-configflag and before "otherwise"
SoManyHs
reviewed
Nov 13, 2017
README.md
Outdated
|
|
||
| USAGE: | ||
| command configure [command options] [arguments...] | ||
| The Amazon ECS CLI supports the configuring of multiple sets of AWS credentials as named profiles using the `ecs-cli configure profile command`. These profiles can then be referenced when you run Amazon ECS CLI commands that require credentials using the `--ecs-profile` flag otherwise the default profile is used. |
There was a problem hiding this comment.
- Suggested rephrase: The Amazon ECS CLI supports configuring multiple sets
- Give example of cli commands that require credentials?
- semicolon before "otherwise", or rephrase to say "If a custom profile is not specified, the default profile will be used."
SoManyHs
suggested changes
Nov 13, 2017
README.md
Outdated
| --compose-service-name-prefix "ecscompose-service-" [Optional] Specifies the prefix added to an ECS service created from a compose file. Format <prefix><project-name>. | ||
| --cfn-stack-name-prefix "amazon-ecs-cli-setup-" [Optional] Specifies the prefix added to the AWS CloudFormation stack created on ecs-cli up. Format <prefix><cluster-name>. | ||
| ``` | ||
| Set up a CLI profile with the following command, substituting `profile_name` with your desired profile name, `$AWS_ACCESS_KEY_ID` and `$AWS_SECRET_ACCESS_KEY` environment variables with your AWS credentials. |
There was a problem hiding this comment.
This is awkwardly phrased. Needs an "and" after "profile name" perhaps?
README.md
Outdated
|
|
||
| A cluster configuration is a set of fields that describes an Amazon ECS cluster including the name of the cluster and the region. These configurations can then be referenced when you run Amazon ECS CLI commands using the `--cluster-config` flag otherwise the default configuration is used. | ||
|
|
||
| Create a cluster configuration with the following command, substituting `region_name` with your desired AWS region, `cluster_name` with the name of an existing Amazon ECS cluster or a new cluster to use, and `configuration_name` for the name you'd like to give this configuration. |
There was a problem hiding this comment.
If you're going to use "substitute with" in the first, two, maybe be consistent for the last one (instead of using "substitute for")
README.md
Outdated
|
|
||
| ### Using Credentials from `~/.aws/credentials`, Assuming a Role, and Multi-Factor Authentication | ||
|
|
||
| The `--aws-profile` flag and `$AWS_PROFILE` environment variable allows you to reference any named profile in `~/.aws/credentials`. |
There was a problem hiding this comment.
"allow" (since the subject of the sentence is both flag and variable)
SoManyHs
approved these changes
Nov 14, 2017
README.md
Outdated
|
|
||
| USAGE: | ||
| command configure [command options] [arguments...] | ||
| The Amazon ECS CLI supports configuring multiple sets of AWS credentials as named profiles using the `ecs-cli configure profile command`. These profiles can then be referenced when you run Amazon ECS CLI commands using the `--ecs-profile` flag; If a custom profile is not specified, the default profile will be used. |
There was a problem hiding this comment.
nit: Either use a period instead of semicolon before "If", or lowercase the "If".
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Partially addresses questions in #372, #369, #284