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

CRD fields should have descriptions #106

Open
ChunyiLyu opened this issue Apr 26, 2024 · 0 comments
Open

CRD fields should have descriptions #106

ChunyiLyu opened this issue Apr 26, 2024 · 0 comments
Labels
enhancement New feature or request

Comments

@ChunyiLyu
Copy link
Member

There should be helpful descriptions to CRD fields. Atm, it looks like:

❯ k explain promise.spec
GROUP:      platform.kratix.io
KIND:       Promise
VERSION:    v1alpha1

FIELD: spec <Object>


DESCRIPTION:
    PromiseSpec defines the desired state of Promise

FIELDS:
  api	<Object>
    <no description>

  dependencies	<[]Object>
    <no description>

  destinationSelectors	<[]Object>
    <no description>

  requiredPromises	<[]Object>
    <no description>

  workflows	<Object>
    <no description>

❯ k explain promise.spec.workflows
GROUP:      platform.kratix.io
KIND:       Promise
VERSION:    v1alpha1

FIELD: workflows <Object>


DESCRIPTION:
    <empty>
FIELDS:
  promise	<Object>
    <no description>

  resource	<Object>
    <no description>

@ChunyiLyu ChunyiLyu changed the title CRDs' fields should have descriptions CRD fields should have descriptions Apr 26, 2024
@kirederik kirederik added the enhancement New feature or request label Apr 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants