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

Update the Download and Install guide intructions #531

Open
snarve opened this issue Dec 20, 2024 · 0 comments
Open

Update the Download and Install guide intructions #531

snarve opened this issue Dec 20, 2024 · 0 comments
Assignees
Labels
bug This issue or pull request addresses broken functionality documentation This issue or pull request improves or adds to documentation enhancement Medium
Milestone

Comments

@snarve
Copy link
Collaborator

snarve commented Dec 20, 2024

🐛 Summary

Some instructions in the Download and Install guide needs to be tweaked and some of the user prompts need to be updated

To reproduce

The setup process:

  • This includes multiple prompts

  • Each prompt asks if user would like to continue the path provided or change it, if the goal is to have all the files centrally located in the user's home directory then why provide an option to change the path where this can be installed

  • This could also lead to the user saving different setup files in different locations (ex: opa in one place and credentials in another), this defeats the purpose of a centrally allocated setup files folder

  • The given sequence does not work, since the steps to setup the credentials is after, so there is no credentials file available for the user to save yet

  • Also, the user will then have to place the credentials in this folder, its easier to have everything in the project folder itself

  • In the setup process opa is already installed, and then in the next steps there is a link to install opa, this needs to be updated

  • all the setup files can be installed later after they have been created and downloaded, without the prompts to simplify the process

  • missing instructions without the whl file

  • Image
    Are there any instructions here that need to be followed, if not the text confuses the user as to what needs to be done here

  • If we need two separate set of instructions for developer/user the dev instructions should be in a separate place not in the guide that will be handed to the user, to avoid confusion

  • The download and install file has large amount of text which is helpful to understand the process, however from a user's perspective this is confusing (to find instructions within the text) and a lot of information.
    The instructions can be simplified with a shorter version with clear steps on what to do next.
    The informative text can be saved in separate place for reference.

@snarve snarve added bug This issue or pull request addresses broken functionality documentation This issue or pull request improves or adds to documentation enhancement Medium labels Dec 20, 2024
@snarve snarve modified the milestones: Eel, Driftwood Dec 20, 2024
@snarve snarve mentioned this issue Dec 20, 2024
13 tasks
@adhilto adhilto self-assigned this Jan 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug This issue or pull request addresses broken functionality documentation This issue or pull request improves or adds to documentation enhancement Medium
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

2 participants