Git sync docs rework #1193
Draft
Git sync docs rework #1193
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Less emphasis on promotion, add the setup (including CI/CD) as part of this page
Deploying windmilldocs with
|
| Latest commit: |
cc36f18
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://cad15fd7.windmilldocs.pages.dev |
| Branch Preview URL: | https://git-sync-docs-rework.windmilldocs.pages.dev |
hcourdent
requested changes
Dec 19, 2025
| @@ -0,0 +1,51 @@ | |||
| import DocCard from '@site/src/components/DocCard'; | |||
|
|
|||
| # Collaborating on Windmill | |||
Contributor
There was a problem hiding this comment.
There is already a page 'Collaboration in Windmill' https://www.windmill.dev/docs/core_concepts/collaboration
Find another title
|
|
||
| # Collaborating on Windmill | ||
|
|
||
| In windmill there are multiple ways to collaborate |
|
|
||
| ## Workspace forks | ||
|
|
||
| The easiest and main way of collaborating on windmill is through the use of workspace forks. This feature lets users branch off of a workspace and have an exact copy where they can create new items or make changes, test them, and deploy them to the main workspace once it's all working. |
|
|
||
| ## Git sync | ||
|
|
||
| Git sync is a feature that replicates the state of a workspace into a git repository. When properly set-up, changes made to the repository are immediately reflected in the workspace, and vice-versa. This enables local development as well as development in the Web IDE to be tracked and managed by git, and any git-based workflow is possible. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Main change is to recommend workspace forks everywhere relevant, and for git sync, remove the "Sync mode" vs "Promotion mode" partition. Sync mode and promotion mode are different features that use the same tech, grouping them has been confusing for users. Promotion is mainly used for deployment workflows, so it's been rebranded to "Promotion workflow". sync mode is now simply Git sync.
Change might be a bit radical, I wrote it as I would have like to be presented to the concept in the first place, but if lmk if it's better to make it more "backwards compatible" in terms of doc and what is familiar to current users.