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

poc: c8 migration manual #4557

Merged
merged 6 commits into from
Dec 3, 2024
Merged

poc: c8 migration manual #4557

merged 6 commits into from
Dec 3, 2024

Conversation

christinaausley
Copy link
Contributor

Description

Relates to camunda/camunda#23736.

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 hold This issue is parked, do not merge. target:8.7 Issues included in the 8.7 release labels Nov 1, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 1, 2024 •
edited
Loading

👋 🤖 🤔 Hello, @christinaausley! 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.6/.

  • docs/apis-tools/migration-manuals/migrate-to-camunda-api.md
  • docs/apis-tools/operate-api/overview.md
  • docs/apis-tools/tasklist-api-rest/tasklist-api-rest-overview.md
  • docs/apis-tools/working-with-apis-tools.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.

@christinaausley christinaausley mentioned this pull request Nov 1, 2024
Open
@christinaausley christinaausley added the deploy Stand up a temporary docs site with this PR label Nov 1, 2024
@christinaausley christinaausley removed the request for review from tmetzke November 3, 2024 19:48
@tmetzke
Copy link
Member

tmetzke commented Nov 4, 2024

Thanks for starting with this already, @christinaausley, appreciate it 👍
Let's try to get a first clean version merged so all follow-up effort can directly go into this repo instead of the Google Doc first, what do you think?

@christinaausley
Copy link
Contributor Author

@tmetzke I'll have another set of edits on this tomorrow 👍 Note that this issue semi-relates to #4573.

@christinaausley
Copy link
Contributor Author

Let's try to get a first clean version merged so all follow-up effort can directly go into this repo instead of the Google Doc first, what do you think?

@tmetzke I made some formatting adjustments -- let me know what you think 👍

@christinaausley christinaausley marked this pull request as ready for review November 7, 2024 09:26
@github-actions github-actions bot temporarily deployed to camunda-docs November 7, 2024 09:42 Destroyed
@christinaausley
Copy link
Contributor Author

@tmetzke Could you have a look over this draft and add any required adjustments to merge for a first draft?

tmetzke
tmetzke previously approved these changes Nov 27, 2024
View reviewed changes
Copy link
Member

@tmetzke tmetzke left a comment

Choose a reason for hiding this comment

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

👍 Really cool, @christinaausley, I like the tab idea so we get a comprehensive list of endpoints and for each of them you can browse the changes bit by bit.

💭 Let's see how this looks like when we have more endpoints in here but we can adjust 🦖

@tmetzke tmetzke force-pushed the c8-migration-manual branch from 958f531 to 2859f66 Compare November 28, 2024 08:32
@github-actions github-actions bot temporarily deployed to camunda-docs November 28, 2024 08:45 Destroyed
@tmetzke tmetzke added component:zeebe Issues related with Zeebe project and removed hold This issue is parked, do not merge. labels Nov 28, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs November 28, 2024 10:21 Destroyed
@christinaausley christinaausley requested a review from a team December 2, 2024 15:57
akeller
akeller requested changes Dec 2, 2024
View reviewed changes
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.

Since the intention of this PR is to merge and keep iterating, the only blocking change I have is the note in the Admin API since it's not part of the V1 APIs or the migration to the C8 REST API.

@github-actions github-actions bot temporarily deployed to camunda-docs December 3, 2024 14:42 Destroyed
akeller
akeller reviewed Dec 3, 2024
View reviewed changes
docs/apis-tools/migration-manuals/migrate-to-camunda-api.md
Camunda is streamlining the developer experience by creating a unified REST API for Zeebe, Operate, Tasklist, and the Identity components with endpoint parity. This will be a single REST API for the orchestration cluster for a consistent and intuitive API experience to help your teams develop process automation solutions faster.

:::note
The Administration and Web Modeler APIs will not be part of the Camunda 8 REST API, as these are platform APIs outside the cluster’s scope.
Copy link
Member

Choose a reason for hiding this comment

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

We'll need to refine what "cluster" means, but we have not settled on clear definitions. See #4648.

akeller
akeller approved these changes Dec 3, 2024
View reviewed changes
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'm ok with this as a first increment to merge! 👍

@christinaausley christinaausley merged commit c11d024 into main Dec 3, 2024
8 checks passed
@christinaausley christinaausley deleted the c8-migration-manual branch December 3, 2024 15:36
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Dec 3, 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

@akeller akeller akeller approved these changes

@tmetzke tmetzke Awaiting requested review from tmetzke

Assignees

@tmetzke tmetzke

@christinaausley christinaausley

Labels
component:zeebe Issues related with Zeebe project deploy Stand up a temporary docs site with this PR target:8.7 Issues included in the 8.7 release
Projects
Documentation Team
Status: ✅ Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@christinaausley @tmetzke @akeller