[Documentation] Improve rendering for enums, add missing values for Backup State (#1560)

Author: nikita-vanyasin

docs/api/ArangoBackup.V1.md

@@ -243,23 +243,23 @@ Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2
 
 ### .status.message
 
-Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_state.go#L88)</sup>
+Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_state.go#L91)</sup>
 
 Message for the state this object is in.
 
 ***
 
 ### .status.progress.jobID
 
-Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_state.go#L111)</sup>
+Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_state.go#L114)</sup>
 
 JobID ArangoDB job ID for uploading or downloading
 
 ***
 
 ### .status.progress.progress
 
-Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_state.go#L114)</sup>
+Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_state.go#L117)</sup>
 
 Progress ArangoDB job progress in percents
 
@@ -272,22 +272,25 @@ Example:
 
 ### .status.state
 
-Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_state.go#L82)</sup>
+Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2.36/pkg/apis/backup/v1/backup_state.go#L85)</sup>
 
 State holds the current high level state of the backup
 
 Possible Values: 
-* Pending (default) - state in which Custom Resource is queued. If Backup is possible changed to "Scheduled"
-* Scheduled - state which will start create/download process
-* Download - state in which download request will be created on ArangoDB
-* DownloadError - state when download failed
-* Downloading - state for downloading progress
-* Create - state for creation, field available set to true
-* Upload - state in which upload request will be created on ArangoDB
-* Uploading - state for uploading progress
-* UploadError - state when uploading failed
-* Ready - state when Backup is finished
-* Deleted - state when Backup was once in ready, but has been deleted
-* Failed - state for failure
-* Unavailable - state when Backup is not available on the ArangoDB. It can happen in case of upgrades, node restarts etc.
+* `""` (default) - state for un-initialized Custom Resource
+* `"Pending"` - state in which Custom Resource is queued. If Backup is possible changed to "Scheduled"
+* `"Scheduled"` - state which will start create/download process
+* `"Download"` - state in which download request will be created on ArangoDB
+* `"DownloadError"` - state when download failed
+* `"Downloading"` - state for downloading progress
+* `"Create"` - state for backup when it is scheduled for creation, field available set to true
+* `"Creating"` - state for backup when it is creating
+* `"CreateError"` - state for backup when it is creation failed
+* `"Upload"` - state in which upload request will be created on ArangoDB
+* `"Uploading"` - state for uploading progress
+* `"UploadError"` - state when uploading failed
+* `"Ready"` - state when Backup is finished
+* `"Deleted"` - state when Backup was once in ready, but has been deleted
+* `"Failed"` - state for failure
+* `"Unavailable"` - state when Backup is not available on the ArangoDB. It can happen in case of upgrades, node restarts etc.
 

docs/api/ArangoDeployment.V1.md

@@ -156,8 +156,8 @@ Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2
 IndexMethod define group Indexing method
 
 Possible Values: 
-* random (default) - Pick random ID for member. Enforced on the Community Operator.
-* ordered - Use sequential number as Member ID, starting from 0. Enterprise Operator required.
+* `"random"` (default) - Pick random ID for member. Enforced on the Community Operator.
+* `"ordered"` - Use sequential number as Member ID, starting from 0. Enterprise Operator required.
 
 ***
 
@@ -577,8 +577,8 @@ Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2
 VolumeResizeMode specified resize mode for PVCs and PVs
 
 Possible Values: 
-* runtime (default) - PVC will be resized in Pod runtime (EKS, GKE)
-* rotate - Pod will be shutdown and PVC will be resized (AKS)
+* `"runtime"` (default) - PVC will be resized in Pod runtime (EKS, GKE)
+* `"rotate"` - Pod will be shutdown and PVC will be resized (AKS)
 
 ***
 
@@ -939,9 +939,9 @@ Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2
 AnnotationsMode defines annotations mode which should be use while overriding annotations.
 
 Possible Values: 
-* disabled (default) - Disable annotations/labels override. Default if there is no annotations/labels set in ArangoDeployment
-* append - Add new annotations/labels without affecting old ones
-* replace - Replace existing annotations/labels
+* `"disabled"` (default) - Disable annotations/labels override. Default if there is no annotations/labels set in ArangoDeployment
+* `"append"` - Add new annotations/labels without affecting old ones
+* `"replace"` - Replace existing annotations/labels
 
 ***
 
@@ -1040,11 +1040,11 @@ Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2
 CommunicationMethod define communication method used in deployment
 
 Possible Values: 
-* headless (default) - Define old communication mechanism, based on headless service.
-* dns - Define ClusterIP Service DNS based communication.
-* short-dns - Define ClusterIP Service DNS based communication. Use namespaced short DNS (used in migration)
-* headless-dns - Define Headless Service DNS based communication.
-* ip - Define ClusterIP Service IP based communication.
+* `"headless"` (default) - Define old communication mechanism, based on headless service.
+* `"dns"` - Define ClusterIP Service DNS based communication.
+* `"short-dns"` - Define ClusterIP Service DNS based communication. Use namespaced short DNS (used in migration)
+* `"headless-dns"` - Define Headless Service DNS based communication.
+* `"ip"` - Define ClusterIP Service IP based communication.
 
 ***
 
@@ -1202,8 +1202,8 @@ Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2
 IndexMethod define group Indexing method
 
 Possible Values: 
-* random (default) - Pick random ID for member. Enforced on the Community Operator.
-* ordered - Use sequential number as Member ID, starting from 0. Enterprise Operator required.
+* `"random"` (default) - Pick random ID for member. Enforced on the Community Operator.
+* `"ordered"` - Use sequential number as Member ID, starting from 0. Enterprise Operator required.
 
 ***
 
@@ -1623,8 +1623,8 @@ Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2
 VolumeResizeMode specified resize mode for PVCs and PVs
 
 Possible Values: 
-* runtime (default) - PVC will be resized in Pod runtime (EKS, GKE)
-* rotate - Pod will be shutdown and PVC will be resized (AKS)
+* `"runtime"` (default) - PVC will be resized in Pod runtime (EKS, GKE)
+* `"rotate"` - Pod will be shutdown and PVC will be resized (AKS)
 
 ***
 
@@ -2116,8 +2116,8 @@ Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2
 IndexMethod define group Indexing method
 
 Possible Values: 
-* random (default) - Pick random ID for member. Enforced on the Community Operator.
-* ordered - Use sequential number as Member ID, starting from 0. Enterprise Operator required.
+* `"random"` (default) - Pick random ID for member. Enforced on the Community Operator.
+* `"ordered"` - Use sequential number as Member ID, starting from 0. Enterprise Operator required.
 
 ***
 
@@ -2537,8 +2537,8 @@ Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2
 VolumeResizeMode specified resize mode for PVCs and PVs
 
 Possible Values: 
-* runtime (default) - PVC will be resized in Pod runtime (EKS, GKE)
-* rotate - Pod will be shutdown and PVC will be resized (AKS)
+* `"runtime"` (default) - PVC will be resized in Pod runtime (EKS, GKE)
+* `"rotate"` - Pod will be shutdown and PVC will be resized (AKS)
 
 ***
 
@@ -2902,8 +2902,8 @@ Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2
 Environment setting specifies the type of environment in which the deployment is created.
 
 Possible Values: 
-* Development (default) - This value optimizes the deployment for development use. It is possible to run a deployment on a small number of nodes (e.g. minikube).
-* Production - This value optimizes the deployment for production use. It puts required affinity constraints on all pods to avoid Agents & DB-Servers from running on the same machine.
+* `"Development"` (default) - This value optimizes the deployment for development use. It is possible to run a deployment on a small number of nodes (e.g. minikube).
+* `"Production"` - This value optimizes the deployment for production use. It puts required affinity constraints on all pods to avoid Agents & DB-Servers from running on the same machine.
 
 ***
 
@@ -2964,10 +2964,10 @@ Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2
 Type specifies the type of Service that will be created to provide access to the ArangoDB deployment from outside the Kubernetes cluster.
 
 Possible Values: 
-* Auto (default) - Create a Service of type LoadBalancer and fallback to a Service or type NodePort when the LoadBalancer is not assigned an IP address.
-* None - limit access to application running inside the Kubernetes cluster.
-* LoadBalancer - Create a Service of type LoadBalancer for the ArangoDB deployment.
-* NodePort - Create a Service of type NodePort for the ArangoDB deployment.
+* `"Auto"` (default) - Create a Service of type LoadBalancer and fallback to a Service or type NodePort when the LoadBalancer is not assigned an IP address.
+* `"None"` - limit access to application running inside the Kubernetes cluster.
+* `"LoadBalancer"` - Create a Service of type LoadBalancer for the ArangoDB deployment.
+* `"NodePort"` - Create a Service of type NodePort for the ArangoDB deployment.
 
 ***
 
@@ -3218,8 +3218,8 @@ Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2
 ImageDiscoveryMode specifies the image discovery mode.
 
 Possible Values: 
-* kubelet (default) - Use sha256 of the discovered image in the pods
-* direct - Use image provided in the spec.image directly in the pods
+* `"kubelet"` (default) - Use sha256 of the discovered image in the pods
+* `"direct"` - Use image provided in the spec.image directly in the pods
 
 ***
 
@@ -3233,9 +3233,9 @@ Links:
 * [Documentation of core.PullPolicy](https://kubernetes.io/docs/concepts/containers/images/#image-pull-policy)
 
 Possible Values: 
-* Always (default) - Means that kubelet always attempts to pull the latest image. Container will fail If the pull fails.
-* Never - Means that kubelet never pulls an image, but only uses a local image. Container will fail if the image isn't present
-* IfNotPresent - Means that kubelet pulls if the image isn't present on disk. Container will fail if the image isn't present and the pull fails.
+* `"Always"` (default) - Means that kubelet always attempts to pull the latest image. Container will fail If the pull fails.
+* `"Never"` - Means that kubelet never pulls an image, but only uses a local image. Container will fail if the image isn't present
+* `"IfNotPresent"` - Means that kubelet pulls if the image isn't present on disk. Container will fail if the image isn't present and the pull fails.
 
 ***
 
@@ -3270,9 +3270,9 @@ Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2
 LabelsMode Define labels mode which should be use while overriding labels
 
 Possible Values: 
-* disabled (default) - Disable annotations/labels override. Default if there is no annotations/labels set in ArangoDeployment
-* append - Add new annotations/labels without affecting old ones
-* replace - Replace existing annotations/labels
+* `"disabled"` (default) - Disable annotations/labels override. Default if there is no annotations/labels set in ArangoDeployment
+* `"append"` - Add new annotations/labels without affecting old ones
+* `"replace"` - Replace existing annotations/labels
 
 ***
 
@@ -3308,8 +3308,8 @@ The propagation of the configuration changes can be deferred to the next restart
 This reduces the number of restarts for upgrading both the server and the operator from two to one.
 
 Possible Values: 
-* always (default) - Restart the member as soon as a configuration change is discovered
-* on-restart - Wait until the next restart to change the member configuration
+* `"always"` (default) - Restart the member as soon as a configuration change is discovered
+* `"on-restart"` - Wait until the next restart to change the member configuration
 
 ***
 
@@ -3399,9 +3399,9 @@ Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2
 Mode specifies the type of ArangoDB deployment to create.
 
 Possible Values: 
-* Cluster (default) - Full cluster. Defaults to 3 Agents, 3 DB-Servers & 3 Coordinators.
-* ActiveFailover - Active-failover single pair. Defaults to 3 Agents and 2 single servers.
-* Single - Single server only (note this does not provide high availability or reliability).
+* `"Cluster"` (default) - Full cluster. Defaults to 3 Agents, 3 DB-Servers & 3 Coordinators.
+* `"ActiveFailover"` - Active-failover single pair. Defaults to 3 Agents and 2 single servers.
+* `"Single"` - Single server only (note this does not provide high availability or reliability).
 
 This field is **immutable**: Change of the ArangoDeployment Mode is not possible after creation.
 
@@ -3644,8 +3644,8 @@ Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2
 IndexMethod define group Indexing method
 
 Possible Values: 
-* random (default) - Pick random ID for member. Enforced on the Community Operator.
-* ordered - Use sequential number as Member ID, starting from 0. Enterprise Operator required.
+* `"random"` (default) - Pick random ID for member. Enforced on the Community Operator.
+* `"ordered"` - Use sequential number as Member ID, starting from 0. Enterprise Operator required.
 
 ***
 
@@ -4065,8 +4065,8 @@ Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2
 VolumeResizeMode specified resize mode for PVCs and PVs
 
 Possible Values: 
-* runtime (default) - PVC will be resized in Pod runtime (EKS, GKE)
-* rotate - Pod will be shutdown and PVC will be resized (AKS)
+* `"runtime"` (default) - PVC will be resized in Pod runtime (EKS, GKE)
+* `"rotate"` - Pod will be shutdown and PVC will be resized (AKS)
 
 ***
 
@@ -4403,8 +4403,8 @@ Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2
 StorageEngine specifies the type of storage engine used for all servers in the cluster.
 
 Possible Values: 
-* RocksDB (default) - To use the RocksDB storage engine.
-* MMFiles - To use the MMFiles storage engine. Deprecated.
+* `"RocksDB"` (default) - To use the RocksDB storage engine.
+* `"MMFiles"` - To use the MMFiles storage engine. Deprecated.
 
 This field is **immutable**: This setting cannot be changed after the cluster has been created.
 
@@ -4529,10 +4529,10 @@ Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2
 Type specifies the type of Service that will be created to provide access to the ArangoDB deployment from outside the Kubernetes cluster.
 
 Possible Values: 
-* Auto (default) - Create a Service of type LoadBalancer and fallback to a Service or type NodePort when the LoadBalancer is not assigned an IP address.
-* None - limit access to application running inside the Kubernetes cluster.
-* LoadBalancer - Create a Service of type LoadBalancer for the ArangoDB deployment.
-* NodePort - Create a Service of type NodePort for the ArangoDB deployment.
+* `"Auto"` (default) - Create a Service of type LoadBalancer and fallback to a Service or type NodePort when the LoadBalancer is not assigned an IP address.
+* `"None"` - limit access to application running inside the Kubernetes cluster.
+* `"LoadBalancer"` - Create a Service of type LoadBalancer for the ArangoDB deployment.
+* `"NodePort"` - Create a Service of type NodePort for the ArangoDB deployment.
 
 ***
 
@@ -4759,8 +4759,8 @@ Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2
 IndexMethod define group Indexing method
 
 Possible Values: 
-* random (default) - Pick random ID for member. Enforced on the Community Operator.
-* ordered - Use sequential number as Member ID, starting from 0. Enterprise Operator required.
+* `"random"` (default) - Pick random ID for member. Enforced on the Community Operator.
+* `"ordered"` - Use sequential number as Member ID, starting from 0. Enterprise Operator required.
 
 ***
 
@@ -5180,8 +5180,8 @@ Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2
 VolumeResizeMode specified resize mode for PVCs and PVs
 
 Possible Values: 
-* runtime (default) - PVC will be resized in Pod runtime (EKS, GKE)
-* rotate - Pod will be shutdown and PVC will be resized (AKS)
+* `"runtime"` (default) - PVC will be resized in Pod runtime (EKS, GKE)
+* `"rotate"` - Pod will be shutdown and PVC will be resized (AKS)
 
 ***
 
@@ -5665,8 +5665,8 @@ Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2
 IndexMethod define group Indexing method
 
 Possible Values: 
-* random (default) - Pick random ID for member. Enforced on the Community Operator.
-* ordered - Use sequential number as Member ID, starting from 0. Enterprise Operator required.
+* `"random"` (default) - Pick random ID for member. Enforced on the Community Operator.
+* `"ordered"` - Use sequential number as Member ID, starting from 0. Enterprise Operator required.
 
 ***
 
@@ -6086,8 +6086,8 @@ Type: `string` <sup>[\[ref\]](https://github.com/arangodb/kube-arangodb/blob/1.2
 VolumeResizeMode specified resize mode for PVCs and PVs
 
 Possible Values: 
-* runtime (default) - PVC will be resized in Pod runtime (EKS, GKE)
-* rotate - Pod will be shutdown and PVC will be resized (AKS)
+* `"runtime"` (default) - PVC will be resized in Pod runtime (EKS, GKE)
+* `"rotate"` - Pod will be shutdown and PVC will be resized (AKS)
 
 ***
 

docs/api/ArangoMLExtension.V1Alpha1.md

@@ -273,10 +273,10 @@ Links:
 * [Kubernetes Documentation](https://kubernetes.io/docs/concepts/services-networking/service/#publishing-services-service-types)
 
 Possible Values: 
-* ClusterIP (default) - service will only be accessible inside the cluster, via the cluster IP
-* NodePort - service will be exposed on one port of every node, in addition to 'ClusterIP' type
-* LoadBalancer - service will be exposed via an external load balancer (if the cloud provider supports it), in addition to 'NodePort' type
-* ExternalName - service consists of only a reference to an external name that kubedns or equivalent will return as a CNAME record, with no exposing or proxying of any pods involved
+* `"ClusterIP"` (default) - service will only be accessible inside the cluster, via the cluster IP
+* `"NodePort"` - service will be exposed on one port of every node, in addition to 'ClusterIP' type
+* `"LoadBalancer"` - service will be exposed via an external load balancer (if the cloud provider supports it), in addition to 'NodePort' type
+* `"ExternalName"` - service consists of only a reference to an external name that kubedns or equivalent will return as a CNAME record, with no exposing or proxying of any pods involved
 
 ***