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

Adjust Spring Zeebe SDK docs #3750

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

Conversation

nicpuppa
Copy link
Contributor

@nicpuppa nicpuppa commented May 1, 2024

Description

  • Updated configuration properties
  • Improved docs, removed reference to old configuration (with .properties file) in favor of yaml file
  • Removed links to Spring Zeebe community project

closes: #3748

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

@nicpuppa nicpuppa added the component:zeebe Issues related with Zeebe project label May 1, 2024
@nicpuppa nicpuppa self-assigned this May 1, 2024
Copy link
Contributor

github-actions bot commented May 1, 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/spring-zeebe-sdk/configuration.md
  • docs/apis-tools/spring-zeebe-sdk/getting-started.md
  • docs/components/best-practices/architecture/deciding-about-your-stack.md
  • docs/components/best-practices/development/connecting-the-workflow-engine-with-your-world.md
  • docs/components/best-practices/development/testing-process-definitions.md
  • docs/guides/migrating-from-camunda-7/adjusting-source-code.md
  • docs/guides/migrating-from-camunda-7/conceptual-differences.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

@nicpuppa It looks like #3748 is in review -- let me know when you would like a final review here, and if you have any particular deadline 👍

@nicpuppa
Copy link
Contributor Author

@nicpuppa It looks like #3748 is in review -- let me know when you would like a final review here, and if you have any particular deadline 👍

Thanks @christinaausley I will let you know when the PR is ready 👍

nicpuppa and others added 4 commits June 4, 2024 10:06
- Added explanation of missing client configuration properties
- Removed reference to configuration with .properties file in favor of yaml files
As we did not migrate test package from the community spring SDK project, I am also removing this section from the docs:
https://camunda.slack.com/archives/C06MPP9DQ21/p1715156875533999

Please see this thread.
@ana-vinogradova-camunda ana-vinogradova-camunda marked this pull request as ready for review June 4, 2024 07:10
stream-enabled: true
```

This also works for every worker individual:
Copy link
Contributor

Choose a reason for hiding this comment

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

Do you mean this also works for every job worker individually?

Copy link
Contributor

Choose a reason for hiding this comment

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

Yes, this is my understanding.

Copy link
Member

Choose a reason for hiding this comment

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

🙃 Should we fix the typo then?

Suggested change
This also works for every worker individual:
This also works for every worker individually:

@@ -149,7 +149,7 @@ Camunda 8 doesn't provide integration into Jakarta EE application servers like C

### CDI or OSGI

Due to limited adoption, there is no support for CDI or OSGI in Camunda 8. A lightweight integration layer comparable to [Spring Zeebe](https://github.com/camunda-community-hub/spring-zeebe) might evolve in the feature, and we are happy to support this as a community extension to the Zeebe project.
Due to limited adoption, there is no support for CDI or OSGI in Camunda 8. A lightweight integration layer comparable to the [Spring Zeebe SDK](../../apis-tools/spring-zeebe-sdk/getting-started.md) might evolve in the feature.
Copy link
Contributor

Choose a reason for hiding this comment

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

Do you mean a lightweight integration layer comparable to the Spring Zeebe SDK may be provided in the future?

Copy link
Member

@koevskinikola koevskinikola left a comment

Choose a reason for hiding this comment

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

I have some small suggestion, but the changes look good otherwise 👍

@@ -76,37 +76,63 @@ If you are using IntelliJ:
Settings > Build, Execution, Deployment > Compiler > Java Compiler
```

## Configuring the Zeebe cluster connection
## Configuring Camunda 8 connection
Copy link
Member

Choose a reason for hiding this comment

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

🙃 Just a suggestion

Suggested change
## Configuring Camunda 8 connection
## Configuring the Camunda 8 connection

stream-enabled: true
```

This also works for every worker individual:
Copy link
Member

Choose a reason for hiding this comment

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

🙃 Should we fix the typo then?

Suggested change
This also works for every worker individual:
This also works for every worker individually:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
8.6.0-alpha2 component:zeebe Issues related with Zeebe project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Spring SDK] Update docs with latest changes
4 participants