-
Notifications
You must be signed in to change notification settings - Fork 198
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
base: main
Are you sure you want to change the base?
Conversation
👋 🤖 🤔 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/.
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. |
@@ -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! |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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?
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 👍 |
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?
bug
orsupport
label)available & undocumented
label)hold
label)low prio
label)PR Checklist
/docs
directory (version 8.8)./versioned_docs/version-8.7/
directory (version 8.7)./versioned_docs
directory.@camunda/tech-writers
unless working with an embedded writer.