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

chore: add helm cli versions into docs and troubleshooting sections #3680

Merged
merged 7 commits into from
Apr 19, 2024

Conversation

drodriguez-305
Copy link
Contributor

@drodriguez-305 drodriguez-305 commented Apr 16, 2024

Description

Some users are encountering errors during Helm chart installation, such as type mismatches or other template rendering issues, it may be due to using an outdated version of the Helm CLI. Helm's handling of data types and template syntax can vary significantly between versions. We have added it in 3 areas in the /docs install, troubleshooting, and supported-environments. The Helm CLI version 3.13 is the version that works with all the current templates.

When should this change go live?

Whenever!

  • This change is not yet live and should not be merged until {ADD_DATE} (apply hold label or convert to draft PR)?
  • There is no urgency with this change.
  • This change or page is part of a marketing blog, conference talk, or something else on a schedule.
  • This functionality is already available but undocumented.
  • This is a bug fix or security concern.

PR Checklist

  • I have added changes to the relevant /versioned_docs directory, or they are not for an already released version.
  • I have added changes to the main /docs directory (aka /next/), or they are not for future versions.
  • My changes require an Engineering review, and I've assigned an engineering manager or tech lead as a reviewer, or my changes do not require an Engineering review.
  • My changes require a technical writer review, and I've assigned @christinaausley as a reviewer, or my changes do not require a technical writer review.

@drodriguez-305 drodriguez-305 added component:docs Documentation improvements, including new or updated content component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed 8.5.0 labels Apr 16, 2024
@drodriguez-305 drodriguez-305 self-assigned this Apr 16, 2024
Copy link
Contributor

github-actions bot commented Apr 16, 2024

👋 🤖 ✅ Looks like the changes were ported across versions, nice job! 🎉

You can read more about the versioning within our docs in our documentation guidelines.

@akeller akeller added the target:8.5 Issues included in the 8.5 release label Apr 18, 2024
@drodriguez-305 drodriguez-305 merged commit b992cf7 into main Apr 19, 2024
6 checks passed
@drodriguez-305 drodriguez-305 deleted the add-helm-cli-version-troubleshooting branch April 19, 2024 00:18
theburi pushed a commit that referenced this pull request Jun 5, 2024
…3680)

* add helm cli versions into docs and troubleshooting

* add helm cli version changes to 8.5

* Update docs/reference/supported-environments.md

Co-authored-by: Amara Graham <akeller@users.noreply.github.com>

* Update versioned_docs/version-8.5/reference/supported-environments.md

Co-authored-by: Amara Graham <akeller@users.noreply.github.com>

* style(formatting): technical review

* remove versioning line for helm

---------

Co-authored-by: Amara Graham <akeller@users.noreply.github.com>
Co-authored-by: Christina Ausley <christina.ausley@camunda.com>
Co-authored-by: christinaausley <84338309+christinaausley@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.5.0 component:docs Documentation improvements, including new or updated content component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed target:8.5 Issues included in the 8.5 release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants