Skip to content

Conversation

@afgambin
Copy link
Contributor

@afgambin afgambin commented Dec 4, 2025

Description

This PR addresses this issue.

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support. (add bug or support label)
  • This is already available but undocumented and should be released within a week. (add available & undocumented label)
  • This is on a specific schedule and the assignee will coordinate a release with the Documentation team. (create draft PR and/or add hold label)
  • This is part of a scheduled alpha or minor. (add alpha or minor label)
  • There is no urgency with this change (add low prio label)

PR Checklist

  • My changes are for an upcoming minor release and are in the /docs directory (version 8.9).
  • My changes are for an already released minor and are in a /versioned_docs directory.

@afgambin afgambin self-assigned this Dec 4, 2025
@afgambin afgambin added component:docs Documentation improvements, including new or updated content component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed labels Dec 4, 2025
@afgambin afgambin linked an issue Dec 4, 2025 that may be closed by this pull request
@afgambin afgambin added deploy Stand up a temporary docs site with this PR low prio There is no urgency with this change. labels Dec 4, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Dec 4, 2025

👋 🤖 🤔 Hello, @afgambin! 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/.

  • docs/self-managed/components/modeler/web-modeler/overview.md

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.

@github-actions github-actions bot temporarily deployed to camunda-docs December 4, 2025 18:01 Destroyed
@afgambin
Copy link
Contributor Author

afgambin commented Dec 4, 2025

@camunda/tech-writers this is ready for review. I'll backport it once we agree on the final version. Ty!

@afgambin afgambin requested a review from a team December 5, 2025 08:06
@camunda-docs-pr-automation camunda-docs-pr-automation bot moved this to 👀 In Review in Documentation Team Dec 5, 2025
@github-actions github-actions bot temporarily deployed to camunda-docs December 5, 2025 08:09 Destroyed
Copy link
Contributor

@christinaausley christinaausley left a comment

Choose a reason for hiding this comment

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

Thanks for taking this on! Overall feedback on this page:

Naming consistency

There’s heavy use of “Web Modeler on Self-Managed”, which reads awkwardly and isn’t aligned with how we refer to components elsewhere in the docs. It also starts to feel like a product rename.

Suggested approach:

  • Use Web Modeler (Self-Managed) in the title or when distinction is needed.
  • Use Web Modeler throughout the body text unless the SM distinction affects meaning.
  • Avoid repeating “on Self-Managed” in every paragraph.

Sidebar behavior

The sidebar currently shows “Overview” as a separate item.
For consistency with other components, clicking Web Modeler should take the reader directly to this overview page. No separate “Overview” entry should be needed.

Redundant heading

The page starts with:

Web-Modeler on Self-Managed

…and then immediately has another heading:

About Web Modeler on Self-Managed

Maybe we could remove the second header or just leave it as "About"? Feels redundant.

Improve clarity and tone

Some phrases are vague:

“Run Camunda's modeling experience in your own infrastructure.”

Consider being more concrete:

“Web Modeler lets teams design, review, and version BPMN and DMN diagrams directly in your Self-Managed environment.”

@github-actions github-actions bot temporarily deployed to camunda-docs December 9, 2025 10:44 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs December 9, 2025 11:45 Destroyed
@github-actions
Copy link
Contributor

github-actions bot commented Dec 9, 2025

The preview environment relating to the commit d3f41be has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-7476/

@afgambin
Copy link
Contributor Author

afgambin commented Dec 9, 2025

@christinaausley I addressed your reviews. I decided to remove the About section - I agree it feels a bit redundant after seeing it again today. Ready for another pass, thanks!

Copy link
Contributor

@christinaausley christinaausley left a comment

Choose a reason for hiding this comment

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

Looks awesome, great work 💪 Happy to re-approve once backported.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

component:docs Documentation improvements, including new or updated content component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed deploy Stand up a temporary docs site with this PR low prio There is no urgency with this change.

Projects

Status: 👀 In Review

Development

Successfully merging this pull request may close these issues.

Complete Self-Managed Web Modeler overview page

3 participants