doc(helm-guides): add example app installation (#3508)

* doc(helm-guides): add example app installation * Update docs/self-managed/platform-deployment/helm-kubernetes/guides/installing-payment-example.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Update versioned_docs/version-8.4/self-managed/platform-deployment/helm-kubernetes/guides/installing-payment-example.md Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * Update versioned_docs/version-8.4/self-managed/platform-deployment/helm-kubernetes/guides/installing-payment-example.md Co-authored-by: Maxim Danilov <[email protected]> * Update versioned_docs/version-8.4/self-managed/platform-deployment/helm-kubernetes/guides/installing-payment-example.md Co-authored-by: Maxim Danilov <[email protected]> * doc(helm-guides): update payment app example * Update optimize_sidebars.js Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> * doc(sm): payment app example updated with new doc structure * doc(sm): payment app example add versioned sidebars * style(formatting): technical review * style(formatting): shorten title --------- Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: Maxim Danilov <[email protected]> Co-authored-by: Christina Ausley <[email protected]> Co-authored-by: christinaausley <[email protected]>
camunda · Apr 16, 2024 · 2bb39b1 · 2bb39b1
1 parent 993fe69
commit 2bb39b1
Show file tree

Hide file tree

Showing 10 changed files with 60 additions and 2 deletions.
diff --git a/docs/self-managed/setup/deploy/amazon/amazon-eks/eks-helm.md b/docs/self-managed/setup/deploy/amazon/amazon-eks/eks-helm.md
@@ -419,6 +419,10 @@ kubectl port-forward services/camunda-keycloak 18080:80
   </TabItem>
 </Tabs>
 
+### Testing installation with payment example application
+
+To test your installation with the deployment of a sample application, refer to the [installing payment example guide](../../../guides/installing-payment-example.md).
+
 ### Advanced topics
 
 The following are some advanced configuration topics to consider for your cluster:

diff --git a/docs/self-managed/setup/guides/installing-payment-example.md b/docs/self-managed/setup/guides/installing-payment-example.md
@@ -0,0 +1,13 @@
+---
+id: installing-payment-app-example
+title: "Verifying Camunda 8 installation with a demo app"
+description: "Ensure your installation is functioning properly by learning how to install the payment example process application on Camunda 8 Self-Managed."
+---
+
+Interested in installing a test application that works with your Camunda 8 stack? Follow the guide below.
+
+The payment example process application demonstrates a process application with payment processes, forms, and workers. This serves as an excellent starting point for validating the functionality of your Camunda 8 Self-Managed installation.
+
+To install the payment example process application on Kubernetes, follow the instructions detailed in the [Kubernetes Deployment Tutorial](https://github.com/camunda-community-hub/camunda-8-examples/tree/main/payment-example-process-application/kube/README.md).
+
+For more details about the application, its features, and configuration options, refer to [Camunda 8 Examples: Payment Example Process Application](https://github.com/camunda-community-hub/camunda-8-examples/tree/main/payment-example-process-application).
diff --git a/optimize_sidebars.js b/optimize_sidebars.js
@@ -2216,6 +2216,10 @@ module.exports = {
               "Multi-namespace deployment",
               "self-managed/setup/guides/multi-namespace-deployment/"
             ),
+            docsLink(
+              "Verifying Camunda 8 Installation",
+              "self-managed/setup/guides/installing-payment-app-example/"
+            ),
           ],
         },
       ],

diff --git a/sidebars.js b/sidebars.js
@@ -908,6 +908,7 @@ module.exports = {
             "self-managed/setup/guides/air-gapped-installation",
             "self-managed/setup/guides/running-custom-connectors",
             "self-managed/setup/guides/multi-namespace-deployment",
+            "self-managed/setup/guides/installing-payment-app-example",
           ],
         },
       ],

