improve instructions for style

camunda · Dec 11, 2024 · 8703d31 · 8703d31
1 parent ae467b0
commit 8703d31
Show file tree

Hide file tree

Showing 7 changed files with 9 additions and 5 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
@@ -4,7 +4,7 @@ title: "Install Camunda 8 on an EKS cluster"
 description: "Set up the Camunda 8 environment with Helm and an optional Ingress setup on Amazon EKS."
 ---
 
-<!-- (!) Note: please keep this guide aligned with docs/self-managed/setup/deploy/openshift/redhat-openshift.md -->
+<!-- (!) Note: Please ensure that this guide maintains a consistent structure and presentation style throughout, as with docs/self-managed/setup/deploy/openshift/terraform-setup.md. The user should have a similar experience when reading both guides. -->
 
 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";

diff --git a/docs/self-managed/setup/deploy/amazon/openshift/terraform-setup.md b/docs/self-managed/setup/deploy/amazon/openshift/terraform-setup.md
@@ -4,7 +4,7 @@ title: "Deploy a ROSA HCP Cluster with Terraform"
 description: "Deploy Red Hat OpenShift on AWS using a Terraform module for a quick Camunda 8 setup."
 ---
 
-<!-- (!) Note: Please ensure consistency between this page and ../amazon-eks/terraform-setup.md -->
+<!-- (!) Note: Please ensure that this guide maintains a consistent structure and presentation style throughout, as with ../amazon-eks/terraform-setup.md. The user should have a similar experience when reading both guides. -->
 
 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";

diff --git a/docs/self-managed/setup/deploy/openshift/redhat-openshift.md b/docs/self-managed/setup/deploy/openshift/redhat-openshift.md
@@ -4,7 +4,7 @@ title: "Red Hat OpenShift"
 description: "Deploy Camunda 8 Self-Managed on Red Hat OpenShift"
 ---
 
-<!-- (!) Note: please keep this guide aligned with docs/self-managed/setup/deploy/amazon/amazon-eks/eks-helm.md -->
+<!-- (!) Note: Please ensure that this guide maintains a consistent structure and presentation style throughout, as with docs/self-managed/setup/deploy/amazon/amazon-eks/eks-helm.md. The user should have a similar experience when reading both guides. -->
 
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';

diff --git a/versioned_docs/version-8.6/self-managed/setup/deploy/amazon/amazon-eks/eks-helm.md b/versioned_docs/version-8.6/self-managed/setup/deploy/amazon/amazon-eks/eks-helm.md
@@ -4,6 +4,8 @@ title: "Install Camunda 8 on an EKS cluster"
 description: "Set up the Camunda 8 environment with Helm and an optional Ingress setup on Amazon EKS."
 ---
 
+<!-- (!) Note: Please ensure that this guide maintains a consistent structure and presentation style throughout, as with docs/self-managed/setup/deploy/openshift/redhat-openshift.md. The user should have a similar experience when reading both guides. -->
+
 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";
 

diff --git a/...docs/version-8.6/self-managed/setup/deploy/amazon/amazon-eks/terraform-setup.md b/...docs/version-8.6/self-managed/setup/deploy/amazon/amazon-eks/terraform-setup.md
@@ -4,6 +4,8 @@ title: "Deploy an EKS cluster with Terraform (advanced)"
 description: "Deploy an Amazon Kubernetes Cluster (EKS) with a Terraform module for a quick Camunda 8 setup."
 ---
 
+<!-- (!) Note: Please ensure that this guide maintains a consistent structure and presentation style throughout, as with docs/self-managed/setup/deploy/amazon/amazon-eks/terraform-setup.md. The user should have a similar experience when reading both guides. -->
+
 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";
 

diff --git a/..._docs/version-8.6/self-managed/setup/deploy/amazon/openshift/terraform-setup.md b/..._docs/version-8.6/self-managed/setup/deploy/amazon/openshift/terraform-setup.md
@@ -4,7 +4,7 @@ title: "Deploy a ROSA HCP Cluster with Terraform"
 description: "Deploy Red Hat OpenShift on AWS using a Terraform module for a quick Camunda 8 setup."
 ---
 
-<!-- (!) Note: Please ensure consistency between this page and ../amazon-eks/terraform-setup.md -->
+<!-- (!) Note: Please ensure that this guide maintains a consistent structure and presentation style throughout, as with ../amazon-eks/terraform-setup.md. The user should have a similar experience when reading both guides. -->
 
 import Tabs from "@theme/Tabs";
 import TabItem from "@theme/TabItem";

diff --git a/versioned_docs/version-8.6/self-managed/setup/deploy/openshift/redhat-openshift.md b/versioned_docs/version-8.6/self-managed/setup/deploy/openshift/redhat-openshift.md
@@ -4,7 +4,7 @@ title: "Red Hat OpenShift"
 description: "Deploy Camunda 8 Self-Managed on Red Hat OpenShift"
 ---
 
-<!-- (!) Note: please keep this guide aligned with docs/self-managed/setup/deploy/amazon/amazon-eks/eks-helm.md -->
+<!-- (!) Note: Please ensure that this guide maintains a consistent structure and presentation style throughout, as with docs/self-managed/setup/deploy/amazon/amazon-eks/eks-helm.md. The user should have a similar experience when reading both guides. -->
 
 import Tabs from '@theme/Tabs';
 import TabItem from '@theme/TabItem';