Skip to content

Make samples more standalone #586

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

Closed
iocanel opened this issue Oct 6, 2021 · 3 comments
Closed

Make samples more standalone #586

iocanel opened this issue Oct 6, 2021 · 3 comments
Assignees
Labels
examples Improvements to the example projects

Comments

@iocanel
Copy link
Collaborator

iocanel commented Oct 6, 2021

It would be nice if samples were standalone.

By standalone I mean:

  • have documentation directly in the project directory
  • able to run outside the context of the project (e.g. remove parent).
  • contain internally all resources they require

The reasoning is pretty simple, one should be able to just copy the sample directory and be able to get started, without having to mess with parents etc.

@csviri
Copy link
Collaborator

csviri commented Oct 6, 2021

Note that those samples are not really samples, its more like a starter pack, just used usually for quick smoke/sanity testing. There are samples in a separate project:
https://github.com/java-operator-sdk/samples

We should probably articulate this more somewhere.
But there was a plan to move those samples back to this repo. If I remember correctly @adam-sandor planned to work on that.

@metacosm
Copy link
Collaborator

metacosm commented Oct 6, 2021

Yes, the samples are really simple ones more meant to be smoke-tests for changes made in the core than real examples.

@jmrodri jmrodri added the examples Improvements to the example projects label Oct 14, 2021
@csviri
Copy link
Collaborator

csviri commented Nov 3, 2021

Will close this issue, after this, it should be covered mostly:
#590

@csviri csviri closed this as completed Nov 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
examples Improvements to the example projects
Projects
None yet
Development

No branches or pull requests

5 participants