Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding several edits around new production guide to link it form othe… #5308

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

theburi
Copy link
Contributor

@theburi theburi commented Mar 19, 2025

Description

Adding several edits around new production guide to link it from other pages

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support. (add bug or support label)
  • This is already available but undocumented and should be released within a week. (add available & undocumented label)
  • This is on a specific schedule and the assignee will coordinate a release with the DevEx team. (create draft PR and/or add hold label)
  • [ x ] This is part of a scheduled alpha or minor. (add alpha or minor label)
  • There is no urgency with this change (add low prio label)

PR Checklist

  • [ x ] My changes are for an upcoming minor release and:
    • [ x ] are in the /docs directory (version 8.8).
    • [ x ] are in the /versioned_docs/version-8.7/ directory (version 8.7).
  • My changes are for an already released minor and are in a /versioned_docs directory.

Copy link
Contributor

github-actions bot commented Mar 19, 2025

👋 🤖 🤔 Hello, @conceptualshark! Did you make your changes in all the right places?

These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.6/.

  • docs/self-managed/setup/guides/add-extra-manifests.md
  • docs/self-managed/setup/guides/configure-db-custom-headers.md
These files were changed only in versioned_docs/version-8.7/. You might want to duplicate these changes in docs/.
  • versioned_docs/version-8.7/self-managed/operational-guides/production-guide/helm-chart-production-guide.md
  • versioned_docs/version-8.7/self-managed/setup/deploy/amazon/amazon-eks/eks-helm.md
  • versioned_docs/version-8.7/self-managed/setup/install.md
  • versioned_docs/version-8.7/self-managed/setup/overview.md
These files were changed only in versioned_docs/version-8.7/. You might want to duplicate these changes in versioned_docs/version-8.6/.
  • versioned_docs/version-8.7/self-managed/operational-guides/production-guide/helm-chart-production-guide.md
  • versioned_docs/version-8.7/self-managed/setup/deploy/amazon/amazon-eks/eks-helm.md
  • versioned_docs/version-8.7/self-managed/setup/guides/add-extra-manifests.md
  • versioned_docs/version-8.7/self-managed/setup/guides/configure-db-custom-headers.md
  • versioned_docs/version-8.7/self-managed/setup/install.md
  • versioned_docs/version-8.7/self-managed/setup/overview.md

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

Copy link
Contributor

@conceptualshark conceptualshark left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made a few style edits - would you like the manifests and HTTP header changes backported to earlier versions?

Copy link
Contributor

@hisImminence hisImminence left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

one (non-blocking) suggestion!

Thanks @theburi. Reviewed for @hamza-m-masood as they are on FTO for the next 2 weeks!

@@ -207,10 +207,10 @@ For more information, see how to [connect to an OpenID Connect provider](/self-m
:::note
To allow for easier testing, the Camunda Helm chart provides databases as an external dependency, such as [Bitnami Elasticsearch Helm chart](https://artifacthub.io/packages/helm/bitnami/elasticsearch) and the [Bitnami PostgreSQL Helm chart](https://artifacthub.io/packages/helm/bitnami/postgresql). These dependency charts should be disabled in a production setting, and production databases should be used instead.

This guide replaces the Bitnami Elasticsearch dependency chart with Amazon OpenSearch, and replaces the the Bitnami PostgreSQL dependency chart with Amazon Aurora PostgreSQL.
This guide disables the Bitnami Elasticsearch dependency chart and uses Amazon OpenSearch, and disables the the Bitnami PostgreSQL dependency chart and uses Amazon Aurora PostgreSQL.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This guide disables the Bitnami Elasticsearch dependency chart and uses Amazon OpenSearch, and disables the the Bitnami PostgreSQL dependency chart and uses Amazon Aurora PostgreSQL.
This guide disables the Bitnami Elasticsearch dependency chart and uses Amazon OpenSearch. It also disables the Bitnami PostgreSQL dependency chart and uses Amazon Aurora PostgreSQL instead.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 👀 In Review
Development

Successfully merging this pull request may close these issues.

3 participants