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

adjust zbctl references in versioned docs #5131

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

Conversation

christinaausley
Copy link
Contributor

Description

Closes #5059) and (https://github.com/camunda/documentation-team/issues/453).

You'll notice this was mostly me flagging remaining instances of zbctl -- @akeller would you like me to backport your changes from #5026 to 8.7 and 8.6?

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)
  • 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).
    • 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.

@christinaausley christinaausley added the component:docs Documentation improvements, including new or updated content label Mar 3, 2025
@christinaausley christinaausley self-assigned this Mar 3, 2025
Copy link
Contributor

github-actions bot commented Mar 3, 2025

👋 🤖 🤔 Hello, @christinaausley! 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/apis-tools/community-clients/cli-client/cli-get-started.md
  • docs/apis-tools/community-clients/cli-client/index.md
  • docs/apis-tools/community-clients/go-client/go-get-started.md
  • docs/apis-tools/community-clients/go-client/index.md
  • docs/apis-tools/community-clients/go-client/job-worker.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/components/concepts/messages.md
  • versioned_docs/version-8.7/components/concepts/process-instance-creation.md
  • versioned_docs/version-8.7/components/console/console-troubleshooting/common-pitfalls.md
  • versioned_docs/version-8.7/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md
  • versioned_docs/version-8.7/self-managed/concepts/multi-region/dual-region.md
  • versioned_docs/version-8.7/self-managed/modeler/web-modeler/troubleshooting/troubleshoot-zeebe-connection.md
  • versioned_docs/version-8.7/self-managed/operational-guides/multi-region/dual-region-ops.md
  • versioned_docs/version-8.7/self-managed/setup/deploy/amazon/amazon-eks/dual-region.md
  • versioned_docs/version-8.7/self-managed/setup/deploy/local/local-kubernetes-cluster.md
  • versioned_docs/version-8.7/self-managed/setup/deploy/local/manual.md
  • versioned_docs/version-8.7/self-managed/setup/deploy/openshift/dual-region.md
  • versioned_docs/version-8.7/self-managed/setup/guides/accessing-components-without-ingress.md
  • versioned_docs/version-8.7/self-managed/zeebe-deployment/operations/cluster-scaling.md
  • versioned_docs/version-8.7/self-managed/zeebe-deployment/security/secure-client-communication.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/apis-tools/community-clients/cli-client/cli-get-started.md
  • versioned_docs/version-8.7/apis-tools/community-clients/cli-client/index.md
  • versioned_docs/version-8.7/apis-tools/community-clients/go-client/go-get-started.md
  • versioned_docs/version-8.7/apis-tools/community-clients/go-client/index.md
  • versioned_docs/version-8.7/apis-tools/community-clients/go-client/job-worker.md
  • versioned_docs/version-8.7/self-managed/setup/deploy/openshift/dual-region.md
These files were changed only in versioned_docs/version-8.6/. You might want to duplicate these changes in docs/.
  • versioned_docs/version-8.6/components/concepts/messages.md
  • versioned_docs/version-8.6/components/concepts/process-instance-creation.md
  • versioned_docs/version-8.6/components/console/console-troubleshooting/common-pitfalls.md
  • versioned_docs/version-8.6/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md
  • versioned_docs/version-8.6/self-managed/concepts/multi-region/dual-region.md
  • versioned_docs/version-8.6/self-managed/modeler/web-modeler/troubleshooting/troubleshoot-zeebe-connection.md
  • versioned_docs/version-8.6/self-managed/operational-guides/multi-region/dual-region-ops.md
  • versioned_docs/version-8.6/self-managed/setup/deploy/amazon/amazon-eks/dual-region.md
  • versioned_docs/version-8.6/self-managed/setup/deploy/local/local-kubernetes-cluster.md
  • versioned_docs/version-8.6/self-managed/setup/deploy/local/manual.md
  • versioned_docs/version-8.6/self-managed/setup/guides/accessing-components-without-ingress.md
  • versioned_docs/version-8.6/self-managed/zeebe-deployment/operations/cluster-scaling.md
  • versioned_docs/version-8.6/self-managed/zeebe-deployment/security/secure-client-communication.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.

@christinaausley christinaausley marked this pull request as draft March 3, 2025 19:06
@christinaausley christinaausley requested a review from akeller March 3, 2025 19:06
@@ -5,6 +5,12 @@ sidebar_label: "Getting started with the CLI client"
description: "Get started with this tutorial that shows you how to interact with Camunda 8 using the community-supported CLI client and command line interface `zbctl`."
---

:::note Heads up!
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Do we want this noted all the way up to 8.8, or only 8.6 in the relevant docs?

Copy link
Member

Choose a reason for hiding this comment

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

Good question - since this was announced as deprecated in 8.6, any version beyond that should probably have slightly different wording. I could see this being as simple as removing the "now".

Related - @aleksander-dytko, when the Camunda CLI is ready, should we remove this docs content? Will the GitHub project be archived? How do you want to handle this?

@akeller
Copy link
Member

akeller commented Mar 3, 2025

@akeller would you like me to backport your changes from #5026 to 8.7 and 8.6?

Please 🙏! You'll notice in the other PR I have added in the C8 API endpoints and removed content that was only related to zbctl and could not really be "ported" to a C8 API endpoint. There are a few places where the API endpoint wasn't available yet, or the functionality didn't map, so I added an admonition and left zbctl there. It's also possible I missed something, but to get back to your main questions, yes please backport the changes to 8.6 and 8.7 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:docs Documentation improvements, including new or updated content
Projects
Status: 👀 In Review
Development

Successfully merging this pull request may close these issues.

Retro review of https://github.com/camunda/camunda-docs/pull/5026
2 participants