Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs]: Flow chart for callbacks #66

Open
2 tasks done
ringerc opened this issue Jul 9, 2024 · 0 comments
Open
2 tasks done

[Docs]: Flow chart for callbacks #66

ringerc opened this issue Jul 9, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@ringerc
Copy link

ringerc commented Jul 9, 2024

Is there an existing issue already for your request/idea?

  • I have searched for an existing issue, and could not find anything. I believe this is a new documentation enhancement to be evaluated.

What problem in the existing documentation this issue aims to solve?

While writing a CNPG-I plugin, I found it to be unclear under what circumstances each callback would be invoked, and what each callback could do.

Describe what additions need to be done to the documentation

A flow chart would be very helpful for this. It would show things like:

  • Order of calls
  • Which callbacks are made at plugin or CNPG startup
  • possible outcomes of calls

For example, show that on plugin start the plugin reconciler hooks are called for each Cluster resource, but the operator lifecycle hooks won't be.

Describe what pages need to change in the documentation, if any

No response

Describe what pages need to be removed from the documentation, if any

No response

Additional context

No response

Backport?

No

Code of Conduct

  • I agree to follow this project's Code of Conduct
@ringerc ringerc added the documentation Improvements or additions to documentation label Jul 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants