Lack of Documentation in Key Areas
There is a lack of documentation in several important areas:
- Development Environment
When attempting to test new features, it takes a significant amount of time to properly set up the development environment and run the project locally.
- Running Locally
After executing make run, numerous go vet errors are encountered, with no clear guidance on how to resolve them.
- Debugging
There is no documentation explaining how to debug the operator (e.g., profiling, adjusting log levels, etc.).
- Development Cycle
There is no clear documentation describing the development workflow, including how to make changes, test them, and validate the results end-to-end.
Proposal
I propose adding comprehensive documentation that covers these topics to improve the developer and tester experience.
Lack of Documentation in Key Areas
There is a lack of documentation in several important areas:
When attempting to test new features, it takes a significant amount of time to properly set up the development environment and run the project locally.
After executing make run, numerous go vet errors are encountered, with no clear guidance on how to resolve them.
There is no documentation explaining how to debug the operator (e.g., profiling, adjusting log levels, etc.).
There is no clear documentation describing the development workflow, including how to make changes, test them, and validate the results end-to-end.
Proposal
I propose adding comprehensive documentation that covers these topics to improve the developer and tester experience.