Skip to content

doc(self-managed): rework the references of camunda release and namespaces #5626

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

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

Conversation

leiicamundi
Copy link
Contributor

@leiicamundi leiicamundi commented Apr 24, 2025

Description

Following camunda/camunda-deployment-references#250, we have reworked our usage of the namespace and helm release name across our documentation and script.

This PR apply this update by extracting some hard coded namespace values and release names

I've also reverted the reference of rosa-8.8 as we should now use main branch of https://github.com/camunda/camunda-deployment-references for any 8.8 target

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 Documentation team. (create draft PR and/or add hold label)
  • 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

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

@leiicamundi leiicamundi added hold This issue is parked, do not merge. component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed deploy Stand up a temporary docs site with this PR labels Apr 24, 2025
@leiicamundi leiicamundi self-assigned this Apr 24, 2025
Copy link
Contributor

github-actions bot commented Apr 24, 2025

👋 🤖 🤔 Hello, @leiicamundi! 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.7/.

  • docs/self-managed/setup/deploy/amazon/openshift/terraform-setup.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.

@github-actions github-actions bot temporarily deployed to camunda-docs April 24, 2025 15:34 Destroyed
@leiicamundi leiicamundi requested review from Langleu and a team April 24, 2025 15:55
@leiicamundi leiicamundi marked this pull request as ready for review April 24, 2025 15:55
@akeller akeller moved this to 👀 In Review in Documentation Team Apr 24, 2025
@leiicamundi leiicamundi removed the hold This issue is parked, do not merge. label Apr 24, 2025
@github-actions github-actions bot temporarily deployed to camunda-docs April 24, 2025 16:03 Destroyed
Langleu
Langleu previously approved these changes Apr 25, 2025
@leiicamundi
Copy link
Contributor Author

@camunda/tech-writers could you please proceed to the review and release a doc version as some files requires updates on stable 8.7 of the doc

Copy link
Contributor

@christinaausley christinaausley left a comment

Choose a reason for hiding this comment

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

Would you consider this name change a breaking change? I would likely add this to https://docs.camunda.io/docs/reference/announcements-release-notes/overview/.

Also, you checked the box that this is part of a scheduled alpha or minor, but I don't see a label attached to this PR. What alpha or minor is this specific to?

@leiicamundi
Copy link
Contributor Author

Hi @christinaausley,

We don't consider it as a breaking change as the user was not relying on that specific variable previously.
The checkbox was a mistake, sorry.

@github-actions github-actions bot temporarily deployed to camunda-docs April 29, 2025 08:49 Destroyed
Copy link
Contributor

The preview environment relating to the commit 8ac3b1c has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-5626/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed deploy Stand up a temporary docs site with this PR
Projects
Status: 👀 In Review
Development

Successfully merging this pull request may close these issues.

3 participants