Lack of Documentation in Key Areas

Lack of Documentation in Key Areas

There is a lack of documentation in several important areas:

1. 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.

2. Running Locally

After executing make run, numerous go vet errors are encountered, with no clear guidance on how to resolve them.

3. Debugging

There is no documentation explaining how to debug the operator (e.g., profiling, adjusting log levels, etc.).

4. 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.

Start by documenting the development environment and the existing make run workflow, including the go vet errors reported after running it. Cover debugging the operator, including profiling and log-level adjustments, and describe the development cycle from making changes through testing and end-to-end validation; done means each listed area has clear guidance.