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

update landing readme #3

Open
mattmoor opened this issue Jun 14, 2019 · 5 comments
Open

update landing readme #3

mattmoor opened this issue Jun 14, 2019 · 5 comments
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness.

Comments

@mattmoor
Copy link
Contributor

No description provided.

@mattmoor
Copy link
Contributor Author

We should talk about the audience for this, and the expected process for changes

@github-actions
Copy link

This issue is stale because it has been open for 90 days with no
activity. It will automatically close after 30 more days of
inactivity. Reopen the issue with /reopen. Mark the issue as
fresh by adding the comment /remove-lifecycle stale.

@github-actions github-actions bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Aug 21, 2020
@mattmoor
Copy link
Contributor Author

/lifecycle frozen
/kind good-first-issue

@knative-prow-robot knative-prow-robot added kind/good-first-issue lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels Aug 21, 2020
@imjasonh
Copy link

imjasonh commented May 3, 2021

Strong +1

I'd argue that unless prospective users can fork and modify this sample, it either shouldn't exist, or shouldn't be marked as a template for easy forking.

I've based a couple PoCs on this sample controller, and I'm always annoyed at all the steps it takes to make it fit my needs. Here's an incomplete list of changes I make every time I fork the template:

  • rename pkg/apis/samples/v1alpha1 to pkg/apis/something/v1alpha1 and update references in hack/update-codegen.sh
  • rm pkg/client to remove the old generated clients I no longer need
  • rename the AddressableService type to MyType, remove its spec and status fields
  • move and rewrite pkg/reconciler/addressableservice to talk about my type in my package
  • delete anything related to SimpleDeployment, I usually start off only needing one type at first
  • change cmd/controller and cmd/webhook to use
  • change import paths from knative.dev/sample-controller/... to github.com/my-user/my-repo/... (and inevitably forget some)
  • hack/update-codegen.sh until things work, or just give up

Having those steps written down in some official place would help a lot. Including a script that did them for me would be ideal. At that point that's basically 20% of kubebuilder.

@imjasonh
Copy link

imjasonh commented May 4, 2021

@dprotaso dprotaso added good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. and removed kind/good-first-issue labels Oct 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Denotes an issue ready for a new contributor, according to the "help wanted" guidelines. lifecycle/frozen Indicates that an issue or PR should not be auto-closed due to staleness.
Projects
None yet
Development

No branches or pull requests

4 participants