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.

Sign up for GitHub

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

Jump to bottom

Remove go & zbctl pages, links to CCH in 8.8 #5147

Merged
merged 5 commits into from
Mar 6, 2025
Merged

Remove go & zbctl pages, links to CCH in 8.8 #5147

merged 5 commits into from
Mar 6, 2025

Conversation

akeller
Copy link
Member

@akeller akeller commented Mar 4, 2025 •
edited
Loading

Description

Following camunda-community-hub/zeebe-client-go#38, we can now remove this content from the official docs, further drawing the line between community and fully supported clients.

This PR only removes this content from 8.8. Note - redirects would be for current docs and should be removed if we want to merge this for 8.8 only.

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.

Adding or removing pages requires extra steps.

  • I included my new page in the sidebar file(s).

  • I added a redirect for a renamed or deleted page to the .htaccess file.

  • I added a DRI, team, or delegate as a reviewer for technical accuracy and grammar/style:

@akeller akeller added target:8.8 Issues included in the 8.8 release low prio There is no urgency with this change. labels Mar 4, 2025
@akeller akeller requested review from megglos, aleksander-dytko and a team March 4, 2025 20:04
@akeller akeller self-assigned this Mar 4, 2025
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Mar 4, 2025 •
edited
Loading

👋 🤖 🤔 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/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/operate/userguide/resolve-incidents-update-variables.md
  • docs/self-managed/setup/deploy/amazon/amazon-eks/eks-helm.md
  • docs/self-managed/zeebe-deployment/security/secure-client-communication.md
These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.7/.
  • 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/operate/userguide/resolve-incidents-update-variables.md
  • docs/self-managed/setup/deploy/amazon/amazon-eks/eks-helm.md
  • docs/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.

@akeller
Copy link
Member Author

akeller commented Mar 4, 2025

@megglos @aleksander-dytko if this looks good to you, we can keep it as a plan for the 8.6 and 8.7 docs too. We can decide if we want to handle that all in this PR or separate ones per version. Doesn't matter to me.

I did add the redirects assuming we would include the current docs (8.6), but @christinaausley has a separate PR where she is working through zbctl and backporting the changes I did in #5026. We can simply remove the redirects to keep the progress merging.

@akeller akeller mentioned this pull request Mar 4, 2025
Merged
12 tasks
@akeller akeller linked an issue Mar 4, 2025 that may be closed by this pull request
Reduce community-supported Go and zbctl docs to minimum #5140
Closed
@akeller akeller changed the title Remove go & zbctl pages, links to CCH Remove go & zbctl pages, links to CCH in 8.8 Mar 4, 2025
megglos
megglos previously approved these changes Mar 5, 2025
View reviewed changes
Copy link
Contributor

@megglos megglos left a comment

Choose a reason for hiding this comment

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

LGTM! Bye bye go 🥲

@christinaausley
Copy link
Contributor

@akeller Would you like me to backport these changes as well?

mesellings
mesellings previously approved these changes Mar 5, 2025
View reviewed changes
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! 🚀

@akeller
Copy link
Member Author

akeller commented Mar 5, 2025

@akeller Would you like me to backport these changes as well?

Please take care of merging #5131 first @christinaausley.

@christinaausley
Copy link
Contributor

@akeller Let me know if you would like assistance with the merge conflicts from #5131 -- once this PR is merged I can launch another PR backporting.

@akeller
Copy link
Member Author

akeller commented Mar 5, 2025

@akeller Let me know if you would like assistance with the merge conflicts from #5131 -- once this PR is merged I can launch another PR backporting.

🙏 Please @christinaausley, I would really appreciate it. The should be easy because you are just deleting pages in this PR
😆

@christinaausley christinaausley dismissed stale reviews from mesellings and megglos via 4e14b5a March 6, 2025 14:47
christinaausley
christinaausley previously approved these changes Mar 6, 2025
View reviewed changes
@akeller
Copy link
Member Author

akeller commented Mar 6, 2025

Everyone wave bye to these docs in 8.8. 👋

@akeller akeller merged commit b170059 into main Mar 6, 2025
8 checks passed
@akeller akeller deleted the remove-go-zbctl-pages branch March 6, 2025 17:16
@akeller
Copy link
Member Author

akeller commented Mar 6, 2025

@christinaausley you are good to backport! And thanks for the help here! 💪

christinaausley added a commit that referenced this pull request Mar 6, 2025
@akeller @christinaausley
Remove go & zbctl pages, links to CCH in 8.8 (#5147)
d7186a9 
* remove pages, replace links to CCH

* add redirects to CCH

* remove pages

* resolve littol bug

---------

Co-authored-by: Christina Ausley <christina.ausley@camunda.com>
@christinaausley
Copy link
Contributor

@akeller I'll get these backported tomorrow 🚀

@christinaausley
Copy link
Contributor

bye

This was referenced Mar 7, 2025
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@christinaausley christinaausley christinaausley approved these changes

@megglos megglos megglos left review comments

@mesellings mesellings mesellings left review comments

@aleksander-dytko aleksander-dytko Awaiting requested review from aleksander-dytko

Assignees

@akeller akeller

Labels
low prio There is no urgency with this change. target:8.8 Issues included in the 8.8 release
Projects
Documentation Team
Status: ✅ Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Reduce community-supported Go and zbctl docs to minimum
4 participants
@akeller @christinaausley @megglos @mesellings