This repository has been archived by the owner on Jun 29, 2022. It is now read-only.
docs: clarify values for ssh_pubkeys #230
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
invidian
previously approved these changes
Mar 30, 2020
johananl
reviewed
Mar 30, 2020
| @@ -178,7 +178,7 @@ worker_pool "my-worker-pool" { | |||
| | `os_version` | Flatcar Container Linux version to install. Version such as "2303.3.1" or "current". | "current" | false | | |||
| | `dns_zone` | Route 53 DNS Zone. | - | true | | |||
| | `dns_zone_id` | Route 53 DNS Zone ID. | - | true | | |||
| | `ssh_pubkeys` | SSH public keys for user `core`. | - | true | | |||
| | `ssh_pubkeys` | SSH public keys for user `core`. This is the full public key as shown by `ssh-add -L`. | - | true | | |||
There was a problem hiding this comment.
This assumes the user users ssh-agent. I sometimes encounter tech folks who don't know about ssh-agent or wouldn't use it for some other reason. Also, assuming most users will have the key pair as local files, I would consider using the word "contents" to make it very clear they have to paste the contents of the public key file rather than a reference to the file path.
iaguis
force-pushed
the
iaguis/ssh-keys-docs
branch
2 times, most recently
from
2117582
to
2a955fc
Compare
invidian
reviewed
Mar 30, 2020
They should be the full public key and this is not obvious. Also, show a more descriptive value for the quickstart examples.
iaguis
force-pushed
the
iaguis/ssh-keys-docs
branch
from
2a955fc
to
096bd34
Compare
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
They should be the full public key and this is not obvious.
Also, show a more descriptive value for the quickstart examples.