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

Update docs about sdk client configuration options #4826

Merged
merged 5 commits into from
Jan 14, 2025

Conversation

eppdot
Copy link
Contributor

@eppdot eppdot commented Jan 9, 2025

Description

closes 26700

Synced the spring sdk configuration docs with the actual property classes in code.

In general I just added the missing properties and re-organized a bit the structure.

There are a few open TODOs, that we need to check

  • Max metadata size: Needs better explanation
  • Deployment enabled: Didn't find any usage in the project, thus outdated?
  • Copy docs to older versions

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)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • 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/).

Copy link
Contributor

github-actions bot commented Jan 9, 2025

👋 🤖 ✅ Looks like the changes were ported across versions, nice job! 🎉

You can read more about the versioning within our docs in our documentation guidelines.

@eppdot eppdot requested a review from nicpuppa January 9, 2025 12:34
@nicpuppa nicpuppa added the deploy Stand up a temporary docs site with this PR label Jan 10, 2025
@github-actions github-actions bot temporarily deployed to camunda-docs January 10, 2025 10:03 Destroyed
### Request timeout
#### Max metadata size

A custom maxMetadataSize @TODO
Copy link
Contributor

Choose a reason for hiding this comment

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

A custom maxMetadataSize allows the client to receive larger or smaller response headers from Camunda.

### Default task type
#### Deployment

@TODO not sure if this is used ?
Copy link
Contributor

Choose a reason for hiding this comment

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

It seems not used, so we can remove it

@eppdot
Copy link
Contributor Author

eppdot commented Jan 10, 2025

@nicpuppa I added your suggestions and copied the updates to the 8.6 folder. I guess the PR is then ready to go or do you think something is missing? I would also like to learn how to merge & deploy, thus should we do that together on moday?

@eppdot eppdot marked this pull request as ready for review January 10, 2025 15:08
@akeller akeller requested a review from a team January 10, 2025 15:13
@akeller
Copy link
Member

akeller commented Jan 10, 2025

@nicpuppa I added your suggestions and copied the updates to the 8.6 folder. I guess the PR is then ready to go or do you think something is missing? I would also like to learn how to merge & deploy, thus should we do that together on moday?

Hi @eppdot, I added the tech writers group to review your PR. We usually handle the merge and deploy based on how you respond to the PR template.

@github-actions github-actions bot temporarily deployed to camunda-docs January 10, 2025 15:19 Destroyed
nicpuppa
nicpuppa previously approved these changes Jan 13, 2025
Copy link
Contributor

@nicpuppa nicpuppa left a comment

Choose a reason for hiding this comment

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

LGTM 🚀 👏

@mesellings mesellings requested review from mesellings and removed request for a team January 13, 2025 08:40
mesellings
mesellings previously approved these changes Jan 13, 2025
Copy link
Contributor

@mesellings mesellings left a comment

Choose a reason for hiding this comment

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

@eppdot Approved, great work, just a few rewording suggestions/typos. but non-blocking 👍 🚀

docs/apis-tools/spring-zeebe-sdk/configuration.md Outdated Show resolved Hide resolved
docs/apis-tools/spring-zeebe-sdk/configuration.md Outdated Show resolved Hide resolved
docs/apis-tools/spring-zeebe-sdk/configuration.md Outdated Show resolved Hide resolved
docs/apis-tools/spring-zeebe-sdk/configuration.md Outdated Show resolved Hide resolved
docs/apis-tools/spring-zeebe-sdk/configuration.md Outdated Show resolved Hide resolved
docs/apis-tools/spring-zeebe-sdk/configuration.md Outdated Show resolved Hide resolved
docs/apis-tools/spring-zeebe-sdk/configuration.md Outdated Show resolved Hide resolved
@eppdot eppdot dismissed stale reviews from mesellings and nicpuppa via d4d7679 January 14, 2025 11:37
Co-authored-by: Mark Sellings <[email protected]>
@eppdot eppdot force-pushed the 26700-document-spring-sdk-config-options branch from 351a105 to aca0441 Compare January 14, 2025 11:41
@eppdot
Copy link
Contributor Author

eppdot commented Jan 14, 2025

@mesellings Thanks a lot for reviewing 🚀 I just took over all your suggestions.

As is this my first PR here, can you explain to me what the next steps are?

Cheers, Stephan

@github-actions github-actions bot temporarily deployed to camunda-docs January 14, 2025 11:54 Destroyed
@mesellings mesellings self-requested a review January 14, 2025 12:00
Copy link
Contributor

@mesellings mesellings left a comment

Choose a reason for hiding this comment

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

Approved - nice job! 🚀

@mesellings
Copy link
Contributor

@eppdot Hi, great job for your first docs PR!

  • Once you are happy for this to be released to the docs site, either you (or we) can merge it into the docs codebase.
  • It will then be released in either the next docs patch release, or we can release it asap if it need to be live quicker than that, or to an agreed timeframe - looking at the description, this should be released quickly, so I can merge it in and release the docs if you like?

Tip: Use the Description check boxes and labels to let us know when it needs to be released, to save us having to ask you - makes it easier for everyone to see when the PR needs to go out, and if it belongs to a release.

@github-actions github-actions bot temporarily deployed to camunda-docs January 14, 2025 12:13 Destroyed
@mesellings mesellings merged commit 2c0d101 into main Jan 14, 2025
11 checks passed
@mesellings mesellings deleted the 26700-document-spring-sdk-config-options branch January 14, 2025 16:31
@mesellings
Copy link
Contributor

@eppdot I will be doing a docs release today/tomorrow, so I merged it for you, and it will get included in this release 👍

Copy link
Contributor

🧹 Preview environment for this PR has been torn down.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
deploy Stand up a temporary docs site with this PR
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

Document available .properties and YAML configurations for Spring Boot SDK
4 participants