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

clarify spring boot conventions for config, update spring links #3974

Merged
merged 2 commits into from
Jul 1, 2024

Conversation

conceptualshark
Copy link
Contributor

Description

Resolves #3501

  • Added an explicit callout and links to the Spring docs on external configs to spring components
  • Updated existing spring doc links
  • Where we specifically call out using a config file, added examples of converting the property name to an env variable (did not add this to pages where we only discuss env variables to begin with)

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

@conceptualshark conceptualshark self-assigned this Jun 24, 2024
@conceptualshark conceptualshark added component:docs Documentation improvements, including new or updated content component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed labels Jun 24, 2024
@@ -9,6 +9,9 @@ description: "Read details on the configuration variables of Console Self-Manage
Console Self-Managed is available only to [Enterprise customers](/reference/licenses.md#console).
:::

As a Spring Boot application, Console supports any standard
Copy link
Member

Choose a reason for hiding this comment

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

I'm not sure about this. I remember that Console doesn't support the Spring convention out of the box, only what we agreed on.

aabouzaid
aabouzaid previously approved these changes Jun 26, 2024
Copy link
Member

@aabouzaid aabouzaid left a comment

Choose a reason for hiding this comment

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

Great work 🙌

Apart from the Console part which we need to review with the Console team, I'd approve this reset of the changes.

@akeller akeller added the component:console Issues related with Console project label Jun 28, 2024
@conceptualshark conceptualshark requested a review from aabouzaid July 1, 2024 15:36
@conceptualshark conceptualshark merged commit a82bda9 into main Jul 1, 2024
10 checks passed
@conceptualshark conceptualshark deleted the spring-env-variable-conventions branch July 1, 2024 17:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:console Issues related with Console project component:docs Documentation improvements, including new or updated content component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Clarify the spring boot convention with key levels (_)
3 participants