V1 Documentation Updates #40
Conversation
|
Would you mind making the gif dimensions smaller (some of them are huge) and the text bigger? For a demo it may also be a good idea to always use the long form of a flag (e.g. |
cmd/ssm-session/README.md
Outdated
| @@ -28,7 +28,7 @@ To use a specific profile and/or region, use the `-p (--profiles)` or `-r (--reg | |||
|
|
|||
| e.g. `-p account1,account2 -r us-east-1,us-west-2` | |||
|
|
|||
| Take careful note that if multiple regions *and* profiles are specified, `ssm-run` will return results for instances across all the possible permutations. | |||
| Take careful note that if multiple regions *and* profiles are specified, `ssm-sessionb` will return results for instances across all the possible permutations. | |||
There was a problem hiding this comment.
ssm-sessionb -> ssm session?
cmd/ssm-run/README.md
Outdated
| INFO Instance ID Region Profile Status | ||
| INFO i-12345 us-east-1 profile1 Success | ||
| INFO i-67890 us-east-1 profile1 Success | ||
| > ./ssm run -p 'profile1' -i 'i-0879fe217fe11ad86,i-062aede5be23eef7a' -c 'uname > /dev/null 2>&1' |
There was a problem hiding this comment.
Should we show the output of the command instead of just piping to /dev/null so as to illustrate what that would look like interspersed with the status lines for each instance?
* ssm-helpers.gif * ssm-run.gif * ssm-session-1.gif
cmd/ssm-run/README.md
Outdated
| INFO Fetched 1 instances for account [profile1] in [us-east-1]. | ||
| INFO Instance ID Region Profile Status | ||
| INFO i-12345 us-east-1 profile1 Success | ||
| > ./ssm run -p 'profile1' -i i-12345 -c 'uname' |
There was a problem hiding this comment.
Is there a reason to keep the ./ssm in? Feel like that was an artifact from when this was bash script or the binary was written to the root of the project. A local build of the project would be using bin/ssm and an installed version using 'go get' would not need the './' prefix. This comment applies to many other examples.
* Update ssm run documentation with v1 changes. * Update ssm session readme with v1 changes. * Update gifs for v1
Summary
This PR includes documentation updates for the 1.0 major version bump including new gifs showing functionality.
All gif and documentation changes attempt to replicate the previous demonstrations as closely as possible, primarily making changes to accommodate any differences to the UX in v1.
Still To Fix