Skip to content
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

Merged
merged 12 commits into from
Aug 30, 2024
Merged

Conversation

christinaausley
Copy link
Contributor

Description

Closes #4011 -- consolidates introduction to Camunda pages between guides and components.

Notes

  • Will backport upon approval.
  • Do we feel Connectors are highlighted well enough? I don't think we consider Connectors one of the six "components," and it is mentioned in next steps, but not sure if I should add an admonition noting Connectors in the intro to the page.
  • Does this location make sense? It is centered around the guides content, so it makes sense with the current changes, but I'm open to adjusting this based on opinions.

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@christinaausley christinaausley added the component:docs Documentation improvements, including new or updated content label Aug 21, 2024
@christinaausley christinaausley self-assigned this Aug 21, 2024
@christinaausley christinaausley added the deploy Stand up a temporary docs site with this PR label Aug 21, 2024
Copy link
Contributor

👋 🤖 🤔 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/.

  • docs/components/components-overview.md
  • docs/components/modeler/about-modeler.md
  • docs/components/operate/operate-introduction.md
  • docs/components/tasklist/introduction-to-tasklist.md
  • docs/components/zeebe/zeebe-overview.md
  • docs/guides/automating-a-process-using-bpmn.md
  • docs/guides/configuring-out-of-the-box-connector.md
  • docs/guides/create-cluster.md
  • docs/guides/getting-started-orchestrate-microservices.md
  • docs/guides/img/ComponentsAndArchitecture_SaaS.png
  • docs/guides/improve-processes-with-optimize.md
  • docs/guides/introduction-to-camunda-8.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.

@akeller
Copy link
Member

akeller commented Aug 22, 2024

Do we feel Connectors are highlighted well enough? I don't think we consider Connectors one of the six "components," and it is mentioned in next steps, but not sure if I should add an admonition noting Connectors in the intro to the page.
Does this location make sense? It is centered around the guides content, so it makes sense with the current changes, but I'm open to adjusting this based on opinions.

Thank you for the notes ❤️ really helps focus what you want us to review!

@akeller
Copy link
Member

akeller commented Aug 22, 2024

Updating the branch to see if I can resolve the build errors and get the preview environment running for review.

@akeller
Copy link
Member

akeller commented Aug 22, 2024

@christinaausley can you have a look at the build errors?

@github-actions github-actions bot temporarily deployed to camunda-docs August 22, 2024 22:06 Destroyed
Copy link
Member

@akeller akeller left a 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).

@github-actions github-actions bot temporarily deployed to camunda-docs August 23, 2024 12:18 Destroyed
@christinaausley
Copy link
Contributor Author

christinaausley commented Aug 23, 2024

@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 hold label, and add a link to that Miro board here shortly for continued discussion.

@christinaausley
Copy link
Contributor Author

@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.

@christinaausley christinaausley marked this pull request as draft August 23, 2024 18:41
@christinaausley christinaausley added the hold This issue is parked, do not merge. label Aug 23, 2024
@christinaausley christinaausley changed the title Consolidate intro to camunda [DRAFT] Consolidate intro to camunda Aug 23, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs August 23, 2024 18:59 Destroyed
@akeller
Copy link
Member

akeller commented Aug 26, 2024

Planning to review the Miro board today.

@akeller
Copy link
Member

akeller commented Aug 26, 2024

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?

@christinaausley
Copy link
Contributor Author

@akeller @conceptualshark Thank you for your quick feedback! I'll plan to polish up this PR today with the proposed changes.

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.

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.

@christinaausley christinaausley marked this pull request as ready for review August 26, 2024 17:40
@christinaausley christinaausley removed the hold This issue is parked, do not merge. label Aug 26, 2024
@christinaausley christinaausley changed the title [DRAFT] Consolidate intro to camunda Consolidate intro to camunda Aug 26, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs August 26, 2024 17:50 Destroyed
Copy link
Member

@akeller akeller left a 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.

@christinaausley
Copy link
Contributor Author

christinaausley commented Aug 30, 2024

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!

@christinaausley christinaausley merged commit 05e7776 into main Aug 30, 2024
9 of 10 checks passed
@christinaausley christinaausley deleted the consolidate-intro-to-camunda branch August 30, 2024 16:06
Copy link
Contributor

🧹 Preview environment for this PR has been torn down.

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 deploy Stand up a temporary docs site with this PR
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Consolidate Intro to Camunda 8 + Intro to Components
2 participants