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

Add to examples in config/samples #34

Open
Starttoaster opened this issue Dec 18, 2023 · 1 comment
Open

Add to examples in config/samples #34

Starttoaster opened this issue Dec 18, 2023 · 1 comment
Labels
good first issue Good for newcomers

Comments

@Starttoaster
Copy link
Contributor

The current sample custom resource yaml files in this repo's config/samples have somewhat minimal examples of the allowed options for each custom resource. The full API for all of this operator's CRDs are shown in Go structs in the api/v1 directory. The samples should be more full to show what all is possible.

The documentation for each CRD in this repo's docs/ directory should then have a link to the matching yaml sample to show it off as an example.

@Starttoaster Starttoaster added the good first issue Good for newcomers label Dec 18, 2023
@Starttoaster
Copy link
Contributor Author

This is less of a problem now that we have some rough docs set up in this repo's docs/ directory, but it might be nice to still refine these samples. The docs could potentially use some refining too.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant