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

Zeebe overview revamp #5148

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

Zeebe overview revamp #5148

wants to merge 2 commits into from

Conversation

christinaausley
Copy link
Contributor

Description

Revamping the Zeebe overview page -- closes #4833.

Special shoutout to @mesellings, as his Connectors work inspired much of what I pulled into this overview page 💪

To backport upon approval.

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 component:zeebe Issues related with Zeebe project deploy Stand up a temporary docs site with this PR low prio There is no urgency with this change. labels Mar 4, 2025
@christinaausley christinaausley self-assigned this Mar 4, 2025
Copy link
Contributor

github-actions bot commented Mar 4, 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/components/zeebe/react-components/_zeebe-card-data.js
  • docs/components/zeebe/react-components/_zeebe-card.js
  • docs/components/zeebe/react-components/_zeebe-table.css
  • docs/components/zeebe/technical-concepts/assets/icon-arrow.png
  • docs/components/zeebe/technical-concepts/assets/icon-blackbox.png
  • docs/components/zeebe/technical-concepts/assets/icon-end-to-end.png
  • docs/components/zeebe/technical-concepts/assets/icon-partition.png
  • docs/components/zeebe/technical-concepts/assets/icon-protocol.png
  • docs/components/zeebe/technical-concepts/assets/icon-workflow-engine.png
  • docs/components/zeebe/zeebe-overview.md
These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.7/.
  • docs/components/zeebe/react-components/_zeebe-card-data.js
  • docs/components/zeebe/react-components/_zeebe-card.js
  • docs/components/zeebe/react-components/_zeebe-table.css
  • docs/components/zeebe/technical-concepts/assets/icon-arrow.png
  • docs/components/zeebe/technical-concepts/assets/icon-blackbox.png
  • docs/components/zeebe/technical-concepts/assets/icon-end-to-end.png
  • docs/components/zeebe/technical-concepts/assets/icon-partition.png
  • docs/components/zeebe/technical-concepts/assets/icon-protocol.png
  • docs/components/zeebe/technical-concepts/assets/icon-workflow-engine.png
  • docs/components/zeebe/zeebe-overview.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
Copy link
Contributor Author

@ChrisKujawa Based on our conversation a little over a week ago, WDYT about these changes? Is there anything you would add, or want to highlight about Zeebe on this page?

@github-actions github-actions bot temporarily deployed to camunda-docs March 4, 2025 22:41 Destroyed
Copy link
Contributor

github-actions bot commented Mar 4, 2025

The preview environment relating to the commit f817206 has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-5148/index.html

@mesellings
Copy link
Contributor

Great work @christinaausley, much clearer as a landing page 🚀 - I might look at creating a more generic version of these cards now they are being used in other places, but this page looks so much better!

Only comment I have is that the icons/image need to use a colour that works well in both light/dark mode - you can see I use the grey #999999 which works well across both modes. If you want me to show you how to convert these icons/diagram let me know, or I can do it for you? (in Docusaurus you can also specify alternate images for each mode, but this seems like unnecessary work, so I settled on a grey that works for both).

Great job! 👏

@christinaausley
Copy link
Contributor Author

If you want me to show you how to convert these icons/diagram let me know, or I can do it for you?

@mesellings Agreed! Feel free to push a commit or propose the change to adjust the coloring here 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:zeebe Issues related with Zeebe project deploy Stand up a temporary docs site with this PR low prio There is no urgency with this change.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Component > Zeebe intro page looks stale
2 participants