-
Notifications
You must be signed in to change notification settings - Fork 4
Rename provider virtualworkspace
to apiexport
and add some docs
#18
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
base: main
Are you sure you want to change the base?
Conversation
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
On-behalf-of: SAP <marvin.beckers@sap.com> Signed-off-by: Marvin Beckers <marvin@kubermatic.com>
How do other VW differ. We should not a different provider for each. Or at least a largely shared code base. |
In the I agree that code should largely be shared, but I suspect that the slightly different semantics of VWs will force writing your own provider unless you 1:1 implement e.g. the APIExport VW semantics. |
Summary
I realized that
virtualworkspace
is a problematic name, given that there are other VWs with different semantics than theAPIExport
one (e.g. theinitializingworkspaces
one). Thus, I'm proposing to rename the provider for clarity.In addition, I've added some light documentation so that the pkg.go.dev page for the provider looks a bit nicer and gives some hints.
What Type of PR Is This?
/kind documentation
/kind api-change
Related Issue(s)
Fixes #
Release Notes