diff --git a/...anaged/platform-deployment/helm-kubernetes/guides/installing-payment-example.md b/...anaged/platform-deployment/helm-kubernetes/guides/installing-payment-example.md
@@ -0,0 +1,13 @@
+---
+id: installing-payment-app-example
+title: "Verifying Camunda 8 installation with a demo app"
+description: "Ensure your installation is functioning properly by learning how to install the payment example process application on Camunda 8 Self-Managed."
+---
+
+Interested in installing a test application that works with your Camunda 8 stack? Follow the guide below.
+
+The payment example process application demonstrates a process application with payment processes, forms, and workers. This serves as an excellent starting point for validating the functionality of your Camunda 8 Self-Managed installation.
+
+To install the payment example process application on Kubernetes, follow the instructions detailed in the [Kubernetes Deployment Tutorial](https://github.com/camunda-community-hub/camunda-8-examples/tree/main/payment-example-process-application/kube/README.md).
+
+For more details about the application, its features, and configuration options, refer to [Camunda 8 Examples: Payment Example Process Application](https://github.com/camunda-community-hub/camunda-8-examples/tree/main/payment-example-process-application).
diff --git a/...lf-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/eks-helm.md b/...lf-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/eks-helm.md
@@ -419,6 +419,10 @@ kubectl port-forward services/camunda-keycloak 18080:80
   </TabItem>
 </Tabs>
 
+### Testing installation with payment example application
+
+To test your installation with the deployment of a sample application, refer to the [installing payment example guide](../../guides/installing-payment-example.md).
+
 ### Advanced topics
 
 The following are some advanced configuration topics to consider for your cluster:

diff --git a/versioned_docs/version-8.5/self-managed/setup/deploy/amazon/amazon-eks/eks-helm.md b/versioned_docs/version-8.5/self-managed/setup/deploy/amazon/amazon-eks/eks-helm.md
@@ -419,6 +419,10 @@ kubectl port-forward services/camunda-keycloak 18080:80
   </TabItem>
 </Tabs>
 
+### Testing installation with payment example application
+
+To test your installation with the deployment of a sample application, refer to the [installing payment example guide](../../../guides/installing-payment-example.md).
+
 ### Advanced topics
 
 The following are some advanced configuration topics to consider for your cluster:

diff --git a/versioned_docs/version-8.5/self-managed/setup/guides/installing-payment-example.md b/versioned_docs/version-8.5/self-managed/setup/guides/installing-payment-example.md
@@ -0,0 +1,13 @@
+---
+id: installing-payment-app-example
+title: "Verifying Camunda 8 installation with a demo app"
+description: "Ensure your installation is functioning properly by learning how to install the payment example process application on Camunda 8 Self-Managed."
+---
+
+Interested in installing a test application that works with your Camunda 8 stack? Follow the guide below.
+
+The payment example process application demonstrates a process application with payment processes, forms, and workers. This serves as an excellent starting point for validating the functionality of your Camunda 8 Self-Managed installation.
+
+To install the payment example process application on Kubernetes, follow the instructions detailed in the [Kubernetes Deployment Tutorial](https://github.com/camunda-community-hub/camunda-8-examples/tree/main/payment-example-process-application/kube/README.md).
+
+For more details about the application, its features, and configuration options, refer to [Camunda 8 Examples: Payment Example Process Application](https://github.com/camunda-community-hub/camunda-8-examples/tree/main/payment-example-process-application).
diff --git a/versioned_sidebars/version-8.4-sidebars.json b/versioned_sidebars/version-8.4-sidebars.json
@@ -1326,7 +1326,8 @@
                 "self-managed/platform-deployment/helm-kubernetes/guides/air-gapped-installation",
                 "self-managed/platform-deployment/helm-kubernetes/guides/aws-marketplace",
                 "self-managed/platform-deployment/helm-kubernetes/guides/running-custom-connectors",
-                "self-managed/platform-deployment/helm-kubernetes/guides/multi-namespace-deployment"
+                "self-managed/platform-deployment/helm-kubernetes/guides/multi-namespace-deployment",
+                "self-managed/platform-deployment/helm-kubernetes/guides/installing-payment-app-example"
               ]
             },
             "self-managed/platform-deployment/troubleshooting"

diff --git a/versioned_sidebars/version-8.5-sidebars.json b/versioned_sidebars/version-8.5-sidebars.json
@@ -1430,7 +1430,8 @@
             "self-managed/setup/guides/connect-to-an-oidc-provider",
             "self-managed/setup/guides/air-gapped-installation",
             "self-managed/setup/guides/running-custom-connectors",
-            "self-managed/setup/guides/multi-namespace-deployment"
+            "self-managed/setup/guides/multi-namespace-deployment",
+            "self-managed/setup/guides/installing-payment-app-example"
           ]
         }
       ],