tizbac/proxmoxbackupclient_go

Enhancements for Setup Process and Documentation

Opened this issue · 0 comments

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.