The *"Vagrant" User* section of the instructions on page
http://docs.vagrantup.com/v2/boxes/base.html
talks about setting up the insecure keypair. It clearly assumes the guest
OS is linux, because it mentions
the file path ~/.ssh/authorized_keys. Since this assumption has already
been made, then instructions no
longer need to be so general when talking about, and are free to go into
specific detail and spell out,
how to obtain and set up the keypair. It's quite simple, and useful, to
give a few lines of shell commands:
mkdir -p /home/vagrant/.sshchmod 0700 /home/vagrant/.ssh
wget --no-check-certificate \
https://raw.github.com/mitchellh/vagrant/master/keys/vagrant.pub \
-O /home/vagrant/.ssh/authorized_keyschmod 0600
/home/vagrant/.ssh/authorized_keyschown -R vagrant /home/vagrant/.ssh
rather than using vague language like "should be setup" and "place the
public key"
without telling the user exactly how to do this. (even if you and I both
know it's wget, and
the instructions DO provide a handy URL) It would really help a novice to
spell out the missing commands
they may be unfamiliar with, or not wish to have to learn about or be
concerned with!
Providing the "insecure keypair" URL as a link in the help page takes users
to a Github page.
This places several burdens on the novice trying to set up a base box:
- figuring out how to download from Github (e.g: right click on link in
browser, choose "copy link location")
- figuring out which file in the Github listing is the right one
(vagrant.pub)
- assuming linux terminal is where base box is being set up, figure out
how to download from the link location copied above. (base box shell may
not have cut/paste!)
- could also do so by downloading the file to host, then copying into
guest somehow
None of these things are explained, either in the VagrantDOCS or on the
Github page.
All are assumed the user knows how to figure out and do, washed over with
the disclaimer
"Advanced topic! ..." Yet it takes less space, less explanation, to
provide the simple example
shell commands above, which totally fits within the scope of assumptions
already in the help page,
that the user is setting up a linux base box, that they are using a
terminal to do so, and
that the terminal has the basic shell commands like mkdir, chmod, chown,
and wget.
I understand that when writing documentation, there is always a difficult
choice to balance
detail with generality, but in this case, I think the choice is clear; a
little more detail helps a lot!
--
You received this message because you are subscribed to the Google Groups
"Vagrant" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
For more options, visit https://groups.google.com/d/optout.
