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

docs(api): adds formatting for lists to the descriptions of the API properties #9646

Merged
merged 2 commits into from
Feb 7, 2024
Merged

docs(api): adds formatting for lists to the descriptions of the API properties #9646

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0fc14ac
docs(api): adds formatting for lists to the descriptions of the API p…
PaulRMellor Feb 6, 2024
69f092d
docs(api): adds the helm chart update
PaulRMellor Feb 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion api/src/main/java/io/strimzi/api/kafka/model/kafka/listener/GenericKafkaListener.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ public void setPort(int port) {
}

@Description("Type of the listener. " +
"Currently the supported types are `internal`, `route`, `loadbalancer`, `nodeport` and `ingress`. \n\n" +
"The supported types are as follows: \n\n" +
"* `internal` type exposes Kafka internally only within the Kubernetes cluster.\n" +
"* `route` type uses OpenShift Routes to expose Kafka.\n" +
"* `loadbalancer` type uses LoadBalancer type services to expose Kafka.\n" +
Expand Down
2 changes: 1 addition & 1 deletion crd-generator/src/main/java/io/strimzi/crdgenerator/DocGenerator.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ private void appendCommonTypeDoc(Crd crd, Class<?> cls) throws IOException {
appendDescription(cls);
appendDiscriminator(crd, cls);

out.append("[cols=\"2,2,3\",options=\"header\"]").append(NL);
out.append("[cols=\"2,2,3a\",options=\"header\"]").append(NL);
out.append("|====").append(NL);
out.append("|Property |Property type |Description").append(NL);

Expand Down
10 changes: 5 additions & 5 deletions crd-generator/src/test/resources/io/strimzi/crdgenerator/simpleTest.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
= `Example` schema reference


[cols="2,2,3",options="header"]
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|affinity
Expand Down Expand Up @@ -133,7 +133,7 @@
Used in: xref:type-ExampleCrd-{context}[`ExampleCrd`]


[cols="2,2,3",options="header"]
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|====
Expand All @@ -145,7 +145,7 @@ Used in: xref:type-ExampleCrd-{context}[`ExampleCrd`]

Example of complex type.

[cols="2,2,3",options="header"]
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|bar
Expand All @@ -164,7 +164,7 @@ Used in: xref:type-ExampleCrd-{context}[`ExampleCrd`]

The `discrim` property is a discriminator that distinguishes use of the `PolymorphicLeft` type from xref:type-PolymorphicRight-{context}[`PolymorphicRight`].
It must have the value `left` for the type `PolymorphicLeft`.
[cols="2,2,3",options="header"]
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|commonProperty
Expand All @@ -186,7 +186,7 @@ Used in: xref:type-ExampleCrd-{context}[`ExampleCrd`]

The `discrim` property is a discriminator that distinguishes use of the `PolymorphicRight` type from xref:type-PolymorphicLeft-{context}[`PolymorphicLeft`].
It must have the value `right` for the type `PolymorphicRight`.
[cols="2,2,3",options="header"]
[cols="2,2,3a",options="header"]
|====
|Property |Property type |Description
|commonProperty
Expand Down
Loading
Loading