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

docs(web-modeler): introduce gitlab sync #4583

Merged
merged 8 commits into from
Dec 10, 2024
Merged

Conversation

marcellobarile
Copy link
Contributor

Description

Introduces the GitLab sync functionality, which was added to the existing Git Sync feature.

Epic: https://github.com/camunda/product-hub/issues/2469
Part of https://github.com/camunda/web-modeler/issues/10911

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

@marcellobarile marcellobarile added component:web-modeler-SaaS Continuous delivery - Issues related with Web Modeler SaaS component:web-modeler-sm Issues related with Web Modeler Self-Managed 8.7.0-alpha2 December 2024 alpha release labels Nov 8, 2024
@marcellobarile marcellobarile requested review from JacobiCamunda and a team November 8, 2024 15:11
@marcellobarile marcellobarile self-assigned this Nov 8, 2024
Copy link
Contributor

github-actions bot commented Nov 8, 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.

@conceptualshark conceptualshark added the deploy Stand up a temporary docs site with this PR label Nov 8, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs November 8, 2024 16:37 Destroyed
@conceptualshark conceptualshark requested review from conceptualshark and removed request for a team November 8, 2024 16:57
conceptualshark
conceptualshark previously approved these changes Nov 8, 2024
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.

I've left a few suggestions here in two separate commits:

  • A review of the content as-is here
  • An option condensing the information into a tabbed display here

If you'd prefer not to introduce tabs at this time, I can roll back the second commit. You should be able to see the change in the deployed preview site, like this:
Screenshot 2024-11-08 at 12 29 47 PM

If any other repository hosts are planned, it will be helpful to have this scaffolding in place to add more options. Alternatively, we could look at creating a generic "Git Sync" page, and add options as their own independent subpages and reusable content. I'd be happy to take on some of this content structuring if it ends up being necessary, and it doesn't need to be decided or implemented here.

Otherwise this looks good to me! I'm approving for now, but can edit/adjust if the structure change isn't warranted at this time.

@github-actions github-actions bot temporarily deployed to camunda-docs November 8, 2024 17:45 Destroyed
@marcellobarile
Copy link
Contributor Author

@conceptualshark

An option condensing the information into a tabbed display

Yes! That's fantastic! We will indeed add more providers in the (near) future. Thanks!

JacobiCamunda
JacobiCamunda previously approved these changes Nov 11, 2024
Copy link
Contributor

@JacobiCamunda JacobiCamunda left a comment

Choose a reason for hiding this comment

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

Looks good from my side, except one thing about the permissions.
But already approving 👍

docs/components/modeler/web-modeler/git-sync.md Outdated Show resolved Hide resolved
@github-actions github-actions bot temporarily deployed to camunda-docs November 11, 2024 13:16 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs November 12, 2024 15:02 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs November 18, 2024 11:12 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs December 9, 2024 08:28 Destroyed
@github-actions github-actions bot temporarily deployed to camunda-docs December 9, 2024 12:29 Destroyed
@JacobiCamunda
Copy link
Contributor

I added a new commit 0aaa103 to:

  • address the new permissions we decided on
  • rename "Project Access Token" to "Access Token" (See issue),
  • Marked a GitHub limitation as GitHub specific
  • Updated the info that a path will not be automatically created for GitLab if it does not already exist (This is contrary to GitHub, where this is possible)
  • Added a note for self-hosted GitLab instances, similar to how it was done for GitHub (See here)

@conceptualshark, please give me another round of feedback or integrate your proposals directly.

CC: @wollefitz, you said we don't need to adjust the docs for the access token change but I changed it nonetheless to be transparent. I marked project access tokens as recommended but did not specify why. Maybe should just mark a personal access token as "not recommended" instead

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.

👍 This update looks good to me!

@github-actions github-actions bot temporarily deployed to camunda-docs December 9, 2024 15:32 Destroyed
@christinaausley
Copy link
Contributor

christinaausley commented Dec 9, 2024

@marcellobarile Feel free to mark this as Ready for review and merge when you are ready 👍

@wollefitz wollefitz added 8.7.0-alpha3 January 2024 alpha release and removed 8.7.0-alpha2 December 2024 alpha release labels Dec 10, 2024
@github-actions github-actions bot temporarily deployed to camunda-docs December 10, 2024 07:44 Destroyed
@JacobiCamunda JacobiCamunda marked this pull request as ready for review December 10, 2024 12:31
@github-actions github-actions bot temporarily deployed to camunda-docs December 10, 2024 12:45 Destroyed
@JacobiCamunda JacobiCamunda merged commit 37b73a5 into main Dec 10, 2024
8 checks passed
@JacobiCamunda JacobiCamunda deleted the web-modeler-gitlab-sync branch December 10, 2024 13:19
Copy link
Contributor

🧹 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
Labels
8.7.0-alpha3 January 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
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

5 participants