-
Notifications
You must be signed in to change notification settings - Fork 227
docs(web-modeler): update Web Modeler logging docs #7351
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
|
👋 🤖 🤔 Hello, @pablocabrera85! 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. |
1dabd44 to
cd3500c
Compare
|
@afgambin could you give these a review please? 🙏 |
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 the Web Modeler documentation to reflect the migration from Logback to Apache Log4j 2 logging framework in version 8.9, and updates version references across documentation from 8.8 to 8.9.
Key changes:
- Updates Web Modeler logging documentation with Log4j2 configuration and examples
- Adds version 8.9 upgrade guides and release documentation
- Updates version references from 8.8 to 8.9 across administrator and component upgrade guides
Reviewed Changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| sidebars.js | Adds whats-new-in-89 page to version 8.9.0 announcements sidebar |
| docs/self-managed/update/administrators/overview.md | Updates version references from 8.8 to 8.9 and related links |
| docs/self-managed/components/modeler/web-modeler/configuration/logging.md | Updates logging framework from Logback to Log4j2, adds default configuration example and environment variables documentation |
| docs/self-managed/components/modeler/web-modeler/configuration/configuration.md | Updates logging configuration table with Log4j2 variables and corrected file path |
| docs/self-managed/components/components-upgrade/introduction.md | Adds upgrade sections for 8.8 to 8.9 and 8.7 to 8.8 |
| docs/self-managed/components/components-upgrade/880-to-890.md | New upgrade guide documenting the logging framework change |
| docs/reference/announcements-release-notes/890/whats-new-in-89.md | New page describing what's changed in version 8.9 |
| docs/reference/announcements-release-notes/890/890-release-notes.md | Adds alpha2 release notes for logging framework changes |
| docs/reference/announcements-release-notes/890/890-announcements.md | Adds breaking change announcement for logging framework migration |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
docs/reference/announcements-release-notes/890/890-announcements.md
Outdated
Show resolved
Hide resolved
docs/reference/announcements-release-notes/890/890-release-notes.md
Outdated
Show resolved
Hide resolved
docs/reference/announcements-release-notes/890/whats-new-in-89.md
Outdated
Show resolved
Hide resolved
docs/self-managed/components/modeler/web-modeler/configuration/configuration.md
Outdated
Show resolved
Hide resolved
docs/self-managed/components/modeler/web-modeler/configuration/logging.md
Outdated
Show resolved
Hide resolved
docs/reference/announcements-release-notes/890/890-announcements.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Copilot <[email protected]>
b2b4dae to
cff3a1e
Compare
docs/reference/announcements-release-notes/890/890-announcements.md
Outdated
Show resolved
Hide resolved
docs/self-managed/components/modeler/web-modeler/configuration/logging.md
Show resolved
Hide resolved
|
|
||
| | Release date | Changelog(s) | Blog | | ||
| | :--------------- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :--- | | ||
| | 09 December 2025 | <ul><li>[ Camunda 8 core ](https://github.com/camunda/camunda/releases/tag/8.9.0-alpha2)</li><li>[ Connectors ](https://github.com/camunda/connectors/releases/tag/8.9.0-alpha2)</li></ul> | - | |
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.
These two GH links do not work, is that on purpose? maybe they do not exist just yet?
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.
No, they do not exists, but since I had to document the changes for 8.9.0-alpha2 the page, I added that 😄
| <td>Operations and platform administrators of Self-Managed installations.</td> | ||
| </tr> | ||
| <tr> | ||
| <td>[APIs & tools upgrade guide](/apis-tools/migration-manuals/index.md)</td> |
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.
The linked guide seems to be for upgrading to 8.8, not to 8.9 as supposed (I believe)
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.
Yes. I'm assuming that this page will be updated when 8.9 is released. Maybe something to take into account when adding a new minor, some pages could be cleaned up in preparation for the content associated with that release.
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.
Oh, I see… I’m not really in favor of linking to something assuming it will be updated later. I’d rather update the link (e.g., on this page) when the referenced page is updated as well - ideally in the same PR. Otherwise, it may be forgotten. Anyhow, I leave it up to @mesellings's pass.
afgambin
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.
I made some text tweaks directly and left some comments for you to address. Nice work!
|
@pablocabrera85 @afgambin I'll review this for the What's new in 8.9 work, I wasn't planning on adding that page in yet, so I'd like to give that a once over first 👍 |
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.
Thanks for your work here @pablocabrera85 - we might not include this in the 8.9 What's new page as we move towards 8.9 as this is meant to be a soft intro to the main features (supported by announcements and release notes for granular info) but happy for it to be there as is for now the work has been done in this PR - approved from my end from that perspective - when do you want this merged and released?
|
@mesellings Would it be possible to merge it today as it is, or do you need me to remove the 8.9 What's new page changes? How do we usually handle this kind of changes in the docs bound to a release that is not yet available? |
|
Hi @pablocabrera85 no we can leave the what's new page in, that's fine - alpha docs are a wip so this is fine - regarding the feature, it often depends really - we can hold off releasing until the day before the release if there is a critical reason why we should wait until the feature is merged, or we can just release now/in anticipation of the release - this looks more like the latter, but it's up to you if there's a reason to hold the docs back? |
|
I don't think there is a reason to hold back. I'll proceed with merging it then 👍 @wollefitz Do you see any reason not to release this now after merging? |
Description
Closes https://github.com/camunda/web-modeler/issues/18704
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.