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

"How to write a custom provisioner?" doc #121

Open
mathieu-benoit opened this issue Oct 15, 2024 · 7 comments
Open

"How to write a custom provisioner?" doc #121

mathieu-benoit opened this issue Oct 15, 2024 · 7 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@mathieu-benoit
Copy link
Contributor

mathieu-benoit commented Oct 15, 2024

Based on this blog post, it would be great/better to have a dedicated doc entry: "How to write a custom provisioner?" by taking inspiration from this blog post: https://score.dev/blog/writing-a-custom-score-compose-provisioner-for-apache-kafka/.

1 doc for both score-compose and score-k8s because the concept are the same (as opposed to one doc for each). It will a new page entry at the https://docs.score.dev/docs/score-implementation/ level, like we have this other entry today.

Rough TOC:

@mathieu-benoit mathieu-benoit added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Oct 15, 2024
@ankur0904
Copy link

@mathieu-benoit
Can I work on this issue and make the PR?

@mathieu-benoit
Copy link
Contributor Author

Thanks @ankur0904 for raising your hand on this one.

Before you start, I would like to make sure @astromechza can chime in providing high level guidance here.

@astromechza
Copy link
Member

I think one of the core maintainers should rather work on this since this is not just technical but also quite idealogical around the mission, vision, and history of Score.

@ankur0904
Copy link

ankur0904 commented Jan 15, 2025

@astromechza Could I collaborate on this with the core members working on it?

@mathieu-benoit
Copy link
Contributor Author

Yeah good point @astromechza , I'll assign this ticket to you and let's see from there.

@ankur0904, sorry but after some discussions, we need some refinements on this one (that could land to actually write the doc itself like @astromechza mentioned) and we don't think anymore that this one is a good candidate as a good first issue, I'll remove the labels.

@mathieu-benoit mathieu-benoit removed good first issue Good for newcomers help wanted Extra attention is needed labels Jan 15, 2025
@ankur0904
Copy link

Okay, thanks for the clarification
@mathieu-benoit

@mathieu-benoit
Copy link
Contributor Author

Based on this discussion score-spec/score-compose#237 (comment), tracking this here that we will also need to document the class aspect.

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
Status: Todo
Development

No branches or pull requests

3 participants