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

docs(sdk): Update Java Client and spring SDK docs #5055

Merged
merged 3 commits into from
Feb 26, 2025
Merged

Conversation

houssain-barouni
Copy link
Contributor

Description

closes #4046

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.

Copy link
Contributor

github-actions bot commented Feb 21, 2025

👋 🤖 🤔 Hello, @jonathanlukas! 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/java-client/index.md
  • docs/apis-tools/spring-zeebe-sdk/configuration.md
  • docs/apis-tools/spring-zeebe-sdk/getting-started.md
  • docs/guides/getting-started-java-spring.md
These files were changed only in docs/. You might want to duplicate these changes in versioned_docs/version-8.7/.
  • docs/apis-tools/java-client/index.md
  • docs/apis-tools/spring-zeebe-sdk/configuration.md
These files were changed only in versioned_docs/version-8.7/. You might want to duplicate these changes in versioned_docs/version-8.6/.
  • versioned_docs/version-8.7/apis-tools/spring-zeebe-sdk/getting-started.md
  • versioned_docs/version-8.7/guides/getting-started-java-spring.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.

Copy link
Contributor

@jonathanlukas jonathanlukas left a comment

Choose a reason for hiding this comment

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

There are some things I found.

@houssain-barouni houssain-barouni added the target:8.8 Issues included in the 8.8 release label Feb 25, 2025
tmetzke
tmetzke previously approved these changes Feb 26, 2025
Copy link
Member

@tmetzke tmetzke left a comment

Choose a reason for hiding this comment

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

Nothing to add from my side here 👍

Copy link
Contributor

@jonathanlukas jonathanlukas left a comment

Choose a reason for hiding this comment

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

I made one additional commit to adjust something that changed as well...

Apart from that, lgtm

@houssain-barouni
Copy link
Contributor Author

Hi @camunda/tech-writers, is this good from your perspective ?

Copy link
Contributor

@conceptualshark conceptualshark left a comment

Choose a reason for hiding this comment

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

👍 LGTM! Thank you for these thorough changes.

@houssain-barouni houssain-barouni merged commit 37d43c6 into main Feb 26, 2025
8 checks passed
@houssain-barouni houssain-barouni deleted the doc-4046 branch February 26, 2025 12:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
target:8.8 Issues included in the 8.8 release
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

Update Java Client docs
5 participants