Add resource-level note to DocumentationConfig#710
Conversation
Adds a `note` field to ResourceDocsConfig that allows service controllers to document special considerations for a resource via documentation.yaml. The note is exposed through a CRD.Note() method for downstream consumers.
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: knottnt, michaelhtm The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
/hold |
ack-prow
Bot
added
the
do-not-merge/hold
|
/retest |
|
@knottnt: The following tests failed, say
Full PR test history. Your PR dashboard. DetailsInstructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here. |
2 participants
Issue #, if available:
Description of changes:
Adds a
notefield to ResourceDocsConfig that allows service controllers to document special considerations for a resource via documentation.yaml. The note is later consumed by the ACK docs website and displayed in the resource's API Reference page.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.