camunda-docs icon indicating copy to clipboard operation
camunda-docs copied to clipboard

Move Go and CLI client to community section

Open akeller opened this issue 1 year ago • 7 comments

Description

Structural move for https://github.com/camunda/product-hub/issues/2438.

When should this change go live?

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

PR Checklist

  • [ ] My changes are for an already released minor and are in /versioned_docs directory.
  • [x] My changes are for the next minor and are in /docs directory (aka /next/).

akeller avatar Aug 30 '24 19:08 akeller

:wave: :robot: :thinking: Hello! 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.5/.

  • docs/apis-tools/community-clients/cli-client/assets/operate-advanced-instances-other.png
  • docs/apis-tools/community-clients/cli-client/assets/operate-advanced-instances-pong.png
  • docs/apis-tools/community-clients/cli-client/assets/operate-advanced-instances.png
  • docs/apis-tools/community-clients/cli-client/assets/zeebe-modeler-advanced-process-id.png
  • docs/apis-tools/community-clients/cli-client/assets/zeebe-modeler-advanced-sequence-flows.png
  • docs/apis-tools/community-clients/cli-client/assets/zeebe-modeler-advanced.png
  • 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/assets/java-get-started-monitor-1.gif
  • docs/apis-tools/community-clients/go-client/assets/java-get-started-monitor-2.gif
  • docs/apis-tools/community-clients/go-client/assets/order-process-simple.png
  • docs/apis-tools/community-clients/go-client/assets/order-process.png
  • 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
  • docs/apis-tools/community-clients/index.md
  • docs/components/modeler/desktop-modeler/troubleshooting.md
  • docs/components/zeebe/technical-concepts/protocols.md
  • docs/guides/devops-lifecycle/integrate-web-modeler-in-ci-cd.md
  • docs/reference/announcements.md
  • docs/self-managed/concepts/multi-tenancy.md
  • docs/self-managed/modeler/web-modeler/troubleshooting/troubleshoot-zeebe-connection.md
  • docs/self-managed/operational-guides/multi-region/dual-region-ops.md
  • docs/self-managed/setup/deploy/amazon/amazon-eks/dual-region.md
  • docs/self-managed/setup/deploy/amazon/amazon-eks/eks-helm.md
  • docs/self-managed/setup/deploy/local/local-kubernetes-cluster.md
  • docs/self-managed/setup/deploy/local/manual.md
  • docs/self-managed/setup/guides/accessing-components-without-ingress.md
  • docs/self-managed/zeebe-deployment/security/client-authorization.md
  • docs/self-managed/zeebe-deployment/security/secure-client-communication.md
  • docs/self-managed/zeebe-deployment/zeebe-gateway/job-streaming.md
These files were changed only in versioned_docs/version-8.5/. You might want to duplicate these changes in docs/.
  • versioned_docs/version-8.5/reference/dependencies.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[bot] avatar Aug 30 '24 19:08 github-actions[bot]

@akeller as we have a first RC release of the community client I would rebase this PR and add commits on top to adjust the module name (which changed with the move) accordingly for the next docs. Afterwards it should be ready for review and merge.

megglos avatar Sep 24 '24 06:09 megglos

@akeller as we have a first RC release of the community client I would rebase this PR and add commits on top to adjust the module name (which changed with the move) accordingly for the next docs. Afterwards it should be ready for review and merge.

@megglos just to confirm, you will do the rebasing, correct? Do you want to take over assignee?

akeller avatar Sep 24 '24 13:09 akeller

@akeller I updated all zbctl links to the new community location, as it's not an official tool anymore with 8.6 I will replace this with the equivalent REST API reference next with https://github.com/camunda/camunda/issues/22665

megglos avatar Sep 24 '24 20:09 megglos

@akeller can't request review as you were the creator of the PR 🙈 can you still take a look?

megglos avatar Sep 24 '24 20:09 megglos

Approaching the end of my day here, I will review this tomorrow with fresh eyes.

akeller avatar Sep 24 '24 21:09 akeller

Thanks for spotting @mesellings ! I'll fix those links!

megglos avatar Sep 25 '24 11:09 megglos

Done, I also removed some other go and zbctl related docs for the self-managed setup with https://github.com/camunda/camunda-docs/pull/4228/commits/cc4f3cf52198a2785e89efb85976fd1b0377798c

can you take another look @mesellings ? Thanks!

megglos avatar Sep 25 '24 12:09 megglos

Structurally, this looks good. There are some additional pieces I'd like to see cleaned up, including softening the language that makes the CLI client look officially supported:

zbctl is the command line interface to interact with Camunda 8.

Instead, say something like:

zbctl is a community-supported command line interface to interact with Camunda 8.

It's subtle and something we can make more overt if we need to (adding an admonition).

akeller avatar Sep 25 '24 15:09 akeller

@megglos Shall I make these language softening changes for you, or have you already started making them?

mesellings avatar Sep 26 '24 08:09 mesellings

@megglos Shall I make these language softening changes for you, or have you already started making them?

@mesellings I was coming here to ask if you or Amara can take it, as I'm out sick. So YES that would be great! Thank you so much!

megglos avatar Sep 26 '24 11:09 megglos

@megglos Shall I make these language softening changes for you, or have you already started making them?

@mesellings I was coming here to ask if you or Amara can take it, as I'm out sick. So YES that would be great! Thank you so much!

Will do, hope you feel better soon 👍

mesellings avatar Sep 26 '24 11:09 mesellings

@akeller @megglos I have added this clarification to the Quick reference and Getting started pages for both the CLI and Go Client Library - are you happy with this or do you think it needs to be called out more?

image

mesellings avatar Sep 26 '24 12:09 mesellings

@mesellings - I'm happy with this. We can always monitor if it needs something stronger/louder. Thank you!

akeller avatar Sep 26 '24 13:09 akeller

@akeller @megglos I have added this clarification to the Quick reference and Getting started pages for both the CLI and Go Client Library - are you happy with this or do you think it needs to be called out more?

image

@aleksander-dytko - do we need to add text about how these tools are deprecated? Or link to the release notes and/or blog about deprecation? @leiicamundi made a good point on another PR that we should be clear about this, even if it will be community-supported.

akeller avatar Sep 26 '24 21:09 akeller

@akeller @megglos I have added this clarification to the Quick reference and Getting started pages for both the CLI and Go Client Library - are you happy with this or do you think it needs to be called out more? image

@aleksander-dytko - do we need to add text about how these tools are deprecated? Or link to the release notes and/or blog about deprecation? @leiicamundi made a good point on another PR that we should be clear about this, even if it will be community-supported.

Adjusted in latest commit.

akeller avatar Sep 27 '24 18:09 akeller

@aleksander-dytko please review so we can merge :)

akeller avatar Sep 27 '24 18:09 akeller

@akeller do you want me to merge this?

mesellings avatar Sep 30 '24 14:09 mesellings

@mesellings I almost said yes, but I just realized this PR doesn't have redirects for the moved content.

akeller avatar Sep 30 '24 15:09 akeller

:broom: Preview environment for this PR has been torn down.

github-actions[bot] avatar Oct 01 '24 16:10 github-actions[bot]