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

Move Go and CLI client to community section #4228

Merged
merged 16 commits into from
Oct 1, 2024
Merged

Conversation

akeller
Copy link
Member

@akeller akeller commented Aug 30, 2024

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)
  • 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.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@akeller akeller added component:docs Documentation improvements, including new or updated content hold This issue is parked, do not merge. deploy Stand up a temporary docs site with this PR labels Aug 30, 2024
@akeller akeller self-assigned this Aug 30, 2024
Copy link
Contributor

github-actions bot commented Aug 30, 2024

👋 🤖 🤔 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.

@megglos
Copy link
Contributor

megglos commented Sep 24, 2024

@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.

@akeller
Copy link
Member Author

akeller commented Sep 24, 2024

@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?

@megglos megglos assigned megglos and unassigned akeller Sep 24, 2024
@megglos megglos force-pushed the community-client-move branch from 9f7d4f2 to 1a5d749 Compare September 24, 2024 18:58
@megglos megglos added 8.6.0 October 2024 minor release and removed hold This issue is parked, do not merge. labels Sep 24, 2024
@megglos megglos force-pushed the community-client-move branch 2 times, most recently from de91f13 to ecb5db4 Compare September 24, 2024 20:36
@megglos
Copy link
Contributor

megglos commented Sep 24, 2024

@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 camunda/camunda#22665

@megglos megglos marked this pull request as ready for review September 24, 2024 20:41
@megglos megglos changed the title POC: move clients to community section Move Go and CLI client to community section Sep 24, 2024
@megglos
Copy link
Contributor

megglos commented Sep 24, 2024

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

@github-actions github-actions bot temporarily deployed to camunda-docs September 24, 2024 20:53 Destroyed
@akeller
Copy link
Member Author

akeller commented Sep 24, 2024

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

@github-actions github-actions bot temporarily deployed to camunda-docs September 25, 2024 07:25 Destroyed
@megglos megglos requested a review from mesellings September 25, 2024 12:37
@github-actions github-actions bot temporarily deployed to camunda-docs September 25, 2024 12:46 Destroyed
@akeller
Copy link
Member Author

akeller commented Sep 25, 2024

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

@mesellings
Copy link
Contributor

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

@megglos
Copy link
Contributor

megglos commented Sep 26, 2024

@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!

@mesellings
Copy link
Contributor

@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
Copy link
Contributor

@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

@github-actions github-actions bot temporarily deployed to camunda-docs September 26, 2024 12:48 Destroyed
@akeller
Copy link
Member Author

akeller commented Sep 26, 2024

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

@akeller
Copy link
Member Author

akeller commented Sep 26, 2024

@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 akeller mentioned this pull request Sep 26, 2024
9 tasks
@akeller
Copy link
Member Author

akeller commented Sep 27, 2024

@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
Copy link
Member Author

akeller commented Sep 27, 2024

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

@github-actions github-actions bot temporarily deployed to camunda-docs September 27, 2024 18:45 Destroyed
mesellings
mesellings previously approved these changes Sep 30, 2024
Copy link
Contributor

@mesellings mesellings left a comment

Choose a reason for hiding this comment

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

Lgtm 👍 🚀

@mesellings
Copy link
Contributor

@akeller do you want me to merge this?

@akeller
Copy link
Member Author

akeller commented Sep 30, 2024

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

@akeller akeller dismissed stale reviews from mesellings and aleksander-dytko via 56fed94 September 30, 2024 15:29
@github-actions github-actions bot temporarily deployed to camunda-docs September 30, 2024 15:38 Destroyed
Copy link
Contributor

@mesellings mesellings left a comment

Choose a reason for hiding this comment

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

The redirects lgtm 👍

@akeller akeller merged commit d2bd977 into main Oct 1, 2024
7 checks passed
@akeller akeller deleted the community-client-move branch October 1, 2024 16:24
Copy link
Contributor

github-actions bot commented Oct 1, 2024

🧹 Preview environment for this PR has been torn down.

christinaausley pushed a commit that referenced this pull request Oct 7, 2024
* structural move, link adjustment

* fix links

* add Go and CLI client to community overview

* removal of Go deprecation warnings for new community home

* adopt go client packages to community module

* go client link to community repo

* go client updated go environment version

* zeebe cli update path to community repository releases

* set all links to zeebe cli

* removal of attention comment, go client 8.5 is supported

* Add links to moved client to announcements

* go client, fix links to source files

* removal of go client and zbctl from security setup

* Add community-supported clarification

* add redirects for /next/

---------

Co-authored-by: Meggle (Sebastian Bathke) <[email protected]>
Co-authored-by: mesellings <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.6.0 October 2024 minor release component:docs Documentation improvements, including new or updated content deploy Stand up a temporary docs site with this PR
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants