Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improvements to the installer docs #38

Open
lukemarsden opened this issue Oct 6, 2015 · 3 comments
Open

Improvements to the installer docs #38

lukemarsden opened this issue Oct 6, 2015 · 3 comments

Comments

@lukemarsden
Copy link
Contributor

  • vim terraform/terraform.tfvars instruction is confusing
    • It presumes people want to use vim
    • Surrounding instructions don't tell you to copy the sample file with that contents, and an empty file may be confusing
@alicesowerby
Copy link

Also:

  • "Copy and paste the public IP addresses of the first two agent_nodes" May be better as "use the the public IP addresses of the nodes in the following commands"
  • Make the Moby Counter screen load with an instruction to click on the screen (blank screen looks like failure)
  • Thought on the UFT installer. The command uft-flocker-volumes uses the term volumes. IF we plan to standardise on dataset then maybe that should be uft-flocker-datasets?
  • also, before the instruction to "deploy and migrate a stateful app" the user should be told "Success! You now have Flocker installed on a cluster. If you want to try out a quick example using Flocker, follow the next steps."

@alicesowerby
Copy link

feedback from ux testing with external users:

  • curl command is always commented on in a negative light (prefer package installer)
  • Change the instructions to tell the user when they need to running in root
  • Move the comment "this assumes you can use sudo" to before the commands
  • give example contents in the tfvars file.
  • Explain the command uft-flocker-sample-files, as it doesn't mention what it's for.
  • Explain what uft means!

@lukemarsden lukemarsden changed the title vim terraform/terraform.tfvars instruction is confusing Improvements to the installer docs Oct 21, 2015
@alicesowerby
Copy link

Feedback from User Testing on 22nd October 2015:

Installer tested well, the user completed the task easily apart from needing to install Docker and there being some issues with the AWS credentials (our fault) that were resolved.

  • Certificates are mentioned in the overview but no explanation of what they are for.
  • In some places "Quick start installer" is mentioned but not clear that it's the same installer being used.
  • The "Report a Bug" link in the text is not easily seen
  • Installing Docker on a Mac took 15 minutes (just mentioning as a data point, user also said he would keep it installed for further use)
  • It's mentioned that "This should return something like 1.4.0, showing you which version of the Flocker Client is installed." but this is the first mention of this tool.
  • Text says "Now we'll put some files in this directory." but the next step is to get some nodes
  • Instructions do not tell you that you need to replace bits of info in the tfvars file.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants