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

Anbox Cloud: Usability testing for the appliance tutorial #75

Closed
keirthana opened this issue Jun 4, 2024 · 5 comments
Closed

Anbox Cloud: Usability testing for the appliance tutorial #75

keirthana opened this issue Jun 4, 2024 · 5 comments
Labels
edit Edit pre-existing documentation for consistency, style and application review Review pre-existing documentation for quality and consistency size 2 Fix a known documentation issue (size 2/8) tutorial Develop, write, edit or update a tutorial update Update potentially outdated instructions, commands, or version numbers

Comments

@keirthana
Copy link
Collaborator

Disclaimer: Anbox Cloud requires Ubuntu Pro and while the documentation source is open, the product source is not.

Licensing:

  • For contributions to the documentation, you will be required to sign the CLA.
  • The Anbox Cloud documentation is licensed under the Creative Commons Attribution-Share Alike 3.0 Unported License.

The Anbox Cloud tutorial on installing the appliance needs to be tested for gaps in understanding by someone who is new to the product.

Basic:
Run through the steps in the tutorial and perform the steps as you go and share feedback on where you get stuck because of missing or incorrect information, where you would like more information to enhance your learning process.

Advanced (Optional):
If you are confident about the changes you want in the tutorial, raise a pull request against the Anbox Cloud documentation repository. Please note that the Anbox Cloud documentation follows the Díataxis approach. See https://diataxis.fr/tutorials/ for information on how to apply Diataxis for a tutorial.

@keirthana keirthana added review Review pre-existing documentation for quality and consistency edit Edit pre-existing documentation for consistency, style and application size 2 Fix a known documentation issue (size 2/8) tutorial Develop, write, edit or update a tutorial update Update potentially outdated instructions, commands, or version numbers labels Jun 4, 2024
@gerryRcom
Copy link

Hi keirthana, I'd be happy to run through the install tutorial and see if there are gaps, I'm not familiar with the product but am familiar with software installations on servers so should be able to get through it.

@keirthana
Copy link
Collaborator Author

Hi @gerryRcom, thanks for picking this up. Actually unfamiliarity with the product will help in this exercise because the that's the point of the tutorial - to teach new users.

Let me know if you have any questions.

@gerryRcom
Copy link

Hi, with the exception of one missing sudo command the playbook worked out fine, spun up a local sever with service installed without issue. I submitted a pull request to add it, also updated the status command output while I was at it as the current version is a bit newer that the one that was there.

@keirthana
Copy link
Collaborator Author

Thank you very much for your time on this @gerryRcom. I have emailed you about the CLA check failing. I will keep you posted.

@keirthana
Copy link
Collaborator Author

Hi @gerryRcom,

The updates are now live at https://anbox-cloud.io/docs/tutorial/installing-appliance. Thank you very much.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
edit Edit pre-existing documentation for consistency, style and application review Review pre-existing documentation for quality and consistency size 2 Fix a known documentation issue (size 2/8) tutorial Develop, write, edit or update a tutorial update Update potentially outdated instructions, commands, or version numbers
Projects
None yet
Development

No branches or pull requests

2 participants