Documentation for a developers workflow #51
Description
Is your feature request related to a problem? Please describe.
When a new developer start to work within an existing code base, there is no guidance to what the pattern should. There is no way for the new develop to know what the "linking" functions are or why they are used. There is no explanation to why the reconciles should not be making GET requests to the cluster, but instant using the resources in the topology.
Describe the solution you'd like
I suggest that a guide be created to explain the concepts of the policy machinery. This should be done through the building of a simple operator that a user could build from scratch. A hello world example for a lack of a better word.
Describe alternatives you've considered
Have not give much though to an alternative.
Additional context
I have spoken with some developers adding new workflows into the kuadrant-operator, and they seem to be encountering the same issue of where to start. The reasoning behind certain design choices is unclear. However, when these concepts are explained, they find them logical.
Additionally, I have observed that once developers overcome this initial hurdle, working with the system becomes much easier.