Skip to content

Commit 69b13da

Browse files
committed
Add spacing after the description
1 parent d95e980 commit 69b13da

File tree

4 files changed

+20
-1
lines changed

4 files changed

+20
-1
lines changed

docs/domains/Domain.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
### Domain
22

33
Domain represents a WebLogic domain and how it will be realized in the Kubernetes cluster.
4+
45
| Name | Type | Description |
56
| --- | --- | --- |
67
| apiVersion | string | The API version for the Domain. Must be 'weblogic.oracle/v2'. |
@@ -12,6 +13,7 @@ Domain represents a WebLogic domain and how it will be realized in the Kubernete
1213
### Domain Spec
1314

1415
DomainSpec is a description of a domain.
16+
1517
| Name | Type | Description |
1618
| --- | --- | --- |
1719
| adminServer | [Admin Server](#admin-server) | Configuration for the admin server. |
@@ -39,6 +41,7 @@ DomainSpec is a description of a domain.
3941
### Domain Status
4042

4143
DomainStatus represents information about the status of a domain. Status may trail the actual state of a system.
44+
4245
| Name | Type | Description |
4346
| --- | --- | --- |
4447
| conditions | array of [Domain Condition](#domain-condition) | Current service state of domain. |
@@ -51,6 +54,7 @@ DomainStatus represents information about the status of a domain. Status may tra
5154
### Admin Server
5255

5356
AdminServer represents the operator configuration for the admin server.
57+
5458
| Name | Type | Description |
5559
| --- | --- | --- |
5660
| adminService | [Admin Service](#admin-service) | Configures which of the admin server's WebLogic admin channels should be exposed outside the Kubernetes cluster via a node port service. |
@@ -63,6 +67,7 @@ AdminServer represents the operator configuration for the admin server.
6367
### Cluster
6468

6569
An element representing a cluster in the domain configuration.
70+
6671
| Name | Type | Description |
6772
| --- | --- | --- |
6873
| clusterName | string | The name of this cluster. Required |
@@ -78,6 +83,7 @@ An element representing a cluster in the domain configuration.
7883
### Managed Server
7984

8085
ManagedServer represents the operator configuration for a single managed server.
86+
8187
| Name | Type | Description |
8288
| --- | --- | --- |
8389
| restartVersion | string | If present, every time this value is updated the operator will restart the required servers. |
@@ -90,6 +96,7 @@ ManagedServer represents the operator configuration for a single managed server.
9096
### Server Pod
9197

9298
ServerPod describes the configuration for a Kubernetes pod for a server.
99+
93100
| Name | Type | Description |
94101
| --- | --- | --- |
95102
| annotations | | The annotations to be attached to generated resources. |
@@ -167,6 +174,7 @@ ServerPod describes the configuration for a Kubernetes pod for a server.
167174
### Channel
168175

169176
Describes a single channel used by the admin server.
177+
170178
| Name | Type | Description |
171179
| --- | --- | --- |
172180
| channelName | string | Name of channel.<br/>'default' refers to the admin server's default channel (configured via the ServerMBean's ListenPort) <br/>'default-secure' refers to the admin server's default secure channel (configured via the ServerMBean's SSLMBean's ListenPort) <br/>'default-admin' refers to the admin server's default administrative channel (configured via the DomainMBean's AdministrationPort) <br/>Otherwise, the name is the name of one of the admin server's network access points (configured via the ServerMBean's NetworkAccessMBeans). |

docs/domains/k8s1.9.0.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
### Object Meta
77

88
ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
9+
910
| Name | Type | Description |
1011
| --- | --- | --- |
1112
| annotations | | Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations |
@@ -28,13 +29,15 @@ ObjectMeta is metadata that all persisted resources must have, which includes al
2829
### Local Object Reference
2930

3031
LocalObjectReference contains enough information to let you locate the referenced object inside the same namespace.
32+
3133
| Name | Type | Description |
3234
| --- | --- | --- |
3335
| name | string | Name of the referent. More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
3436

3537
### Secret Reference
3638

3739
SecretReference represents a Secret Reference. It has enough information to retrieve secret in any namespace
40+
3841
| Name | Type | Description |
3942
| --- | --- | --- |
4043
| name | string | Name is unique within a namespace to reference a secret resource. |
@@ -43,6 +46,7 @@ SecretReference represents a Secret Reference. It has enough information to retr
4346
### Security Context
4447

4548
SecurityContext holds security configuration that will be applied to a container. Some fields are present in both SecurityContext and PodSecurityContext. When both are set, the values in SecurityContext take precedence.
49+
4650
| Name | Type | Description |
4751
| --- | --- | --- |
4852
| allowPrivilegeEscalation | boolean | AllowPrivilegeEscalation controls whether a process can gain more privileges than its parent process. This bool directly controls if the no_new_privs flag will be set on the container process. AllowPrivilegeEscalation is true always when the container is: 1) run as Privileged 2) has CAP_SYS_ADMIN |
@@ -56,6 +60,7 @@ SecurityContext holds security configuration that will be applied to a container
5660
### Env Var
5761

5862
EnvVar represents an environment variable present in a Container.
63+
5964
| Name | Type | Description |
6065
| --- | --- | --- |
6166
| name | string | Name of the environment variable. Must be a C_IDENTIFIER. |
@@ -65,6 +70,7 @@ EnvVar represents an environment variable present in a Container.
6570
### Pod Security Context
6671

6772
PodSecurityContext holds pod-level security attributes and common container settings. Some fields are also present in container.securityContext. Field values of container.securityContext take precedence over field values of PodSecurityContext.
73+
6874
| Name | Type | Description |
6975
| --- | --- | --- |
7076
| fsGroup | | A special supplemental group that applies to all containers in a pod. Some volume types allow the Kubelet to change the ownership of that volume to be owned by the pod:<br/><br/>1. The owning GID will be the FSGroup 2. The setgid bit is set (new files created in the volume will be owned by FSGroup) 3. The permission bits are OR'd with rw-rw----<br/><br/>If unset, the Kubelet will not modify the ownership and permissions of any volume. |
@@ -76,6 +82,7 @@ PodSecurityContext holds pod-level security attributes and common container sett
7682
### Resource Requirements
7783

7884
ResourceRequirements describes the compute resource requirements.
85+
7986
| Name | Type | Description |
8087
| --- | --- | --- |
8188
| limits | | Limits describes the maximum amount of compute resources allowed. More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/ |
@@ -84,6 +91,7 @@ ResourceRequirements describes the compute resource requirements.
8491
### Volume Mount
8592

8693
VolumeMount describes a mounting of a Volume within a container.
94+
8795
| Name | Type | Description |
8896
| --- | --- | --- |
8997
| mountPath | string | Path within the container at which the volume should be mounted. Must not contain ':'. |
@@ -95,6 +103,7 @@ VolumeMount describes a mounting of a Volume within a container.
95103
### Volume
96104

97105
Volume represents a named volume in a pod that may be accessed by any container in the pod.
106+
98107
| Name | Type | Description |
99108
| --- | --- | --- |
100109
| awsElasticBlockStore | [AWS Elastic Block Store Volume Source](#aws-elastic-block-store-volume-source) | AWSElasticBlockStore represents an AWS Disk resource that is attached to a kubelet's host machine and then exposed to the pod. More info: https://kubernetes.io/docs/concepts/storage/volumes#awselasticblockstore |

json-schema/src/main/java/oracle/kubernetes/json/YamlDocGenerator.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ public String generate(String reference, Map<String, Object> schema) {
3737
referencesNeeded.remove(reference);
3838
StringBuilder sb = new StringBuilder("### ");
3939
sb.append(toStructureName(reference)).append("\n\n");
40-
Optional.ofNullable(getDescription(schema)).ifPresent(s -> sb.append(s).append("\n"));
40+
Optional.ofNullable(getDescription(schema)).ifPresent(s -> sb.append(s).append("\n\n"));
4141
sb.append(generateForClass(schema));
4242
while (!referencesNeeded.isEmpty()) {
4343
generateForDefinition(sb, referencesNeeded.get(0));

json-schema/src/test/java/oracle/kubernetes/json/YamlDocGeneratorTest.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -180,6 +180,7 @@ public void generateMarkdownWithReferencedSections() {
180180
"### Derived Object",
181181
"",
182182
"A simple object used for testing",
183+
"",
183184
tableHeader(),
184185
tableEntry("aBoolean", "boolean", "A flag"),
185186
tableEntry("anInt", "number", "An int<br/>value"))));
@@ -249,6 +250,7 @@ public void whenExternalSchemaSpecified_generateMarkdownForIt() throws IOExcepti
249250
"### Env Var",
250251
"",
251252
"EnvVar represents an environment variable present in a Container.",
253+
"",
252254
tableHeader(),
253255
tableEntry(
254256
"name",

0 commit comments

Comments
 (0)