Update generated docs

.circleci/config.yml

@@ -1,5 +1,19 @@
 version: 2.1
 
+parameters:
+  remote-trigger:
+    type: boolean
+    default: false
+  project:
+    type: string
+    default: ""
+  release-tag:
+    type: string
+    default: ""
+  build-dir:
+    type: string
+    default: ""
+
 jobs:
   trigger-submodule-update:
     docker:
@@ -11,8 +25,30 @@ jobs:
           name: Trigger
           command: scripts/trigger-submodule-update.sh
 
+  update-generated-docs:
+    docker:
+      - image: cimg/go:1.14
+    resource_class: small
+    steps:
+      - checkout
+      - run:
+          name: Setup git
+          command: |
+            git config --global user.email "[email protected]"
+            git config --global user.name "CircleCI"
+            git config --global --unset url.ssh://[email protected]
+            git config --global url."https://${GITHUB_TOKEN}:@github.com/".insteadOf "[email protected]:"
+      - run:
+          name: Update docs
+          command: |
+            scripts/update-generated-docs.sh \
+              "<<pipeline.parameters.project>>" \
+              "<<pipeline.parameters.release-tag>>" \
+              "<<pipeline.parameters.build-dir>>"
+
 workflows:
-  ci:
+  docgen:
+    when: << pipeline.parameters.project >>
     jobs:
       - trigger-submodule-update:
           filters:

docs/types/_index.md

@@ -0,0 +1,12 @@
+---
+title: CRDs
+weight: 1000
+generated_file: true
+---
+
+The following types are available. For details, click on the name of a type. 
+
+- **[common_types](common_types)** 
+- **[kafkacluster_types](kafkacluster_types)** 
+
+

docs/types/common_types.md

@@ -0,0 +1,132 @@
+---
+title: Common types
+weight: 200
+generated_file: true
+---
+
+## KafkaVersion
+
+KafkaVersion type describes the kafka version and docker version
+
+### version (string, optional) {#kafkaversion-version}
+
+Version holds the current version of the broker in semver format<br>
+
+Default: -
+
+### image (string, optional) {#kafkaversion-image}
+
+Image specifies the current docker image of the broker<br>
+
+Default: -
+
+
+## GracefulActionState
+
+GracefulActionState holds information about GracefulAction State
+
+### errorMessage (string, required) {#gracefulactionstate-errormessage}
+
+ErrorMessage holds the information what happened with CC<br>
+
+Default: -
+
+### cruiseControlTaskId (string, optional) {#gracefulactionstate-cruisecontroltaskid}
+
+CruiseControlTaskId holds info about the task id ran by CC<br>
+
+Default: -
+
+### TaskStarted (string, optional) {#gracefulactionstate-taskstarted}
+
+TaskStarted hold the time when the execution started<br>
+
+Default: -
+
+### cruiseControlState (CruiseControlState, required) {#gracefulactionstate-cruisecontrolstate}
+
+CruiseControlState holds the information about CC state<br>
+
+Default: -
+
+### volumeStates (map[string]VolumeState, optional) {#gracefulactionstate-volumestates}
+
+VolumeStates holds the information about the CC disk rebalance states and tasks<br>
+
+Default: -
+
+
+## VolumeState
+
+### errorMessage (string, required) {#volumestate-errormessage}
+
+ErrorMessage holds the information what happened with CC disk rebalance<br>
+
+Default: -
+
+### cruiseControlTaskId (string, optional) {#volumestate-cruisecontroltaskid}
+
+CruiseControlTaskId holds info about the task id ran by CC<br>
+
+Default: -
+
+### TaskStarted (string, optional) {#volumestate-taskstarted}
+
+TaskStarted hold the time when the execution started<br>
+
+Default: -
+
+### cruiseControlVolumeState (CruiseControlVolumeState, required) {#volumestate-cruisecontrolvolumestate}
+
+CruiseControlVolumeState holds the information about the CC disk rebalance state<br>
+
+Default: -
+
+
+## BrokerState
+
+BrokerState holds information about broker state
+
+### rackAwarenessState (RackAwarenessState, required) {#brokerstate-rackawarenessstate}
+
+RackAwarenessState holds info about rack awareness status<br>
+
+Default: -
+
+### gracefulActionState (GracefulActionState, required) {#brokerstate-gracefulactionstate}
+
+GracefulActionState holds info about cc action status<br>
+
+Default: -
+
+### configurationState (ConfigurationState, required) {#brokerstate-configurationstate}
+
+ConfigurationState holds info about the config<br>
+
+Default: -
+
+### perBrokerConfigurationState (PerBrokerConfigurationState, required) {#brokerstate-perbrokerconfigurationstate}
+
+PerBrokerConfigurationState holds info about the per-broker (dynamically updatable) config<br>
+
+Default: -
+
+### externalListenerConfigNames (ExternalListenerConfigNames, optional) {#brokerstate-externallistenerconfignames}
+
+ExternalListenerConfigNames holds info about what listener config is in use with the broker<br>
+
+Default: -
+
+### version (string, optional) {#brokerstate-version}
+
+Version holds the current version of the broker in semver format<br>
+
+Default: -
+
+### image (string, optional) {#brokerstate-image}
+
+Image specifies the current docker image of the broker<br>
+
+Default: -
+
+