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.

Sign up for GitHub

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

Jump to bottom

Document Deploy and Play for process applications #4367

Merged
merged 9 commits into from
Oct 3, 2024
Merged

Document Deploy and Play for process applications #4367

merged 9 commits into from
Oct 3, 2024

Conversation

mesellings
Copy link
Contributor

@mesellings mesellings commented Sep 30, 2024 •
edited
Loading

Description

Relates to and closes #4182.

As per review comments on PR OOTB PDLC Happy Path documentation, this PR update the "Deploy and Run process applications" page for 8.6.

Specifically:

  • Between now and 8.6, it makes sense to deploy your process app since Play doesn't connect to a cluster.
  • Starting with 8.6, you should use Play to run your process in a development cluster and only use the Deploy/Run modals for interacting with other stages.

Acceptance criteria

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

@mesellings mesellings added kind/feature Issues related with features to be documented component:modeler Issues related with Modeler project component:web-modeler-SaaS Continuous delivery - Issues related with Web Modeler SaaS target:8.6 Issues included in the 8.6 release deploy Stand up a temporary docs site with this PR 8.6.0 October 2024 minor release labels Sep 30, 2024
@mesellings mesellings self-assigned this Sep 30, 2024
@mesellings mesellings mentioned this pull request Sep 30, 2024
Closed
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Sep 30, 2024 •
edited
Loading

👋 🤖 🤔 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/modeler/web-modeler/deploy-process-application.md
  • docs/components/modeler/web-modeler/process-applications.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 September 30, 2024 15:57 Destroyed
@mesellings
Copy link
Contributor Author

@HanselIdes I've created a draft of the edits I think might be required for this work - please can you check to see what else we might need to mention here? I also wasn't sure about whether to rename the page, what do you think?

https://preview.docs.camunda.cloud/pr-4367/docs/next/components/modeler/web-modeler/deploy-process-application/

@mesellings
Copy link
Contributor Author

Thanks for the feedback @HanselIdes - I've amended the page (including the title) to hopefully cover the things you have requested - let me know if more clarification is needed? (NB: Give the preview environment 20 mins to update)

HanselIdes
HanselIdes previously approved these changes Oct 1, 2024
View reviewed changes
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.

This reorganization makes a lot of sense. Thank you @mesellings !

@mesellings mesellings requested review from a team and removed request for a team October 1, 2024 12:46
@mesellings mesellings removed the deploy Stand up a temporary docs site with this PR label Oct 1, 2024
@mesellings
Copy link
Contributor Author

@HanselIdes Please re-approve as I made a few small edits (meta description) and updates to the main page 👍

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Oct 1, 2024

🧹 Preview environment for this PR has been torn down.

HanselIdes
HanselIdes previously approved these changes Oct 1, 2024
View reviewed changes
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.

LGTM - one minor grammatical comment about comma placement

docs/components/modeler/web-modeler/deploy-process-application.md Outdated Show resolved Hide resolved
HanselIdes
HanselIdes previously approved these changes Oct 1, 2024
View reviewed changes
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.

LGTM

@mesellings mesellings requested review from HanselIdes and a team October 1, 2024 14:45
@mesellings
Copy link
Contributor Author

@camunda/tech-writers Please review to merge this week for 8.6 👍

conceptualshark
conceptualshark reviewed Oct 1, 2024
View reviewed changes
Copy link
Contributor

@conceptualshark conceptualshark left a comment

Choose a reason for hiding this comment

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

A little feedback on adding context/incorporating the user journey here, with some added explanations.

docs/components/modeler/web-modeler/deploy-process-application.md Outdated Show resolved Hide resolved
docs/components/modeler/web-modeler/deploy-process-application.md Outdated Show resolved Hide resolved
docs/components/modeler/web-modeler/deploy-process-application.md Show resolved Hide resolved
docs/components/modeler/web-modeler/deploy-process-application.md Outdated Show resolved Hide resolved
docs/components/modeler/web-modeler/deploy-process-application.md Outdated Show resolved Hide resolved
docs/components/modeler/web-modeler/process-applications.md Outdated Show resolved Hide resolved
HanselIdes
HanselIdes previously approved these changes Oct 2, 2024
View reviewed changes
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.

LGTM (still)

@mesellings
Copy link
Contributor Author

@christinaausley @conceptualshark Please re-review for approval - great feedback - I have incorporated it all pretty much in one way or another, thank you! 👍 🚀

conceptualshark
conceptualshark approved these changes Oct 2, 2024
View reviewed changes
Copy link
Contributor

@conceptualshark conceptualshark left a comment

Choose a reason for hiding this comment

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

👍 LGTM! Nice improvements to this section.

@mesellings mesellings merged commit 5972511 into main Oct 3, 2024
8 checks passed
@mesellings mesellings deleted the mes-4182-play-deploy-process-applications branch October 3, 2024 09:56
christinaausley pushed a commit that referenced this pull request Oct 7, 2024
@mesellings @christinaausley
Document Deploy and Play for process applications (#4367)
91cd7d3 
* Draft edits to include Play

* Review edits

* Edits for title change

* Fix link and comma

* Fix comma

* TW review edits
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@conceptualshark conceptualshark conceptualshark approved these changes

@christinaausley christinaausley christinaausley approved these changes

@HanselIdes HanselIdes HanselIdes left review comments

Assignees

@mesellings mesellings

Labels
8.6.0 October 2024 minor release component:modeler Issues related with Modeler project component:web-modeler-SaaS Continuous delivery - Issues related with Web Modeler SaaS kind/feature Issues related with features to be documented target:8.6 Issues included in the 8.6 release
Projects
Developer Experience
Status: ✅ Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Document Deploy and Play for process applications
4 participants
@mesellings @HanselIdes @conceptualshark @christinaausley