Crdgendoc #432
Merged
Crdgendoc #432
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mfrancisc
requested review from
MatousJobanek,
xcoulon,
alexeykazakov,
rajivnathan,
ranakan19 and
sbryzak
as code owners
filariow
reviewed
Jun 25, 2024
|
|
||
| render: | ||
| # Version of Kubernetes to use when generating links to Kubernetes API documentation. | ||
| kubernetesVersion: 1.20 |
There was a problem hiding this comment.
@ranakan19 keep this line in mind when updating the dependencies
There was a problem hiding this comment.
I'll be bumping it to 1.27 though
Co-authored-by: Matous Jobanek <[email protected]>
Co-authored-by: Matous Jobanek <[email protected]>
MatousJobanek
approved these changes
Jun 26, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Jira: https://issues.redhat.com/browse/KUBESAW-119
This PR introduces CRD reference docs generation support to the
make generatecommand.It uses the latest version of the crd-ref-docs CLI. I've tried using this one https://github.com/ahmetb/gen-crd-api-reference-docs?tab=readme-ov-file but it doesn't seem to work. Also the online service keeps seems stuck while indexing our repo: https://doc.crds.dev/github.com/codeready-toolchain/api
As output a file
api/v1alpha1/docs/apiref.adocis generated which contains all the API documentation, changes to this file would need to be committed as any other change.Checks
Did you run
make generatetarget? yesDid
make generatechange anything in other projects (host-operator, member-operator)? noIn case of new CRD, did you the following? N/A
resources/setup/roles/host.yamlin the sandbox-sre repositoryPROJECTfile: https://github.com/codeready-toolchain/host-operator/blob/master/PROJECTCSVfile: https://github.com/codeready-toolchain/host-operator/blob/master/config/manifests/bases/host-operator.clusterserviceversion.yamlIn case other projects are changed, please provides PR links.