docs(web modeler): add feature documentation for git sync

[conceptualshark]

Description

Resolves https://github.com/camunda/web-modeler/issues/9706, feature documentation for Git Sync (GitHub only).

Related to https://github.com/camunda/product-hub/issues/2036

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

• My changes require an Engineering review, and I've assigned the Engineering DRI or delegate.
• My changes require a technical writer review, and I've assigned @camunda/tech-writers as a reviewer.

[github-actions]

👋 🤖 🤔 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/git-sync.md
• docs/components/modeler/web-modeler/img/git-sync.png

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.

[marcellobarile]

Adding @JacobiCamunda so he can give his BE engineer point of view regarding possible errors and known limitations.

[JacobiCamunda]

Very nice to read! 🚀
I reviewed from the backend perspective for the current implementation. I will add another review if necessary when the push operation is fully integrated.

CC: @marcellobarile

[marcellobarile]

🔝 very nicely done! Thanks!

[marcellobarile]

@conceptualshark there is a small change in the settings dialog;
We are replacing Application ID and Owner name with Installation ID and Client ID.
The Installation ID can be retrieved as explained here
From a role perspective, the nature of these two fields does not change from the previous implementation.

The new UI:

The issue for this change:
https://github.com/camunda/web-modeler/issues/10302

Excuse us for the last-minute change :) I hope that's fine.

FYI @JacobiCamunda

[JacobiCamunda]

@marcellobarile, a part would be good to say that actions which alters the commit sha which Web Modeler is currently synced to (like a squash) in the remote branch could break the git sync.

[marcellobarile]

@conceptualshark this morning we have acknowledged that timeouts during the sync operations might occur (we don't know how often yet). Is it worth mentioning this in the known limitations? the only thing that the user could to so far is retrying.

[marcellobarile]

👍

[marcellobarile]

just touching base, is there any review still pending here?

[conceptualshark]

@marcellobarile I believe we're good to go - just let me know if it can be merged now (and if you'd like a docs release at any point). Otherwise, I can put a hold label on it until you're ready.

[marcellobarile]

@conceptualshark thanks for the update! It's good to know that the doc is ready, just put it on hold because we are still about to kick-off the QA.
Let's merge this in the context of the next release. I'll keep you posted when ready.

[akeller]

@conceptualshark thanks for the update! It's good to know that the doc is ready, just put it on hold because we are still about to kick-off the QA. Let's merge this in the context of the next release. I'll keep you posted when ready.

Popping in to say I LOVE that the docs were drafted ahead of QA! Having them available means QA can provide feedback on the docs experience as part of the overall epic experience. Great job! 🧡

[marcellobarile]

@conceptualshark the feature has been merged to the main branch and will be released on SaaS tomorrow. Ping me once your release is done so we can orchestrate ours.

[conceptualshark]

@marcellobarile The docs should now be live: https://docs.camunda.io/docs/next/components/modeler/web-modeler/git-sync/