GITBOOK-60: Extract quickstart pages into separate section

Author: Haarolean

SUMMARY.md

@@ -21,10 +21,19 @@
   * [Without Docker](development/building/without-docker.md)
 * [WIP: Testing](development/wip-testing.md)
 
+## ⚡ Quick Start
+
+* [🔍 Prerequisites](quick-start/prerequisites/README.md)
+  * [Kafka Permissions](quick-start/prerequisites/permissions/README.md)
+    * [Standalone Kafka ACLs](quick-start/prerequisites/permissions/required-acls.md)
+    * [MSK (+Serverless) Setup](quick-start/prerequisites/permissions/msk-+serverless-setup.md)
+* [Demo run](quick-start/demo-run.md)
+* [AWS Marketplace](quick-start/via-aws-marketplace.md)
+* [Persistent start](quick-start/persistent-start.md)
+* [K8s / Helm](quick-start/k8s-helm.md)
+
 ## 🛠 Configuration
 
-* [Quick Start](configuration/quick-start/README.md)
-  * [via AWS Marketplace](configuration/quick-start/via-aws-marketplace.md)
 * [Configuration wizard](configuration/configuration-wizard.md)
 * [Configuration file](configuration/configuration-file.md)
 * [Compose examples](configuration/compose-examples.md)
@@ -35,9 +44,6 @@
   * [Resource limits](configuration/helm-charts/resource-limits.md)
   * [Sticky sessions](configuration/helm-charts/sticky-sessions.md)
 * [Misc configuration properties](configuration/misc-configuration-properties.md)
-* [Required Kafka Permissions](configuration/permissions/README.md)
-  * [Required Kafka ACLs](configuration/configuration/required-acls.md)
-  * [MSK (+Serverless) Setup](configuration/permissions/msk-+serverless-setup.md)
 * [Complex configuration examples](configuration/configuration/complex-configuration-examples/README.md)
   * [Kraft mode + multiple brokers](configuration/configuration/complex-configuration-examples/kraft-mode-+-multiple-brokers.md)
 * [Kafka w/ SSL](configuration/ssl.md)

configuration/authentication/aws-iam.md

@@ -10,7 +10,7 @@ You could pass SASL configs in the properties section for each cluster.
 
 More details could be found here: [aws-msk-iam-auth](https://github.com/aws/aws-msk-iam-auth)
 
-More about permissions: [msk-+serverless-setup.md](../permissions/msk-+serverless-setup.md "mention")
+More about permissions: [msk-+serverless-setup.md](../../quick-start/prerequisites/permissions/msk-+serverless-setup.md "mention")
 
 ### Examples:
 

configuration/quick-start/README.md

@@ -10,7 +10,7 @@ A good resource for what properties are needed is here: https://gist.github.com/
 
 ## Cluster authorization failed
 
-Check the [required permissions](../configuration/configuration/required-acls.md).
+Check the [required permissions](../quick-start/prerequisites/permissions/required-acls.md).
 
 ## AWS MSK w/ IAM: Access denied
 

faq/common-problems.md

@@ -0,0 +1,17 @@
+---
+description: Quick start (demo run)
+---
+
+# Demo run
+
+1. Ensure you have docker installed
+2. Ensure your kafka cluster is available from the machine you're planning to run the app on
+3. Run the following:
+
+```
+docker run -it -p 8080:8080 -e DYNAMIC_CONFIG_ENABLED=true provectuslabs/kafka-ui
+```
+
+4. Go to \`[http://localhost:8080/ui/clusters/create-new-cluster](http://localhost:8080/ui/clusters/create-new-cluster)\` and configure your first cluster by pressing on "Configure new cluster" button.
+
+When you're done with testing, you can refer to the next articles to persist your config & deploy the app wherever you need to.

quick-start/demo-run.md

@@ -0,0 +1,3 @@
+# K8s / Helm
+
+To install the app via Helm please refer to [this page](../configuration/helm-charts/quick-start.md).

quick-start/k8s-helm.md

@@ -0,0 +1,22 @@
+# Persistent start
+
+Please ensure the target volume (`~/kui/config.yml`) of your config file does exist.
+
+Create a yml file with the following contents:
+
+```
+services:
+  kafka-ui:
+    container_name: kafka-ui
+    image: provectuslabs/kafka-ui:latest
+    ports:
+      - 8080:8080
+    environment:
+      DYNAMIC_CONFIG_ENABLED: true
+    volumes:
+      - ~/kui/config.yml:/etc/kafkaui/dynamic_config.yaml
+```
+
+Run the compose via:
+
+`docker-compose -f <your-file>.yml up -d`

quick-start/persistent-start.md

@@ -0,0 +1,5 @@
+# 🔍 Prerequisites
+
+{% content-ref url="permissions/" %}
+[permissions](permissions/)
+{% endcontent-ref %}

quick-start/prerequisites/README.md

@@ -2,7 +2,7 @@
 description: How to Deploy Kafka UI from AWS Marketplace
 ---
 
-# via AWS Marketplace
+# AWS Marketplace
 
 ### Step 1: Go to AWS Marketplace
 
@@ -50,6 +50,6 @@ Example: `ec2-xx-xxx-x-xx.us-west-2.compute.amazonaws.com:8080`
 If your broker is deployed in AWS then allow incoming from Kafka-ui EC2 by adding an ingress rule in the security group which is used for a broker.\
 If your broker is not in AWS then be sure that your broker can handle requests from Kafka-ui EC2 IP address.
 
-More about permissions: [msk-+serverless-setup.md](../permissions/msk-+serverless-setup.md "mention")
+More about permissions: [msk-+serverless-setup.md](prerequisites/permissions/msk-+serverless-setup.md "mention")
 
 That's it! You've successfully deployed the Kafka UI from AWS Marketplace.