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

Adjust Play page for keywords #3912

Merged
merged 7 commits into from
Jun 11, 2024
Merged

Adjust Play page for keywords #3912

merged 7 commits into from
Jun 11, 2024

Conversation

akeller
Copy link
Member

@akeller akeller commented Jun 7, 2024

Description

Closes https://github.com/camunda/developer-experience/issues/315.

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/).

@akeller akeller added component:modeler Issues related with Modeler project component:web-modeler-SaaS Continuous delivery - Issues related with Web Modeler SaaS component:web-modeler-sm Issues related with Web Modeler Self-Managed labels Jun 7, 2024
@akeller akeller requested review from HanselIdes and a team June 7, 2024 20:37
@akeller akeller self-assigned this Jun 7, 2024
@akeller akeller added the hold This issue is parked, do not merge. label Jun 7, 2024
Copy link
Contributor

github-actions bot commented Jun 7, 2024

👋 🤖 ✅ Looks like the changes were ported across versions, nice job! 🎉

You can read more about the versioning within our docs in our documentation guidelines.

@akeller
Copy link
Member Author

akeller commented Jun 7, 2024

I didn't backport these changes, but I'm also looking for a little help.

I want a crisper comparison sentence between Play and Operate, or put another way, what you can do in Play that you may otherwise do in Operate if you weren't already Play-ing.

@HanselIdes
Copy link
Contributor

I want a crisper comparison sentence between Play and Operate, or put another way, what you can do in Play that you may otherwise do in Operate if you weren't already Play-ing.

Operate is designed to monitor many production process instances and intervene only as necessary, while Play is designed to drive a single process instance through the process and mock external systems. Both offer monitoring of a single process instance, its variables and path, incidents, as well as actions to modify or repair a process instance. Operate offers bulk actions and guardrails against breaking production processes while Play offers a streamlined UX to quickly run through scenarios.

@akeller does this help?

Copy link
Contributor

@HanselIdes HanselIdes left a comment

Choose a reason for hiding this comment

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

The blatant keyword-stuffing felt a little disruptive to the documentation's flow, so I made a few recommendations to tone it down

docs/components/modeler/web-modeler/play-your-process.md Outdated Show resolved Hide resolved
@@ -45,7 +47,7 @@ You have a few options to mock an external system:
- In **Implement** mode, hard-code an example payload in the task or event **Output** section.
- When completing a task or event, use the secondary action to complete it with variables.

Incidents are raised as they would in any Camunda cluster. Use the variables and incident message to debug the issue.
Incidents are raised as they would in any Camunda cluster, just within the context of Play, instead of Operate. Use the variables and incident message to debug the issue, all while staying in Play.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Incidents are raised as they would in any Camunda cluster, just within the context of Play, instead of Operate. Use the variables and incident message to debug the issue, all while staying in Play.
Incidents are raised in Play just like in Operate. Use the variables and incident message to debug the process instance.

@akeller
Copy link
Member Author

akeller commented Jun 10, 2024

@HanselIdes thanks for the collab here! I'll clean this up later today and include the Operate comparison info. I think this will help humans and AI position Play and Operate, but I'll let you know when it's live and ingested so we can test.

@akeller akeller removed the hold This issue is parked, do not merge. label Jun 10, 2024
@christinaausley christinaausley merged commit 4cc64c7 into main Jun 11, 2024
6 of 7 checks passed
@christinaausley christinaausley deleted the keyword-stuff-play branch June 11, 2024 19:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:modeler Issues related with Modeler project component:web-modeler-SaaS Continuous delivery - Issues related with Web Modeler SaaS component:web-modeler-sm Issues related with Web Modeler Self-Managed
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

4 participants