Tuto migrate task from Airplane to Windmill (windmill-labs#463)

hcourdent · web-flow · commit 6c1f95207a89 · 2024-01-10T13:09:09.000+01:00
diff --git a/docs/advanced/11_git_sync/index.mdx b/docs/advanced/11_git_sync/index.mdx
@@ -1,6 +1,6 @@
 import DocCard from '@site/src/components/DocCard';
 
-# Sync Workspace to Remote Git Repository
+# Git Sync
 
 From the workspace settings, you can set a [git_repository](../../integrations/git_repository.mdx) resource on which the workspace will automatically commit and push scripts, flows and apps to the repository on each [deploy](../../core_concepts/0_draft_and_deploy/index.mdx).
 
@@ -13,7 +13,7 @@ For all details on Version Control in Windmill, see [Version Control](../../adva
 <iframe
 	style={{ aspectRatio: '16/9' }}
 	src="https://www.youtube.com/embed/JqG0KNYWLx0?vq=hd1080"
-	title="Sync Workspace to Remote Git Repository"
+	title="Git Sync"
 	frameBorder="0"
 	allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
 	allowFullScreen
diff --git a/docs/advanced/12_deploy_to_prod/index.mdx b/docs/advanced/12_deploy_to_prod/index.mdx
@@ -38,8 +38,8 @@ Windmill integration with Git repositories makes it possible to adopt a robust d
 The process is as follows:
 - Users iterate and make their changes in a "staging" Windmill workspace.
 - Every time a Windmill App, Flow or Script is deployed to that workspace (via Windmill's UI), Windmill automatically commits it to this repo and creates one branch per app/flow/script.
-- On every commit from Windmill, PRs are automatically created via a GitHub action. Approved GitHub users can review and merge those PRs.
-- Every time a PR is merged, another GitHub action automatically deploys the change to a "production" Windmill workspace.
+- On every commit from Windmill, PRs are automatically created via a GitHub Action. Approved GitHub users can review and merge those PRs.
+- Every time a PR is merged, another GitHub Action automatically deploys the change to a "production" Windmill workspace.
 
 This gives the flexibility to fully test new Windmill scripts, flows and apps, while having them version-controlled and deployed in an automated way to the production environment.
 
@@ -55,8 +55,8 @@ More details at:
 	/>
 </div>
 
-## Using Windmill CLI in GitHub actions
+## Using Windmill CLI in GitHub Actions
 
-Finally, you can define your own GitHub actions to pull Windmill workspace regularly from GitHub using [Windmill CLI](../3_cli/index.mdx). To automatically deploy a PR to the Windmill workspace, the [push-on-merge.yaml](https://github.com/windmill-labs/windmill-sync-example/blob/main/.github/workflows/push-on-merge.yaml) can be used.
+Finally, you can define your own GitHub Actions to pull Windmill workspace regularly from GitHub using [Windmill CLI](../3_cli/index.mdx). To automatically deploy a PR to the Windmill workspace, the [push-on-merge.yaml](https://github.com/windmill-labs/windmill-sync-example/blob/main/.github/workflows/push-on-merge.yaml) can be used.
 
-And another GitHub action can be created to regularly pull Windmill workspace to the GitHub repo using Windmill CLI. This action can be run on a schedule to keep the repo and the workspace in sync.
+And another GitHub Action can be created to regularly pull Windmill workspace to the GitHub repo using Windmill CLI. This action can be run on a schedule to keep the repo and the workspace in sync.
diff --git a/docs/advanced/13_version_control/index.mdx b/docs/advanced/13_version_control/index.mdx
@@ -4,14 +4,14 @@ import DocCard from '@site/src/components/DocCard';
 
 Manage changes to scripts workflows, apps and resources using commits & push on remote repositories.
 
-## Sync Workspace to Remote Git Repository
+## Git Sync
 
 From the workspace settings, you can set a [git_repository](../../integrations/git_repository.mdx) resource on which the workspace will automatically commit and push scripts, flows and apps to the repository on each [deploy](../../core_concepts/0_draft_and_deploy/index.mdx).
 
 <iframe
 	style={{ aspectRatio: '16/9' }}
 	src="https://www.youtube.com/embed/JqG0KNYWLx0?vq=hd1080"
-	title="Sync Workspace to Remote Git Repository"
+	title="Git Sync"
 	frameBorder="0"
 	allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
 	allowFullScreen
@@ -20,13 +20,13 @@ From the workspace settings, you can set a [git_repository](../../integrations/g
 
 <br/>
 
-Sync Workspace to Remote Git Repository is [Cloud and Self-Hosted Enterprise Edition](/pricing) only.
+Git Sync is [Cloud and Self-Hosted Enterprise Edition](/pricing) only.
 
 More details at:
 
 <div class="grid grid-cols-2 gap-6 mb-4">
 		<DocCard
-			title="Sync Workspace to Remote Git Repository"
+			title="Git Sync"
 			description="Connect the Windmill workspace to a Git repository to automatically commit and push scripts, flows and apps to the repository on each deploy."
 			href="/docs/advanced/git_sync"
 	/>
diff --git a/docs/advanced/4_local_development/run_locally.mdx b/docs/advanced/4_local_development/run_locally.mdx
@@ -63,7 +63,7 @@ You should see all your scripts, flows, apps inside the folder.
 
 You can now edit the files directly as shown below.
 
-Once you have finished developement, you can either [push the files directly to your remote](#pushing-your-scripts-to-windmill) or setup [GitHub action to push changes to your workspace on commit](https://github.com/windmill-labs/windmill-sync-example).
+Once you have finished developement, you can either [push the files directly to your remote](#pushing-your-scripts-to-windmill) or setup [GitHub Action to push changes to your workspace on commit](https://github.com/windmill-labs/windmill-sync-example).
 
 ## Deno / Bun
 
diff --git a/docs/advanced/9_deploy_gh_gl/index.md b/docs/advanced/9_deploy_gh_gl/index.md
@@ -1,4 +1,4 @@
-# Deploy to Prod using a Git Workflow
+# Deploy to prod using a Git Workflow
 
 Windmill integration with Git repositories makes it possible to adopt a robust development process for your Windmill scripts, flows and apps.
 
@@ -11,10 +11,10 @@ For all details on Deployments to Prods, see [Deploy to Prod](../../advanced/12_
 The process is as follows:
 - Users iterate and make their changes in a "staging" Windmill workspace.
 - Every time a Windmill App, Flow or Script is deployed to that workspace (via Windmill's UI), Windmill automatically commits it to this repo and creates one branch per app/flow/script.
-- On every commit from Windmill, PRs are automatically created via a GitHub action. Approved GitHub users can review and merge those PRs.
-- Every time a PR is merged, another GitHub action automatically deploys the change to a "production" Windmill workspace.
+- On every commit from Windmill, PRs are automatically created via a [GitHub Action](https://docs.github.com/en/actions). Approved GitHub users can review and merge those PRs.
+- Every time a PR is merged, another GitHub Action automatically deploys the change to a "production" Windmill workspace.
 
-This gives the flexibility to fully test new Windmill scripts, flows and apps, while having them version-controlled and deployed in an automated way to the production environment.
+This gives the flexibility to fully test new Windmill scripts, flows and apps, while having them [version-controlled](../13_version_control/index.mdx) and deployed in an automated way to the production environment.
 
 :::info
 
@@ -30,25 +30,25 @@ Check out the [windmill-sync-example repository](https://github.com/windmill-lab
 
 ## Setup
 
-Note: this is the detailed setup steps for a GitHub repository. It will need to be adapted for GitLab.
+Note: this is the detailed setup steps for a [GitHub](https://github.com/) repository. It will need to be adapted for [GitLab](https://about.gitlab.com/).
 
 ### GitHub repository setup
 
-First the GitHub repo needs to be set up and Windmill needs to be able to commit to it. 
+First, the GitHub repo needs to be set up and Windmill needs to be able to commit to it. 
 
 1. Create a GitHub repository.
-1. Generate a [GitHub token with write permission](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) to this repository. This is n@ecessary for Windmill to push commits to the repo every time a change is made to the staging workspace.
-1. In the repository settings > Actions > General, tick the [Allow GitHub Actions to create and approve pull requests](https://docs.github.com/en/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#preventing-github-actions-from-creating-or-approving-pull-requests). This is necessary for the GitHub action automatically creating PRs when Windmill commits a change.
-1. From Windmill, create a token under User settings > Token and [save it as a secret](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository) named `WMILL_TOKEN` in the repo settings > "Secret and Variable" > "Actions". This is necessary for Windmill to push to the production workspace.
+1. Generate a [GitHub token with write permission](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens#creating-a-fine-grained-personal-access-token) to this repository. This is necessary for Windmill to push commits to the repo every time a change is made to the staging workspace.
+1. In the repository Settings > Actions > General, tick the [Allow GitHub Actions to create and approve pull requests](https://docs.github.com/en/enterprise-server@3.10/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-github-actions-settings-for-a-repository#preventing-github-actions-from-creating-or-approving-pull-requests). This is necessary for the GitHub Action automatically creating PRs when Windmill commits a change.
+2. From Windmill, create a [token](../../core_concepts/4_webhooks/index.mdx#user-token) under User settings > Token and [save it as a secret](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository) named `WMILL_TOKEN` in the repo Settings > "Secret and Variable" > "Actions". This is necessary for Windmill to push to the production workspace.
 
 ### Windmill setup
 
-1. In Windmill, create a [git_repository](https://hub.windmill.dev/resource_types/135/git_repository) [resource](../../core_concepts/3_resources_and_types/index.mdx) pointing to the GitHub repository and containing the token generated previously. You URL should be `https://[USERNAME]:[TOKEN]@github.com/[ORG|USER]/[REPO_NAME].git`. Note that you have the possibility to input a custom branch name and a subfolder in this resource. Given that we are going to request Windmill to create one branch per script/flow/app, setting a custom branch will have no effect. However, if you wish to persist the windmill workspace in a subfolder of your repository, you can set it here.
+1. In Windmill, create a [git_repository](https://hub.windmill.dev/resource_types/135/git_repository) [resource](../../core_concepts/3_resources_and_types/index.mdx) pointing to the GitHub repository and containing the token generated previously. You URL should be `https://[USERNAME]:[TOKEN]@github.com/[ORG|USER]/[REPO_NAME].git`. Note that you have the possibility to input a custom branch name and a subfolder in this resource. Given that we are going to request Windmill to create one branch per script/flow/app, setting a custom branch will have no effect. However, if you wish to persist the Windmill workspace in a subfolder of your repository, you can set it here.
 2. In Windmill workspace settings > Git sync tab, pick the `git_repository` resource and toggle On "Create one branch per deployed script/flow/app"
 
-### GitHub actions setup
+### GitHub Actions setup
 
 Two actions are needed.
 
 1. The first one to automatically create a PR when Windmill commits a change after a user deployed a script/flow/app in the staging workspace. The workflow file is available in [the example repo](https://github.com/windmill-labs/windmill-sync-example/blob/main/.github/workflows/open-pr-on-commit.yaml). All branches created by Windmill will have a `wm_deploy/` prefix, which is handy to trigger this action only when a branch matching this pattern is created.
-1. The second one to automatically push the content of the repo to the Windmill production workspace when a PR is merged. The workflow file is available in [the example repo](https://github.com/windmill-labs/windmill-sync-example/blob/main/.github/workflows/push-on-merge.yaml). This action uses the [GitHub CLI](https://cli.github.com/) which is available by default on GitHub action workers.
+1. The second one to automatically push the content of the repo to the Windmill production workspace when a PR is merged. The workflow file is available in [the example repo](https://github.com/windmill-labs/windmill-sync-example/blob/main/.github/workflows/push-on-merge.yaml). This action uses the [GitHub CLI](https://cli.github.com/) which is available by default on GitHub Action workers.
diff --git a/docs/core_concepts/index.mdx b/docs/core_concepts/index.mdx
@@ -179,7 +179,7 @@ On top of its editors to build endpoints, flows and apps, Windmill comes with a
 		href="/docs/core_concepts/dedicated_workers"
 	/>
 	<DocCard
-		title="Sync Workspace to Remote Git Repository"
+		title="Git Sync"
 		description="Connect the Windmill workspace to a Git repository to automatically commit and push scripts, flows and apps to the repository on each deploy."
 		href="/docs/advanced/git_sync"
 	/>
diff --git a/docs/integrations/git_repository.mdx b/docs/integrations/git_repository.mdx
@@ -8,7 +8,7 @@ More:
 
 <div class="grid grid-cols-2 gap-6 mb-4">
 		<DocCard
-			title="Sync Workspace to Remote Git Repository"
+			title="Git Sync"
 			description="Connect the Windmill workspace to a Git repository to automatically commit and push scripts, flows and apps to the repository on each deploy."
 			href="/docs/advanced/git_sync"
 	/>
@@ -17,7 +17,7 @@ More:
 <iframe
 	style={{ aspectRatio: '16/9' }}
 	src="https://www.youtube.com/embed/JqG0KNYWLx0?vq=hd1080"
-	title="Sync Workspace to Remote Git Repository"
+	title="Git Sync"
 	frameBorder="0"
 	allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
 	allowFullScreen
diff --git a/docs/misc/7_plans_details/index.mdx b/docs/misc/7_plans_details/index.mdx
@@ -24,7 +24,7 @@ No commitment or credit card required.
 - Community support on [Discord](https://discord.com/invite/V7PM2YHsPB).
 - [Granular permissions](../../core_concepts/16_roles_and_permissions/index.mdx), [groups](../../core_concepts/8_groups_and_folders/index.mdx), [folders](../../core_concepts/8_groups_and_folders/index.mdx) and [public apps](../../apps/8_public_apps.md) available.
 - [Deployment from GitHub](../../advanced/9_deploy_gh_gl/index.md).
-- [Sync Workspace to Remote Git Repository](../../advanced/11_git_sync/index.mdx).
+- [Git Sync](../../advanced/11_git_sync/index.mdx).
 - [Concurrency Limits](../../core_concepts/21_concurrency_limits/index.md).
 - [Content Search](../../core_concepts/26_content_search/index.md).
 - [Global CSS on App Editor](../../apps/9_css_editor.mdx).
@@ -38,7 +38,7 @@ Designed for small teams automating processes.
 - Includes all Community edition features.
 - [Audit logs](../../core_concepts/14_audit_logs/index.mdx) with a 7-day retention period.
 - [Deployment from GitHub](../../advanced/9_deploy_gh_gl/index.md).
-- [Sync Workspace to Remote Git Repository](../../advanced/11_git_sync/index.mdx).
+- [Git Sync](../../advanced/11_git_sync/index.mdx).
 - [Concurrency Limits](../../core_concepts/21_concurrency_limits/index.md).
 - [Content Search](../../core_concepts/26_content_search/index.md).
 - [Global CSS on App Editor](../../apps/9_css_editor.mdx).
@@ -62,7 +62,7 @@ Dedicated support, guidance and infrastructure for advanced capabilities.
 - [Audit logs](../../core_concepts/14_audit_logs/index.mdx) with a 60-day retention period.
 - [Deploy to Staging/Prod Web UI](../../core_concepts/12_staging_prod/index.md).
 - [Deployment from GitHub](../../advanced/9_deploy_gh_gl/index.md).
-- [Sync Workspace to Remote Git Repository](../../advanced/11_git_sync/index.mdx).
+- [Git Sync](../../advanced/11_git_sync/index.mdx).
 - [Concurrency Limits](../../core_concepts/21_concurrency_limits/index.md).
 - [Content Search](../../core_concepts/26_content_search/index.md).
 - [Global CSS on App Editor](../../apps/9_css_editor.mdx).
@@ -101,7 +101,7 @@ Designed for small businesses, young startups, nonprofits & universities.
 - [Dedicated Workers / High Throughput](../../core_concepts/25_dedicated_workers/index.mdx).
 - [Worker Group Management UI](../11_worker_group_management_ui/index.mdx).
 - [Deploy to Staging/Prod Web UI](../../core_concepts/12_staging_prod/index.md).
-- [Sync Workspace to Remote Git Repository](../../advanced/11_git_sync/index.mdx).
+- [Git Sync](../../advanced/11_git_sync/index.mdx).
 - [Global CSS on App Editor](../../apps/9_css_editor.mdx).
 - [Concurrency Limits](../../core_concepts/21_concurrency_limits/index.md).
 - [Content Search](../../core_concepts/26_content_search/index.md).
@@ -124,7 +124,7 @@ Designed for companies requiring dedicated support, guidance and advanced infras
 - Prometheus Metrics.
 - [Dedicated Workers / High Throughput](../../core_concepts/25_dedicated_workers/index.mdx).
 - [Worker Group Management UI](../11_worker_group_management_ui/index.mdx).
-- [Sync Workspace to Remote Git Repository](../../advanced/11_git_sync/index.mdx).
+- [Git Sync](../../advanced/11_git_sync/index.mdx).
 - [Deploy to Staging/Prod Web UI](../../core_concepts/12_staging_prod/index.md).
 - [Global CSS on App Editor](../../apps/9_css_editor.mdx).
 - [Concurrency Limits](../../core_concepts/21_concurrency_limits/index.md).
diff --git a/docs/misc/9_guides/airplane/index.md b/docs/misc/9_guides/airplane/index.md
diff --git a/sidebars.js b/sidebars.js
