-
Notifications
You must be signed in to change notification settings - Fork 226
docs(web-modeler-self-managed): Add landing page #7476
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
base: main
Are you sure you want to change the base?
Conversation
|
👋 🤖 🤔 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/.
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. |
|
@camunda/tech-writers this is ready for review. I'll backport it once we agree on the final version. Ty! |
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 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.”
|
The preview environment relating to the commit d3f41be has successfully been deployed. You can access it at https://preview.docs.camunda.cloud/pr-7476/ |
|
@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! |
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.
Looks awesome, great work 💪 Happy to re-approve once backported.
Description
This PR addresses this issue.
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.