Deploy to prod using a git workflow video & clarifications (windmill-labs#466)

hcourdent · web-flow · commit 57587e570012 · 2024-01-12T15:56:17.000+01:00
* Deploy to prod using a git workflow video &amp; clarifications

* Updated video &amp; forms for approvals
diff --git a/docs/advanced/11_git_sync/index.mdx b/docs/advanced/11_git_sync/index.mdx
@@ -10,10 +10,12 @@ For all details on Version Control in Windmill, see [Version Control](../../adva
 
 :::
 
+The first 5 minutes of this video show how to set up a Git repository for a workspace, the rest of the video shows how to use it to deploy to a Prod workspace using GitHub Actions:
+
 <iframe
 	style={{ aspectRatio: '16/9' }}
-	src="https://www.youtube.com/embed/JqG0KNYWLx0?vq=hd1080"
-	title="Git Sync"
+	src="https://www.youtube.com/embed/es8FUC2M73o?vq=hd1080"
+	title="Deploy to a Prod Workspace using a Git Workflow"
 	frameBorder="0"
 	allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
 	allowFullScreen
@@ -48,11 +50,18 @@ Run the following commands from the git repo folder to push the initial workspac
 
 This feature is [Cloud & Enterprise Self-Hosted](../../misc/7_plans_details/index.mdx) only.
 
-<div class="text-xl mb-2 font-semibold"></div>
+## Deploy to Prod using a Git Workflow
+
+This feature can be used alongside GiHub Actions to adopt a robust development process for your Windmill scripts, flows and apps,
+with for example a Staging Workspace making automatically PRs on a repo that pushes to a Prod workspace upon merge.
+
+More details at:
+
+
 <div class="grid grid-cols-2 gap-6 mb-4">
 	<DocCard
-		title="Command-Line Interface"
-		description="Interact with Windmill instances right from your terminal."
-		href="/docs/advanced/cli"
+		title="Deploy to Prod using a Git Workflow"
+		description="Windmill integration with Git repositories makes it possible to adopt a robust development process for your Windmill scripts, flows and apps."
+		href="/docs/advanced/deploy_gh_gl"
 	/>
 </div>
diff --git a/docs/advanced/13_version_control/index.mdx b/docs/advanced/13_version_control/index.mdx
@@ -8,10 +8,12 @@ Manage changes to scripts workflows, apps and resources using commits & push on
 
 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).
 
+The first 5 minutes of this video show how to set up a Git repository for a workspace, the rest of the video shows how to use it to deploy to a Prod workspace using GitHub Actions:
+
 <iframe
 	style={{ aspectRatio: '16/9' }}
-	src="https://www.youtube.com/embed/JqG0KNYWLx0?vq=hd1080"
-	title="Git Sync"
+	src="https://www.youtube.com/embed/es8FUC2M73o?vq=hd1080"
+	title="Deploy to a Prod Workspace using a Git Workflow"
 	frameBorder="0"
 	allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
 	allowFullScreen
diff --git a/docs/advanced/3_cli/workspace-management.md b/docs/advanced/3_cli/workspace-management.md
@@ -133,7 +133,7 @@ Example here just using `windmill -h`:
 
 :::
 
-## Whoami
+## whoami
 
 The wmill workspace whoami command allows you to display the currently active user and the active workspace.
 
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.
 
@@ -16,22 +16,31 @@ The process is as follows:
 
 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
-
-Windmill workspace sync to a Git repository is a [Cloud and Self-Hosted Enterprise Edition](/pricing)-only feature.
-
-:::
 
 :::tip
 
 Check out the [windmill-sync-example repository](https://github.com/windmill-labs/windmill-sync-example) as an illustration of this process.
 
 :::
 
+## Git Sync
+
+Deploying to a prod workspace using git requires the [Git Sync](../11_git_sync/index.mdx) feature, which is is a [Cloud and Self-Hosted Enterprise Edition](/pricing)-only feature.
+
 ## Setup
 
 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/).
 
+<iframe
+	style={{ aspectRatio: '16/9' }}
+	src="https://www.youtube.com/embed/es8FUC2M73o?vq=hd1080"
+	title="Deploy to a Prod Workspace using a Git Workflow"
+	frameBorder="0"
+	allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
+	allowFullScreen
+	className="border-2 rounded-xl object-cover w-full dark:border-gray-800"
+></iframe>
+
 ### GitHub repository setup
 
 First, the GitHub repo needs to be set up and Windmill needs to be able to commit to it. 
diff --git a/docs/core_concepts/3_resources_and_types/index.mdx b/docs/core_concepts/3_resources_and_types/index.mdx
@@ -74,9 +74,8 @@ a link, for example:
 
 ## Create a Resource Type
 
-Windmill comes preloaded with some common Resource Types, such as databases, apps, SMTP, etc. You can see the full list on [Windmill Hub](https://hub.windmill.dev/resources). You
-can also add custom Resource Types by clicking "Add a resource type" on the
-[Resources](https://app.windmill.dev/resources) page.
+Windmill comes preloaded with some common Resource Types, such as databases, apps, SMTP, etc. You can see the full list on [Windmill Hub](https://hub.windmill.dev/resources).
+You can also add custom Resource Types by clicking "Add a resource type" on the [Resources](https://app.windmill.dev/resources) page.
 
 ![Create resource type](./add_resource_type.png.webp)
 
@@ -86,6 +85,16 @@ default, etc). You can also view the schema by toggling the "As JSON" option:
 
 ![Resource type schema view](./resource_type_json.png.webp)
 
+### Share Resource Type on Hub
+
+You can contribute to the [Windmill Hub](https://hub.windmill.dev/) by sharing your Resource Type. To do so, add a Resource Type on the [Resources section](https://hub.windmill.dev/resources) of the Hub.
+
+You will be asked to fill Name, Integration (the corresponding service it interacts with) and Schema (the JSON Schema of the Resource Type).
+
+Verified Resource Types on the Hub are directly added to the list of available Resource Types on each new Windmill instance synced with the Hub.
+
+![Share resource type](./new_resource_type_hub.png)
+
 ## States
 
 States are used by scripts to keep data persistent between runs of the same script by the same trigger (schedule or user).
diff --git a/docs/core_concepts/3_resources_and_types/new_resource_type_hub.png b/docs/core_concepts/3_resources_and_types/new_resource_type_hub.png
diff --git a/docs/flows/11_flow_approval.mdx b/docs/flows/11_flow_approval.mdx
@@ -71,6 +71,8 @@ Note that approval steps can be applied the same configurations as regular steps
 
 You can add an arbitrary schema form to be provided and displayed on the approval page. Users opening the approval page would then be offered to fill arguments you can use in the flow.
 
+Adding a form to an approval step is a [Cloud & Enterprise Self-Hosted](/pricing) only feature.
+
 <video
     className="border-2 rounded-xl object-cover w-full h-full"
     controls
@@ -95,6 +97,31 @@ You can use the arguments values [connecting](./16_architecture.mdx#input-transf
 
 This is a way to introduce human-in-the-loop workflows and condition branches on approval steps inputs.
 
+### How to add dynamic default args & enums?
+
+On your form, you can dynamically set the default arguments and enums with the logic of the approval script.
+Which means they can depend on previous results/API.
+
+As one of the return key of this step, return an object `default_args` that contains the default arguments of the form arguments. e.g:
+
+```
+return {
+	endpoints,
+	default_args: {
+		foo: "foo",
+		bar: true,
+	},
+}
+
+For enums, use `enums`, e.g:
+return {
+	endpoints,
+	enums: {
+		foo: ["choice1", "choice2"]
+	},
+}
+```
+
 ## Tutorial: A Slack Approval Step Conditioning Flow Branches
 
 The answer to the arguments of an approval page can be used as an input to condition branches in human-in-the-loop workflows.
diff --git a/docs/integrations/0_integrations_on_windmill.mdx b/docs/integrations/0_integrations_on_windmill.mdx
@@ -42,7 +42,13 @@ Interacting with an integration means using a resource, see the dedicated doc pa
 
 You can [create a resource type](../core_concepts/3_resources_and_types/index.mdx#create-a-resource-type). Use the "Add Property" button to add a field to the resource type. You can specify constraints for the field (a type, making it mandatory, specifying a default, etc). You can also view the schema by toggling the "As JSON" option.
 
-Once you're comfortable with the new integration, we would be super grateful if you could [share it on hub](/docs/misc/share_on_hub).
+Once you're comfortable with the new integration, we would be super grateful if you could [share it on Hub](../misc/1_share_on_hub/index.md).
+
+You will be asked to fill Name, Integration (the corresponding service it interacts with) and Schema (the JSON Schema of the Resource Type).
+
+Verified Resource Types on the Hub are directly added to the list of available Resource Types on each new Windmill instance synced with the Hub.
+
+![Share resource type](../core_concepts/3_resources_and_types//new_resource_type_hub.png)
 
 <div class="grid grid-cols-2 gap-6 mb-4">
     <DocCard
diff --git a/docs/integrations/git_repository.mdx b/docs/integrations/git_repository.mdx
@@ -14,10 +14,12 @@ More:
 	/>
 </div>
 
+The first 5 minutes of this video show how to set up a Git repository for a workspace, the rest of the video shows how to use it to deploy to a Prod workspace using GitHub Actions:
+
 <iframe
 	style={{ aspectRatio: '16/9' }}
-	src="https://www.youtube.com/embed/JqG0KNYWLx0?vq=hd1080"
-	title="Git Sync"
+	src="https://www.youtube.com/embed/es8FUC2M73o?vq=hd1080"
+	title="Deploy to a Prod Workspace using a Git Workflow"
 	frameBorder="0"
 	allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
 	allowFullScreen
diff --git a/docs/misc/9_guides/airplane/index.md b/docs/misc/9_guides/airplane/index.md
@@ -6,6 +6,8 @@ The migration from Airplane to Windmill is made easy by the same developer-first
 
 Windmill offers 3 months of [Enterprise Edtion](/pricing) to Airplane users. To get started, contact us at [ruben@windmill.dev](mailto:ruben@windmill.dev).
 
+The migration from Airplane is included in the Enterprise Edition. Upon subscription, we can organize a migration session from Airplane to Windmill. We can also recreate your scripts, flows, and applications from exports and screenshots of Airplane, in collaboration with you if your instance is self-hosted. If you are interested, contact us at [ruben@windmill.dev](mailto:ruben@windmill.dev).
+
 The following section covers the main concepts of Windmill, starting from those of Airplane. To see all the Core Concepts of Windmill, see:
 
 <div class="grid grid-cols-2 gap-6 mb-4">
@@ -126,10 +128,12 @@ Manage changes to scripts workflows, apps and resources using commits & push on
 
 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).
 
+The first 5 minutes of this video show how to set up a Git repository for a workspace, the rest of the video shows how to use it to deploy to a Prod workspace using GitHub Actions:
+
 <iframe
 	style={{ aspectRatio: '16/9' }}
-	src="https://www.youtube.com/embed/JqG0KNYWLx0?vq=hd1080"
-	title="Git Sync"
+	src="https://www.youtube.com/embed/es8FUC2M73o?vq=hd1080"
+	title="Deploy to a Prod Workspace using a Git Workflow"
 	frameBorder="0"
 	allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
 	allowFullScreen
diff --git a/sidebars.js b/sidebars.js
@@ -356,8 +356,8 @@ const sidebars = {
 						id: 'advanced/deploy_to_prod/index'
 					},
 					items: [
-						'core_concepts/staging_prod/index',
-						'advanced/deploy_gh_gl/index'
+						'advanced/deploy_gh_gl/index',
+						'core_concepts/staging_prod/index'
 					]
 				},
 				'advanced/preinstall_binaries/index',
