Merge pull request #824 from oracle/enhance_markdown_generation

OWLS-71147 Enhance markdown generation

Author: rjeberhard

docs/domains/Domain.json

@@ -1,8 +1,10 @@
 {
   "$schema": "http://json-schema.org/draft-04/schema#",
+  "description": "Domain represents a WebLogic domain and how it will be realized in the Kubernetes cluster.",
   "type": "object",
   "definitions": {
     "AdminServer": {
+      "description": "AdminServer represents the operator configuration for the admin server.",
       "type": "object",
       "properties": {
         "serverStartState": {
@@ -53,10 +55,11 @@
       }
     },
     "Channel": {
+      "description": "Describes a single channel used by the admin server.",
       "type": "object",
       "properties": {
         "channelName": {
-          "description": "Name of channel. default\u0027 refers to the admin server\u0027s default channel (configured via the ServerMBean\u0027s ListenPort) \u0027default-secure\u0027 refers to the admin server\u0027s default secure channel (configured via the ServerMBean\u0027s SSLMBean\u0027s ListenPort) \u0027default-admin\u0027 refers to the admin server\u0027s default administrative channel (configured via the DomainMBean\u0027s AdministrationPort) Otherwise, the name is the name of one of the admin server\u0027s network access points (configured via the ServerMBean\u0027s NetworkAccessMBeans).",
+          "description": "Name of channel.\n\u0027default\u0027 refers to the admin server\u0027s default channel (configured via the ServerMBean\u0027s ListenPort) \n\u0027default-secure\u0027 refers to the admin server\u0027s default secure channel (configured via the ServerMBean\u0027s SSLMBean\u0027s ListenPort) \n\u0027default-admin\u0027 refers to the admin server\u0027s default administrative channel (configured via the DomainMBean\u0027s AdministrationPort) \nOtherwise, the name is the name of one of the admin server\u0027s network access points (configured via the ServerMBean\u0027s NetworkAccessMBeans).",
           "type": "string"
         },
         "nodePort": {
@@ -69,6 +72,7 @@
       ]
     },
     "Cluster": {
+      "description": "An element representing a cluster in the domain configuration.",
       "type": "object",
       "properties": {
         "serverStartState": {
@@ -156,6 +160,7 @@
       }
     },
     "DomainSpec": {
+      "description": "DomainSpec is a description of a domain.",
       "type": "object",
       "properties": {
         "serverStartState": {
@@ -273,6 +278,7 @@
       }
     },
     "DomainStatus": {
+      "description": "DomainStatus represents information about the status of a domain. Status may trail the actual state of a system.",
       "type": "object",
       "properties": {
         "reason": {
@@ -322,6 +328,7 @@
       }
     },
     "ManagedServer": {
+      "description": "ManagedServer represents the operator configuration for a single managed server.",
       "type": "object",
       "properties": {
         "serverStartState": {
@@ -404,6 +411,7 @@
       }
     },
     "ServerPod": {
+      "description": "ServerPod describes the configuration for a Kubernetes pod for a server.",
       "type": "object",
       "properties": {
         "livenessProbe": {

docs/domains/Domain.md

@@ -924,6 +924,7 @@
       "properties": {}
     },
     "AdminServer": {
+      "description": "AdminServer represents the operator configuration for the admin server.",
       "type": "object",
       "properties": {
         "serverStartState": {
@@ -974,10 +975,11 @@
       }
     },
     "Channel": {
+      "description": "Describes a single channel used by the admin server.",
       "type": "object",
       "properties": {
         "channelName": {
-          "description": "Name of channel. default\u0027 refers to the admin server\u0027s default channel (configured via the ServerMBean\u0027s ListenPort) \u0027default-secure\u0027 refers to the admin server\u0027s default secure channel (configured via the ServerMBean\u0027s SSLMBean\u0027s ListenPort) \u0027default-admin\u0027 refers to the admin server\u0027s default administrative channel (configured via the DomainMBean\u0027s AdministrationPort) Otherwise, the name is the name of one of the admin server\u0027s network access points (configured via the ServerMBean\u0027s NetworkAccessMBeans).",
+          "description": "Name of channel.\n\u0027default\u0027 refers to the admin server\u0027s default channel (configured via the ServerMBean\u0027s ListenPort) \n\u0027default-secure\u0027 refers to the admin server\u0027s default secure channel (configured via the ServerMBean\u0027s SSLMBean\u0027s ListenPort) \n\u0027default-admin\u0027 refers to the admin server\u0027s default administrative channel (configured via the DomainMBean\u0027s AdministrationPort) \nOtherwise, the name is the name of one of the admin server\u0027s network access points (configured via the ServerMBean\u0027s NetworkAccessMBeans).",
           "type": "string"
         },
         "nodePort": {
@@ -990,6 +992,7 @@
       ]
     },
     "Cluster": {
+      "description": "An element representing a cluster in the domain configuration.",
       "type": "object",
       "properties": {
         "serverStartState": {
@@ -1077,6 +1080,7 @@
       }
     },
     "DomainSpec": {
+      "description": "DomainSpec is a description of a domain.",
       "type": "object",
       "properties": {
         "serverStartState": {
@@ -1194,6 +1198,7 @@
       }
     },
     "DomainStatus": {
+      "description": "DomainStatus represents information about the status of a domain. Status may trail the actual state of a system.",
       "type": "object",
       "properties": {
         "reason": {
@@ -1243,6 +1248,7 @@
       }
     },
     "ManagedServer": {
+      "description": "ManagedServer represents the operator configuration for a single managed server.",
       "type": "object",
       "properties": {
         "serverStartState": {
@@ -1325,6 +1331,7 @@
       }
     },
     "ServerPod": {
+      "description": "ServerPod describes the configuration for a Kubernetes pod for a server.",
       "type": "object",
       "properties": {
         "livenessProbe": {