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

Blueprint reoganization and support #2212

Open
mlavi opened this issue Jul 20, 2023 · 4 comments
Open

Blueprint reoganization and support #2212

mlavi opened this issue Jul 20, 2023 · 4 comments
Assignees
Projects

Comments

@mlavi
Copy link
Contributor

mlavi commented Jul 20, 2023

Kanister blueprints exist in the /examples directory of the project; they are the key artifacts that Kanister works on.

As the project has grown over time, blueprints have been added for different use cases and proof of concepts, they exist in various states of maintenance, and some have atrophied. In order to improve blueprint organization, community participation, and clarify the support model, a blueprint reorganization is needed!

Proposed Solution:

  • Move blueprints that are not used by Kanister developers for testing into a sub-directory: /examples/community
    • This will make explicit what blueprints the project depends on (and must maintain) versus community supported blueprints
    • Stabilize any dependencies, hopefully not needed!
  • Create an /examples/community/README.md to describe directory organization and community support model, link back to Kanister project supported blueprints if appropriate
  • Create kanisterio/blueprints repository, migrate kanister/examples/community blueprints to new repo
    • Remove kanister/examples/community/ blueprints, update the /examples/community/README.md to point to the new repo
@github-actions
Copy link
Contributor

Thanks for opening this issue 👍. The team will review it shortly.

If this is a bug report, make sure to include clear instructions how on to reproduce the problem with minimal reproducible examples, where possible. If this is a security report, please review our security policy as outlined in SECURITY.md.

If you haven't already, please take a moment to review our project's Code of Conduct document.

@infraq infraq added this to To Be Triaged in Kanister Jul 20, 2023
@mlavi mlavi self-assigned this Jul 20, 2023
@shuguet
Copy link
Member

shuguet commented Jul 20, 2023

Why would we go through step 2?
Why not move directly to a separate repo?
That's what Kyverno does for example with they "policies" repo (https://github.com/kyverno/policies/), and make it much cleaner in my opinion.

@github-actions
Copy link
Contributor

This issue is marked as stale due to inactivity. Add a new comment to reactivate it.

@mlavi
Copy link
Contributor Author

mlavi commented Jan 23, 2024

At our most recent engineering offsite, Thomas agreed to a separate repo.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Kanister
To Be Triaged
Development

No branches or pull requests

3 participants