-
Notifications
You must be signed in to change notification settings - Fork 188
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
Consolidate intro to camunda #4181
Conversation
👋 🤖 🤔 Hello! 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.5/.
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. |
Thank you for the notes ❤️ really helps focus what you want us to review! |
Updating the branch to see if I can resolve the build errors and get the preview environment running for review. |
@christinaausley can you have a look at the build errors? |
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.
In the last section (Learn more), I'm a bit overwhelmed with doc cards. Maybe we can highlight a few as doc cards and show the rest as links or something less prominent.
Similarly, I think the Getting started section highlights our long time tension between how to get started with the platform, holistically, and how to do specific use cases. One recommendation here would be to call attention to the two "main" guides - Java Spring & modeling (maybe as doc cards?), while also mentioning the use case guides (maybe as links).
Co-authored-by: Amara Graham <[email protected]>
@camunda/tech-writers @akeller I think this PR is a fine baseline and starting point for general ideas, but I should have started conversation on a Miro board before launching changes -- I'm going to convert this to a draft, add a |
@akeller @conceptualshark here is the Miro board -- as @mesellings is out next week I figured the two of you may be best for review 👍 Once finalized I can pull these changes into this existing PR. |
Planning to review the Miro board today. |
I reviewed the Miro and then returned to the PR - I like where you are going with these changes! I particularly like that you put this in the Guides section, where the page structure mimics the sidebar content. One comment I left on Miro that I want to elaborate on a bit more - flipping the order of the doc cards and presenting the modeling content before the Spring SDK content. This is mostly a comment based on an untested hypothesis that our non-dev personas might be intimidated by seeing SDK-first content... well, first! We know nearly every persona interacting with Camunda must model (or interpret/see a model). We would also want to flip the order of the content on the sidebar. Do you have thoughts on this? |
@akeller @conceptualshark Thank you for your quick feedback! I'll plan to polish up this PR today with the proposed changes.
I agree with this -- I think we should flip the content as the Modeling content is so entry-level and core to the Camunda experience as a beginner. At least, it's the first thing I would click on as a newbie trying to figure out what Camunda is all about. I'm happy to swap it in the sidebar in this PR, but agreed that this should switch too. |
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 like the consolidation!
🙈 but of course, now I'm seeing other things I want to fix outside the scope of this PR. I'll save that for another issue scope.
@akeller Feel free to open another issue (or issues) and I can have a look! 😬 Merging this! |
🧹 Preview environment for this PR has been torn down. |
Description
Closes #4011 -- consolidates introduction to Camunda pages between guides and components.
Notes
When should this change go live?
hold
label or convert to draft PR)PR Checklist
/versioned_docs
directory./docs
directory (aka/next/
).