From 97cecacf130da4adda7e5b034bedbc089311772a Mon Sep 17 00:00:00 2001 From: Leo J <153937047+leiicamundi@users.noreply.github.com> Date: Tue, 16 Apr 2024 19:04:35 +0200 Subject: [PATCH] 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 * Update versioned_docs/version-8.4/self-managed/platform-deployment/helm-kubernetes/guides/installing-payment-example.md Co-authored-by: Maxim Danilov * 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 Co-authored-by: Christina Ausley Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com> --- .../setup/deploy/amazon/amazon-eks/eks-helm.md | 4 ++++ .../setup/guides/installing-payment-example.md | 13 +++++++++++++ optimize_sidebars.js | 4 ++++ sidebars.js | 1 + .../guides/installing-payment-example.md | 13 +++++++++++++ .../platforms/amazon-eks/eks-helm.md | 4 ++++ .../setup/deploy/amazon/amazon-eks/eks-helm.md | 4 ++++ .../setup/guides/installing-payment-example.md | 13 +++++++++++++ versioned_sidebars/version-8.4-sidebars.json | 3 ++- versioned_sidebars/version-8.5-sidebars.json | 3 ++- 10 files changed, 60 insertions(+), 2 deletions(-) create mode 100644 docs/self-managed/setup/guides/installing-payment-example.md create mode 100644 versioned_docs/version-8.4/self-managed/platform-deployment/helm-kubernetes/guides/installing-payment-example.md create mode 100644 versioned_docs/version-8.5/self-managed/setup/guides/installing-payment-example.md 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 index 06f51fca684..ef6985b0b19 100644 --- 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 +### 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 new file mode 100644 index 00000000000..7e3694e498e --- /dev/null +++ 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 index 494f67a387a..be0d14ba12b 100644 --- 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 index b295212873d..2e10c596ce6 100644 --- 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/versioned_docs/version-8.4/self-managed/platform-deployment/helm-kubernetes/guides/installing-payment-example.md b/versioned_docs/version-8.4/self-managed/platform-deployment/helm-kubernetes/guides/installing-payment-example.md new file mode 100644 index 00000000000..7e3694e498e --- /dev/null +++ b/versioned_docs/version-8.4/self-managed/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/versioned_docs/version-8.4/self-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/eks-helm.md b/versioned_docs/version-8.4/self-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/eks-helm.md index bad2de8c372..52f0f83213d 100644 --- a/versioned_docs/version-8.4/self-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/eks-helm.md +++ b/versioned_docs/version-8.4/self-managed/platform-deployment/helm-kubernetes/platforms/amazon-eks/eks-helm.md @@ -419,6 +419,10 @@ kubectl port-forward services/camunda-keycloak 18080:80 +### 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 index 06f51fca684..ef6985b0b19 100644 --- 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 +### 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 new file mode 100644 index 00000000000..7e3694e498e --- /dev/null +++ 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 index d36a2f2fbef..a79fade975a 100644 --- 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 index 0bc4b8a1730..22fde713417 100644 --- 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" ] } ],