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.

Sign up for GitHub

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

Jump to bottom

Introduce information about default and validated fields #2292

Closed
2 tasks done
RealAnna opened this issue Oct 18, 2023 · 5 comments · Fixed by #3068
Closed
2 tasks done

Introduce information about default and validated fields #2292

RealAnna opened this issue Oct 18, 2023 · 5 comments · Fixed by #3068
Assignees
@RealAnna
Labels
docs-infrastructure Issues related to the look and feel of the docs enhancement New feature or request on hold Do not merge yet
Milestone
2.1.0

Comments

@RealAnna
Copy link
Contributor

RealAnna commented Oct 18, 2023 •
edited
Loading

The script we use to autogenerate CRD docs now allows us to specify whether or not a field is required. We should make use of this.

AC

  • following this example introduce Default and Validation kubebuilder annotations to all types and all versions of our API
  • regenerate all docs making sure such info is shown

Notes & References

CRD readme generator script: https://github.com/keptn/lifecycle-toolkit/blob/main/.github/scripts/generate-crd-docs/generate-crd-docs.sh
Templates for the generator script: https://github.com/keptn/lifecycle-toolkit/tree/main/.github/scripts/generate-crd-docs/templates
Version of the CRD generator script is defined here: https://github.com/keptn/lifecycle-toolkit/blob/main/.github/scripts/generate-crd-docs/generate-crd-docs.sh#L11
@RealAnna RealAnna added status: ready-for-refinement Issue is relevant for the next backlog refinment docs-infrastructure Issues related to the look and feel of the docs labels Oct 18, 2023
@mowies mowies added the enhancement New feature or request label Oct 23, 2023
@mowies
Copy link
Member

mowies commented Oct 23, 2023

This is blocked until the CRD generator gets a new release.
(we currently use v0.0.9 which is latest as of commenting, I asked for a release here)

@mowies mowies added this to the 0.9 milestone Oct 23, 2023
@mowies
Copy link
Member

mowies commented Oct 25, 2023

the new version is released!

@RealAnna RealAnna self-assigned this Oct 27, 2023
@RealAnna
Copy link
Contributor Author

RealAnna commented Nov 2, 2023

Time, Duration, Quantity should point to good links for k8s resources now they are random

@RealAnna
Copy link
Contributor Author

RealAnna commented Nov 3, 2023

Validation is still not available, see elastic/crd-ref-docs#49

@RealAnna RealAnna mentioned this issue Nov 3, 2023
Merged
@mowies mowies modified the milestones: 0.9, 0.10 Nov 6, 2023
@mowies mowies added on hold Do not merge yet and removed status: ready-for-refinement Issue is relevant for the next backlog refinment labels Nov 15, 2023
@mowies
Copy link
Member

mowies commented Nov 15, 2023

on hold until crd-ref-docs supports that feature out of the box

@mowies mowies modified the milestones: 0.10, 0.11 Feb 12, 2024
@RealAnna RealAnna mentioned this issue Feb 19, 2024
Merged
8 tasks
@mowies mowies modified the milestones: 2.0.0-rc.1, 2.1.0 Mar 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@RealAnna RealAnna

Labels
docs-infrastructure Issues related to the look and feel of the docs enhancement New feature or request on hold Do not merge yet
Projects
Keptn Lifecycle Toolkit
Archived in project
Milestone
2.1.0
2 participants
@mowies @RealAnna