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

Flux contributor documentation: Controller fundamentals #398

Open
scottrigby opened this issue Jul 7, 2021 · 1 comment
Open

Flux contributor documentation: Controller fundamentals #398

scottrigby opened this issue Jul 7, 2021 · 1 comment
Labels
enhancement New feature or request

Comments

@scottrigby
Copy link
Member

Problem:
We have consistently heard that the bar is very high to contribute to Flux controllers, and the requirements are not clearly defined in any single place.

Proposed solution:
We can help people who want to contribute to Flux Controllers by providing guidance in a new docs section on Flux Controller contributor documentation.

Goals:

  • This would be new documentation on fluxcd.io
  • Encourage new contributors to Flux Controllers
  • Encourage new controllers built on top of Flux packages (GitOps Toolkit)

Note: we may want to draw inspiration from this page: https://cluster-api.sigs.k8s.io/developer/testing.html

@scottrigby scottrigby added the enhancement New feature or request label Jul 7, 2021
@scottrigby scottrigby changed the title Flux Controller contributor documentation Flux Controller fundamentals - contributor documentation Sep 13, 2021
@scottrigby scottrigby changed the title Flux Controller fundamentals - contributor documentation Flux contributor documentation: Controller fundamentals Sep 13, 2021
@dholbach
Copy link
Member

dholbach commented Nov 7, 2022

https://fluxcd.io/contributing/flux/ now has links to dev docs of the individual controllers. Does that help or do we need to do more?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants