docs: Fix issues found in Queeny's test #507
Conversation
|
Please comment if I missed anything |
deploy/aws/README.md
Outdated
|
|
||
| It may take some while to finish destroying the cluster. | ||
|
|
||
| ```shell | ||
| ``` shell |
There was a problem hiding this comment.
@lilin90 Is this space necessary?
Co-Authored-By: Keke Yi <40977455+yikeke@users.noreply.github.com>
|
|
||
| # Or, download binary for macOS | ||
| curl -o aws-iam-authenticator https://amazon-eks.s3-us-west-2.amazonaws.com/1.12.7/2019-03-27/bin/darwin/amd64/aws-iam-authenticator | ||
|
|
There was a problem hiding this comment.
Maybe using the code below is simpler and more general
os=$(uname -s| tr '[:upper:]' '[:lower:]')
curl -o aws-iam-authenticator https://amazon-eks.s3-us-west-2.amazonaws.com/1.12.7/2019-03-27/bin/$os/amd64/aws-iam-authenticator
There was a problem hiding this comment.
I don't have any mac for test, if you can confirm this works for macOS?
There was a problem hiding this comment.
Yes, it works for macOS and Linux
There was a problem hiding this comment.
@AstroProfundis The link you mentioned already has an elegant way to install aws-iam-authenticator.
For macOS, install with homebrew. For linux install with the curl to fetch the binary. It's inappropriate to provide the tricky script in the guide.
There was a problem hiding this comment.
I don't think homebrew is available to every macOS installation by default...
There was a problem hiding this comment.
Yes, it's not builtin on macOS. But almost all technical users install that. So I think provide homebrew command is reasonable.
There was a problem hiding this comment.
This definitely can't pass Queeney's test, the "almost all technical users" is not fitting the target user groups.
There was a problem hiding this comment.
You can add a note in the document that before users install aws-iam-authenticator with homebrew, they need to make sure that they have installed homebrew first, then providing the homebrew way is totally acceptable for queeny's test.
There was a problem hiding this comment.
Then we're introducing new dependency and copying almost all major parts of AWS document, what's the point of avoiding out-linking again?
There was a problem hiding this comment.
Yeah, you are right. So if the curl way does not require any new dependency for macOS, I suggest we introduce the curl way in our document then. If users prefer the homebrew way, they can still click the link and find the guide in the AWS document.
Co-Authored-By: Keke Yi <40977455+yikeke@users.noreply.github.com>
Co-Authored-By: Keke Yi <40977455+yikeke@users.noreply.github.com>
AstroProfundis
force-pushed
the
fix-queeny-test-issues
branch
from
100fdce
to
7b46590
Compare
Co-Authored-By: Keke Yi <40977455+yikeke@users.noreply.github.com>
There was a problem hiding this comment.
LGTM. Thanks a lot for your support during the test. @AstroProfundis
What problem does this PR solve?
Make the documents more clear to newbies.
What is changed and how it works?
Fix various issues found in Queeny's test
Check List
Tests
Code changes
Side effects
Related changes
#502