docs: New developer getting started guide #888
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 2 commits
January 1, 2024 13:07
… to get a bleeding edge version of golang Telmate#704
spettinichi
pushed a commit
to spettinichi/terraform-provider-proxmox
that referenced
this pull request
Jan 26, 2024
* docs: Updated docs (removed broken commands, etc.) and added a script to get a bleeding edge version of golang Telmate#704 * docs: Added a guide to help developers who are new to this project --------- Co-authored-by: hestia <hestia@hax0rbana.org>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a guide for new developers and corrects some commands which no longer work, filenames that changed and so on.
As an old developer who is new to this project, new to GoLang, and has never contributed to Terraform nor Proxmox, I found some things that were particularly troublesome in getting started.
go installcommand in the documentation that didn't work (but apparently it's not needed if you check out the repo withgit)I added a little Ansible playbook to get the bleeding edge version of GoLang in an automated fashion and updated the documentation to address all of the other things. While this level of documentation likely not needed for people who are experts with Terraform and GoLang, they are extremely helpful to those who lack experience in troubleshooting these systems.
If this gets accepted, in the future I may write a guide to help non-developers be able to test with different commits to see exactly when an issue was introduced. Having bug reporters or commenters figure this out is tremendously helpful and allows them to help developers get to the root cause of issues more quickly.