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

docs(web modeler): Milestones and process application changelist #4107

Merged
merged 11 commits into from
Aug 9, 2024
Merged

docs(web modeler): Milestones and process application changelist #4107

merged 11 commits into from
Aug 9, 2024

Conversation

mesellings
Copy link
Contributor

@mesellings mesellings commented Aug 6, 2024 •
edited by wollefitz
Loading

Description

Document the new code/visual comparison feature for milestones.

  • Edited the Milestones page to reference new feature, and page edits to improve documentation and missing gaps.
  • Edited the versioning section in the Process application page to reference new feature.

Closes https://github.com/camunda/web-modeler/issues/10035.
Closes https://github.com/camunda/web-modeler/issues/9582

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 component:modeler Issues related with Modeler project 8.6.0-alpha4 August 2024 alpha release labels Aug 6, 2024
@mesellings mesellings requested review from nithinssabu and a team August 6, 2024 10:26
@mesellings mesellings self-assigned this Aug 6, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Aug 6, 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/img/milestones/web-modeler-milestone-action-menu-item-highlight.png
  • docs/components/modeler/web-modeler/img/milestones/web-modeler-milestone-code-diffing.png
  • docs/components/modeler/web-modeler/img/milestones/web-modeler-milestone-compare-process-application-files-highlight.png
  • docs/components/modeler/web-modeler/img/milestones/web-modeler-milestone-create-versioned-milestone-highlight.png
  • docs/components/modeler/web-modeler/img/milestones/web-modeler-milestone-create-via-breadcrumb-highlight.png
  • docs/components/modeler/web-modeler/img/milestones/web-modeler-milestone-create-via-icon-highlight.png
  • docs/components/modeler/web-modeler/img/milestones/web-modeler-milestone-restore-complete-highlight.png
  • docs/components/modeler/web-modeler/img/milestones/web-modeler-milestone-restore-highlight.png
  • docs/components/modeler/web-modeler/img/milestones/web-modeler-milestone-show-history-via-breadcrumb-highlight.png
  • docs/components/modeler/web-modeler/img/milestones/web-modeler-milestone-visual-diffing.png
  • docs/components/modeler/web-modeler/img/process-applications/process-application-milestone-diagram.png
  • docs/components/modeler/web-modeler/milestones.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.

@mesellings mesellings added deploy Stand up a temporary docs site with this PR hold This issue is parked, do not merge. labels Aug 6, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs August 6, 2024 11:02 Destroyed
@mesellings
Copy link
Contributor Author

Preview docs are here:

nithinssabu
nithinssabu reviewed Aug 6, 2024
View reviewed changes
docs/components/modeler/web-modeler/milestones.md Outdated Show resolved Hide resolved
docs/components/modeler/web-modeler/milestones.md Outdated Show resolved Hide resolved
docs/components/modeler/web-modeler/milestones.md Outdated Show resolved Hide resolved
docs/components/modeler/web-modeler/milestones.md Outdated Show resolved Hide resolved
docs/components/modeler/web-modeler/milestones.md Outdated Show resolved Hide resolved
docs/components/modeler/web-modeler/process-applications.md Outdated Show resolved Hide resolved
@christinaausley
Copy link
Contributor

@mesellings Just let me know when you're ready for a final review and I'll have a look 👍

@mesellings
Copy link
Contributor Author

@mesellings Just let me know when you're ready for a final review and I'll have a look 👍

Thanks @christinaausley still making some technical edits from engineering review 👍

@github-actions github-actions bot temporarily deployed to camunda-docs August 6, 2024 16:36 Destroyed
nithinssabu
nithinssabu reviewed Aug 6, 2024
View reviewed changes
Copy link
Contributor

@nithinssabu nithinssabu left a comment

Choose a reason for hiding this comment

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

Great job @mesellings 🚀

Thanks a lot for the effort here!

Good to go from my point of view. Leaving the final approval to @christinaausley

@github-actions github-actions bot temporarily deployed to camunda-docs August 7, 2024 09:42 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs August 7, 2024 09:53 Destroyed
@mesellings mesellings requested a review from nithinssabu August 7, 2024 10:17
@mesellings
Copy link
Contributor Author

@nithinssabu I made major changes to the versioning section as suggested, please review for accuracy.

@nithinssabu
Copy link
Contributor

I made major changes to the versioning section as suggested, please review for accuracy.

Looks really good to me @mesellings 🚀

@mesellings
Copy link
Contributor Author

Thanks for the review @nithinssabu - one final question, does this feature affect 8.5, 8.4 etc? If it does, I will also backport the changes to these doc versions. And also, is this still going out in alpha 4 next week?

@mesellings
Copy link
Contributor Author

@christinaausley Thanks for your patience, if you have a time a review would be great please?

@nithinssabu
Copy link
Contributor

one final question, does this feature affect 8.5, 8.4 etc? If it does, I will also backport the changes to these doc versions. And also, is this still going out in alpha 4 next week?

  • Nope, a backport is not necessary
  • Yes, it's going out in the alpha release next week

@github-actions github-actions bot temporarily deployed to camunda-docs August 7, 2024 15:35 Destroyed
@wollefitz
Copy link
Member

@nithinssabu Can we merge this already?

@nithinssabu
Copy link
Contributor

Can we merge this already?

It needs a final tech writer review cc: @christinaausley

@wollefitz wollefitz added component:web-modeler-SaaS Continuous delivery - Issues related with Web Modeler SaaS component:web-modeler-sm Issues related with Web Modeler Self-Managed and removed hold This issue is parked, do not merge. component:modeler Issues related with Modeler project labels Aug 8, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs August 8, 2024 08:12 Destroyed
christinaausley
christinaausley approved these changes Aug 8, 2024
View reviewed changes
Copy link
Contributor

@christinaausley christinaausley left a comment

Choose a reason for hiding this comment

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

🚀 Super clean!

@wollefitz wollefitz added hold This issue is parked, do not merge. and removed hold This issue is parked, do not merge. labels Aug 8, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs August 8, 2024 18:26 Destroyed
@nithinssabu nithinssabu merged commit b3fcd61 into main Aug 9, 2024
17 of 20 checks passed
@nithinssabu nithinssabu deleted the mes-10035-process-application-changelist branch August 9, 2024 03:42
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Aug 9, 2024

🧹 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
Reviewers

@christinaausley christinaausley christinaausley approved these changes

@nithinssabu nithinssabu nithinssabu approved these changes

Assignees

@mesellings mesellings

Labels
8.6.0-alpha4 August 2024 alpha release component:web-modeler-SaaS Continuous delivery - Issues related with Web Modeler SaaS component:web-modeler-sm Issues related with Web Modeler Self-Managed deploy Stand up a temporary docs site with this PR
Projects
Developer Experience
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@mesellings @christinaausley @nithinssabu @wollefitz