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

Enhancements for Setup Process and Documentation #7

Open
ArmeenF opened this issue Dec 26, 2023 · 0 comments
Open

Enhancements for Setup Process and Documentation #7

ArmeenF opened this issue Dec 26, 2023 · 0 comments

Comments

@ArmeenF
Copy link

ArmeenF commented Dec 26, 2023

Hello,

I recently came across your project and found it to be very promising. However, during the setup process, I encountered a few issues and areas that could benefit from additional clarification in the documentation. I believe these enhancements could make the project more user-friendly and approachable, especially for those who are new to it.

Here are my suggestions:

  1. Dependencies: It would be helpful to explicitly state in the documentation that certain dependencies are required to build the project, depending on the user’s machine. In my case, I needed to install Go and the GNU Compiler Collection (GCC).
  2. WSL Usage: Instructions on how to use the project with Windows Subsystem for Linux (WSL) as an alternative to installing dependencies would be beneficial.
  3. Executing .bat Files: A brief guide on how to execute .bat files would be useful for users unfamiliar with the process.
  4. Proxmox Parameters: It would be clearer if the locations where users need to input their own Proxmox parameters were explicitly defined.
  5. Visual Aids: Consider adding images or videos showing how things should look and operate. This could greatly assist users in understanding the expected outcomes at each step.
  6. Obtaining Parameters: A step-by-step guide on how to obtain necessary parameters, such as the PBS API token and the Base URL for the PBS, would be very helpful.
  7. Compatibility: Please clarify if this project works only with Proxmox Backup Server, or if it can also work with Proxmox Virtual Environment.

I believe that these enhancements could significantly improve the user experience, especially for those who are new to the project. I look forward to seeing how this project evolves and appreciate your consideration of these suggestions.

Additionally, I would be happy to help and contribute to improving the documentation. Please let me know how I can assist further.

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

1 participant