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

Adjust Spring Zeebe SDK docs #3750

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from
Draft

Adjust Spring Zeebe SDK docs #3750

wants to merge 3 commits into from
+276 −73

Conversation

nicpuppa
Copy link
Contributor

@nicpuppa nicpuppa commented May 1, 2024 •
edited

Description

  • Updated configuration properties
  • Added @ZeebeSpringTest references
  • 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
docs(spring-zeebe-sdk): improve documentation
041b541 
- Added explanation of missing client configuration properties
- Added @ZeebeSpringTest annotation references
- Removed reference to configuration with .properties file in favor of yaml files
@nicpuppa
docs(spring-zeebe-sdk): remove reference to spring zeebe community pr…
3adea6e 
…oject
@nicpuppa nicpuppa added the component:zeebe Issues related with Zeebe project label May 1, 2024
@nicpuppa nicpuppa self-assigned this May 1, 2024
@github-actions GitHub Actions
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 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@megglos megglos Awaiting requested review from megglos

@ana-vinogradova-camunda ana-vinogradova-camunda Awaiting requested review from ana-vinogradova-camunda

At least 1 approving review is required to merge this pull request.

Assignees

@nicpuppa nicpuppa

@ana-vinogradova-camunda ana-vinogradova-camunda

Labels
8.6.0-alpha2 component:zeebe Issues related with Zeebe project
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Spring SDK] Update docs with latest changes
3 participants
@nicpuppa @christinaausley @ana-vinogradova-camunda