Add CRD display names and descriptions #56
Merged
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
Signed-off-by: Richard Wall <[email protected]>
Signed-off-by: Richard Wall <[email protected]>
Signed-off-by: Richard Wall <[email protected]>
jetstack-bot
added
the
size/M
wallrj
commented
Feb 16, 2022
Comment on lines
+92
to
+97
| - description: "A CertificateRequest is used to request a signed certificate from\ | ||
| \ one of the configured issuers. \n All fields within the CertificateRequest's\ | ||
| \ `spec` are immutable after creation. A CertificateRequest will either succeed\ | ||
| \ or fail, as denoted by its `status.state` field. \n A CertificateRequest\ | ||
| \ is a one-shot resource, meaning it represents a single point in time request\ | ||
| \ for a certificate and cannot be re-used." |
There was a problem hiding this comment.
There seems to be some indentation after the newlines in the descriptions for CertificateRequest and Certificate.
I considered stripping that, but it renders fine in operatorhub.io and it seems like this should be fixed upstream:
https://raw.githubusercontent.com/cert-manager/cert-manager/master/deploy/crds/crd-certificates.yaml
| name: issuers.cert-manager.io | ||
| version: v1 | ||
| - kind: Order | ||
| - description: Order is a type to represent an Order with an ACME server | ||
| displayName: (Internal) Order |
There was a problem hiding this comment.
I got the idea for prefixing these with (Internal) from the CouchDB operator
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.
This fills out the CRD tiles on operatorhub.io
Ideally operatorhub.io would do this