-
Notifications
You must be signed in to change notification settings - Fork 228
docs: fix incorrectly formatted environment variables #7821
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This PR updates security-related documentation to align environment variable names with the intended configuration property naming scheme across both current (8.9) and versioned (8.8) docs.
Changes:
- Normalize OIDC authentication and assertion-related environment variable names by removing internal underscores to match the relaxed Spring Boot binding pattern.
- Update HTTP header security configuration environment variable names to a consistent flattened style (e.g.,
HTTPHEADERS_*andCLOCKSKEW/IDTOKENALGORITHM). - Adjust Identity initialization (authorizations/roles/mapping rules/users) environment variable names to a consistent flattened style in both 8.8 and 8.9 documentation.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| versioned_docs/version-8.8/self-managed/components/orchestration-cluster/core-settings/configuration/properties.md | Aligns 8.8 env-var documentation for OIDC auth, HTTP security headers, and security initialization with the new flattened naming scheme. |
| docs/self-managed/components/orchestration-cluster/core-settings/configuration/properties.md | Mirrors the same env-var renaming for the 8.9 docs, keeping property/env/Helm documentation in sync for current version. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
docs/self-managed/components/orchestration-cluster/core-settings/configuration/properties.md
Outdated
Show resolved
Hide resolved
docs/self-managed/components/orchestration-cluster/core-settings/configuration/properties.md
Outdated
Show resolved
Hide resolved
...-8.8/self-managed/components/orchestration-cluster/core-settings/configuration/properties.md
Show resolved
Hide resolved
|
For the tech writers: no clue why it says bad links, I didn't change any link 🤷 |
giorgionaps
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Committed minor changes directly to the branch. Otherwise, LGTM!
71f22e0 to
df4487d
Compare
|
👋 🤖 🤔 Hello, @npepinpe! 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.8/.
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. |
|
@giorgionaps - I had to rebase, and there were major changes where the properties.md file was broken up, so I dropped some of your changes. I tried my best to add them back, but could use a quick pass again to make sure it looks good :) |
mesellings
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@npepinpe @giorgionaps approving to merge as I am refactoring this page currently with all the new 8.9 properties, so this looks good to go for me now 👍
Description
This PR fixes incorrectly formatted environment variables. I did not go through all the docs, just the security relevant ones.
It also raises the question as to why some are env vars, and others just properties 🤷
Related to https://camunda.slack.com/archives/C0ABV95Q1J8
When should this change go live?
bugorsupportlabel)available & undocumentedlabel)holdlabel)low priolabel)PR Checklist
{type}(scope): {description}commit message(s)/docsdirectory (version 8.9)./versioned_docsdirectory.@camunda/tech-writersunless working with an embedded writer.