Skip to content

Add documentation for Spring boot integration #3713

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

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

Conversation

Quinn-With-Two-Ns
Copy link
Contributor

What does this PR do?

Add documentation for Spring boot integration

https://github.com/temporalio/sdk-java/tree/master/temporal-spring-boot-autoconfigure

Notes to reviewers


## Configure Workers {#configure-workers}

Temporal's Spring Boot integration supports two ways to configure workers auto-discovery and an explicit configuration.
Copy link
Contributor

Choose a reason for hiding this comment

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

There should probably be a comma or semi colon in this sentence

Copy link
Contributor

@tlalfano tlalfano left a comment

Choose a reason for hiding this comment

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

lgtm 👍

@Quinn-With-Two-Ns Quinn-With-Two-Ns marked this pull request as ready for review August 6, 2025 22:24
@Quinn-With-Two-Ns Quinn-With-Two-Ns requested a review from a team as a code owner August 6, 2025 22:24
@tomwheeler tomwheeler self-requested a review August 7, 2025 18:22
Copy link
Contributor

@tomwheeler tomwheeler 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 some suggestions for improvement, most of which relate to spelling, punctuation, and style conformance.


## Connect {#connect}

To create an autoconfigured `WorkflowClient` all you have to do is specify some connection details in your `application.yml`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
To create an autoconfigured `WorkflowClient` all you have to do is specify some connection details in your `application.yml`.
To create an autoconfigured `WorkflowClient`, you need only specify some connection details in your `application.yml` file.

Copy link
Contributor

Choose a reason for hiding this comment

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

"specify some connection details" -- will it be obvious to the reader which ones they'll need to specify?

Looking at the application.yaml file for the basic example in samples-java, it seems that the user must specify the Namespace name and the target (endpoint address of the frontend). Perhaps it's the case that the values shown there are the defaults, but shown explicitly to make it easier for someone to change.

I would recommend that this documentation on Spring Boot provides some more guidance about what one must set, either by including it here or linking to some existing resource that already provides it.

Finally, I'll note that this section refers to an application.yml file, while the example I linked to refers to application.yaml. Maybe that doesn't matter, but I wanted to point out the discrepancy.

Copy link
Contributor

Choose a reason for hiding this comment

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

UPDATE: It appears that the explanation I was looking is in the next section. In this case, consider expanding "specify some connection details in your application.yml file." to "specify some connection details in your application.yml file, as described in the next section."

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks, let me know how it is now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants