[DOC] Supporting doc changes for additional CRD status fields #1833
Conversation
| @@ -1058,13 +1058,13 @@ Used in: xref:type-KafkaBridgeStatus-{context}[`KafkaBridgeStatus`], xref:type-K | |||
| |Property |Description | |||
| |type 1.2+<.<|The unique identifier of a condition, used to distinguish between other conditions in the resource. | |||
| |string | |||
| |status 1.2+<.<|The status of the condition, one of True, False, Unknown. | |||
| |status 1.2+<.<|The status of the condition, either True, False or Unknown. | |||
There was a problem hiding this comment.
This is generated file. You have to do these changes in the strimzi-kafka-operator/api/src/main/java/io/strimzi/api/kafka/model/status/Condition.java and regenerate doc.
There was a problem hiding this comment.
@laidan6000 Do you want to try to fix it your self? Or should I open a separate PR to fix this for you?
There was a problem hiding this comment.
Please can you fix in a separate PR, @scholzj . I'll attempt to back out the change.
There was a problem hiding this comment.
@laidan6000 #1836 - please review
There was a problem hiding this comment.
Looks good. To revert the changes to appendix_crds.adoc, can I just delete the file in GitHub? Click ... > Delete File.
There was a problem hiding this comment.
I'm not sure. I would expect that to delete the whole file and not just the changes. I'm not a Git expert, but I think you should be able to:
- Fetch the data from upstream using
git fetch - Checkout the single file from the master branch:
git checkout origin/master documentation/book/appendix_crds.adoc
(perhaps make a backup of the local repository before trying this - make a copy before doing this :-o)
There was a problem hiding this comment.
Give it a try. Or if you want me or whoever will be merging this can fix it for you while merging it.
There was a problem hiding this comment.
Please can you fix it during the merge?
|
|
||
| * `KafkaUserStatus` provides the user name of the Kafka user and the `Secret` in which their credentials are stored. | ||
|
|
||
| * `KafkaBridgeStatus` provides the HTTP address at which external client applications can access the Bridge service. |
There was a problem hiding this comment.
maybe we should say "HTTP based URL" based on the naming we are using in the implementation. Wdyt @tombentley ?
There was a problem hiding this comment.
Or:
"provides the URL at which external client applications can access the Bridge service"
Co-Authored-By: Tom Bentley <tombentley@users.noreply.github.com>
Type of change
Description
Updated the existing Strimzi custom resource status concept module to summarize every resource that now has
statusinformation. ThekafkaTopicresource is included as a placeholder -- the development work is still outstanding.Explained the new
observedGenerationinformation that is available for every custom resource. Can we add any more information about this?Removed the note that the status property is still under development and only available for
kafka.Minor changes to the Checking the status of a custom resource procedure.
Checklist
Please go through this checklist and make sure all applicable tasks have been done
./design