Adding articles & some minor changes (windmill-labs#109)

hcourdent · web-flow · commit f5fb44485d4b · 2023-03-07T22:19:03.000+01:00
diff --git a/docs/apps/4_app_component_library.md b/docs/apps/4_app_component_library.md
@@ -1,10 +1,10 @@
-# Component library
+# Components Library
 
-The app component library is located on the right-hand side of the app editor. It displays the app components and allows you to configure them.
+The app components library is located on the right-hand side of the app editor. It displays the app components and allows you to configure them.
 
-## Component properties
+## Components properties
 
-Component can be configured in three ways:
+Components can be configured in three ways:
 
 - **Inputs**: inputs can be connected to an output or computed using a runnable.
   - e.g. `Table` component has an input that can be connected to an output or computed using a runnable, which is an array of objects.
@@ -27,9 +27,12 @@ Component can be configured in three ways:
 
 Click on a component in the component library to insert it in the app canvas. It will be automatically positioned.
 
-## Component list
+## Components list
 
-Windmill provides a set of components that can be used to build apps. Here is the list of the available components (constantly growing according to our users' expectations):
+Windmill provides a set of components that can be used to build apps. The list of components is constantly growing according to our users' expectations. If you feel like a new component would be useful, please [reach out to us](https://docs.windmill.dev//docs/misc/getting_help/).
+
+
+Here is the list of the available components:
 
 - Button
 - Form
diff --git a/docs/getting_started/00_how_to_use_windmill/index.md b/docs/getting_started/00_how_to_use_windmill/index.md
@@ -0,0 +1,28 @@
+# How to Use Windmill
+
+Windmill is fully [open-source](https://github.com/windmill-labs/windmill). Therefore, we want it to be as easy to use as possible.
+
+## Self-host Windmill
+
+You can choose to self-host Windmill on your own servers.
+
+[Windmill's GitHub repository](https://github.com/windmill-labs/windmill) contains all the necessary files to
+run Windmill locally, or to self-host it.
+
+We encourage Docker-based deployments, and provide a `docker-compose` file to
+help you get started.
+
+For detailed information, follow the **[Self Host Windmil tutorial](https://www.windmill.dev/docs/advanced/self_host/)**.
+
+
+## Use Windmill Cloud
+
+
+Windmill provides a **[Cloud App](https://app.windmill.dev/user/login)** that everyone can use.
+
+You can sign-up using your GitHub, GitLab, Google, Microsoft or email. No Credit Cards required and we will spare your inbox.
+
+
+Any user will be provided with 1,000 monthly executions from our [Free plan](https://www.windmill.dev/pricing/) and added to the Demo workspace. From there, users can create workspaces for free and create scripts, workflows and UIs.
+
+And if you feel like it, [upgrade](https://docs.windmill.dev/docs/advanced/upgrade/) for unlimited executions.
diff --git a/docs/getting_started/0_scripts_quickstart/1_typescript_quickstart/index.md b/docs/getting_started/0_scripts_quickstart/1_typescript_quickstart/index.md
@@ -11,6 +11,8 @@ Windmill uses [Deno](https://deno.land/) as the TypeScript runtime.
 Scripts are the basic building blocks in Windmill. They can be run as standalone
 apps, chained together to create [Flows][flows].
 
+[Here](https://hub.windmill.dev/scripts/gmail/1291/-send-email-gmail) is a simple example of a script built in TypeScript with Windmill.
+
 In Windmill, Scripts consist of three parts:
 
 - **Metadata**: information about the Script such as its path, description, and
diff --git a/docs/getting_started/0_scripts_quickstart/2_python_quickstart/index.md b/docs/getting_started/0_scripts_quickstart/2_python_quickstart/index.md
@@ -11,6 +11,9 @@ provides a Python `3.11` environment.
 Scripts are the basic building blocks in Windmill. They can be run as standalone
 apps, chained together to create [Flows][flows].
 
+
+[Here](https://app.windmill.dev/scripts/get/636d928308d3b905?workspace_id=demo) is a simple example of a script built in Python with Windmill.
+
 In Windmill, Scripts consist of three parts:
 
 - **Metadata**: information about the Script such as its path, description, and
diff --git a/docs/getting_started/6_flows_quickstart/index.md b/docs/getting_started/6_flows_quickstart/index.md
@@ -2,6 +2,8 @@
 
 The present document will introduce you to flows and how to build your first one.
 
+[Here](https://hub.windmill.dev/flows/13/whenever-an-hackernews-message-contains-a-mention%2C-publish-it-to-slack-with-sentiment-analysed) is an example of a simple flow built with Windmill.
+
 It is important to have in mind that **scripts are at the basis of Windmill**. To sum up roughly, workflows are an architecture of scripts. You can have a look at the [Script Quickstart](https://docs.windmill.dev/docs/getting_started/scripts_quickstart/typescript) in the precedent section (in the programming language of your choice). But don't worry, you will not have to build each script by hand, as you can always use scripts from your workspace or from the [Hub](https://hub.windmill.dev/).
 
 
diff --git a/docs/getting_started/7_apps_quickstart/index.md b/docs/getting_started/7_apps_quickstart/index.md
@@ -6,6 +6,8 @@ Although Windmill provides **auto-generated UIs to scripts and flows**, you can
 
 Windmill applications are customized UIs to interact with datasources (web, internal, data providers, etc). They are a great way to have non-technical users interact with custom-made workflows.
 
+[Here](https://hub.windmill.dev/apps/3/crm) is an example of an app built with Windmill.
+
 In short, what you need to remember about apps:
 - they work on a **what-you-see-is-what-you-get basis**
 - you can connect apps and components to **datasources**
diff --git a/docs/intro.md b/docs/intro.md
@@ -24,13 +24,12 @@ restricted forms.
 
 Windmill is different:
 
-- it allows building **internal tools through code** much faster, without
-  sacrificing on one side visibility and intuitivity and on the other side,
-  control, reliability, performance, flexibility and scalability
-- it **empowers semi-technical users** to access and edit that code without
+- Windmill is an [open-source](https://github.com/windmill-labs/windmill) **developer platform and infra to build all internal tools through code**, such as UIs and workflows based on simple scripts (TypeScript, Python, Go, Bash). Without sacrificing on one side visibility and intuitivity and on the other side,
+  control, reliability, performance, flexibility and scalability.
+- It **empowers semi-technical users** to access and edit that code without
   being overwhelmed by the usual barriers to entry (git, IDE, local
-  environments, secrets managements, etc.)
-- it is compatible with senior/staff software engineers **high standards for
+  environments, secrets managements, etc).
+- It is compatible with senior/staff software engineers **high standards for
   production-grade** yet flexible yet customizable with code.
 
 Windmill embeds:
@@ -65,25 +64,25 @@ Windmill embeds:
     external webhook who may contain payloads
   - **approval steps** leveraging being suspended and reactivated at some secret
     urls known only by the approvers
-- a [low-code UI builder](./getting_started/7_apps_quickstart/index.md) to build
-  complex admin panels and dashboards using inline scripts in TypeScript,
+- a **[low-code UI builder](./getting_started/7_apps_quickstart/index.md)** to build
+  complex internal apps, admin panels and dashboards using inline scripts in TypeScript,
   Python, Go, Bash and SQL or trigger the Scripts and Flows of the workspace
 - an **enterprise-grade platform** with tight permissioning, secret management,
   groups and folders enabling
   [RBAC permissions](./reference/index.md#permissions-and-acl),
   [OAuth handling](./advanced/2_setup_oauth/index.md) for fetching and
   refreshing credentials
-- [webhooks](./core_concepts/4_webhooks/index.md) for every scripts and flows to
+- **[webhooks](./core_concepts/4_webhooks/index.md)** for every scripts and flows to
   be triggered externally and an open api to be easily embedded into your
   current infrastructure
-- a [scheduler](./core_concepts/5_schedules/index.md) to trigger Scripts and
+- a **[scheduler](./core_concepts/5_schedules/index.md)** to trigger Scripts and
   Flows. Combined with state storage, it can be used to watch for external
   events - for example triggering a Flow only if the external state is different
   from the one stored previously
-- a [CLI](./advanced/3_cli/index.md) and GitHub Actions for **GitHub** and local
+- a **[CLI](./advanced/3_cli/index.md)** and GitHub Actions for **GitHub** and local
   based developement and code management.
 
-On top of all these, you'll get a splendid community and a responsive support
+On top of all these, you'll get a splendid [community](https://discord.com/invite/V7PM2YHsPB) and a responsive support
 team to attend you in your journey.
 
 ### Use cases
@@ -138,5 +137,11 @@ with:
   scalability** and have **no open APIs**.
 
 You will find more details on our view over our space and competitors in the
-[Windmill compared to its peers page](https://docs.windmill.dev/docs/misc/windmill_compared_to_peers)
-page.
+[Windmill compared to its peers](https://docs.windmill.dev/docs/misc/windmill_compared_to_peers) page.
+
+:::info About
+**[Windmill](https://docs.windmill.dev/)** is an **[open-source](https://github.com/windmill-labs/windmill)** and **[self-hostable](https://docs.windmill.dev/docs/advanced/self_host/)** serverless runtime and platform combining the power of code with the velocity of low-code. We turn your scripts into internal apps and composable steps of flows that automate repetitive workflows.
+
+You can **[self-host](https://docs.windmill.dev/docs/advanced/self_host/#deployment)** Windmill using a docker compose up, our go with the **[cloud app](https://app.windmill.dev/user/login)**.
+
+:::
diff --git a/docs/misc/6_getting_help/index.md b/docs/misc/6_getting_help/index.md
@@ -0,0 +1,14 @@
+# Getting Help
+
+Getting stuck using Windmill? Your problem can be quickly solved and reporting it is the best way to contribute!
+
+First of all, you could join our **[Discord](https://discord.com/invite/V7PM2YHsPB)**, from where the team and even other contributors will be happy to give you a hand.
+
+Also, you might want to reach out by **email** at contact@windmill.dev.
+
+For more in-depth discussions, we are always available for a **[demo]** or **[meeting](https://cal.com/ruben-windmill/30min)**.
+
+
+<!-- Resources -->
+
+[demo]: https://cal.com/ruben-windmill/windmill-demo
diff --git a/docs/misc/7_windmill_compared_to_peers.md b/docs/misc/7_windmill_compared_to_peers.md
@@ -1,4 +1,4 @@
-# Windmill compared to its peers
+# Windmill Compared to its Peers
 
 We are aware other frameworks exist out there. Some of them might suit your specific needs. We believe Windmill is **the only solution to provide this comprehensive set of feature and to be fully open-source** at the same time.
 
diff --git a/sidebars.js b/sidebars.js
@@ -20,6 +20,7 @@ const sidebars = {
 			type: 'category',
 			label: 'Getting Started',
 			items: [
+				'getting_started/how_to_use_windmill/index',
 				{
 					type: 'category',
 					label: 'Scripts Quickstart',
@@ -34,7 +35,13 @@ const sidebars = {
 			type: 'category',
 			label: 'Core Concepts',
 			items: [{ type: 'autogenerated', dirName: 'core_concepts' }],
-			collapsed: false
+			collapsed: true
+		},
+		{
+			type: 'category',
+			label: 'Advanced',
+			items: [{ type: 'autogenerated', dirName: 'advanced' }],
+			collapsed: true
 		},
 		{
 			type: 'category',
@@ -48,12 +55,6 @@ const sidebars = {
 			items: [{ type: 'autogenerated', dirName: 'flows' }],
 			collapsed: true
 		},
-		{
-			type: 'category',
-			label: 'Advanced',
-			items: [{ type: 'autogenerated', dirName: 'advanced' }],
-			collapsed: false
-		},
 		'openflow/index',
 		'reference/index',
 		{
diff --git a/src/theme/BlogPostItem/Content/index.js b/src/theme/BlogPostItem/Content/index.js
@@ -29,6 +29,10 @@ export default function BlogPostItemContent({children, className}) {
 						runtime and platform combining the power of code with the velocity 
 						of low-code. We turn your scripts into internal apps and composable
 						steps of flows that automate repetitive workflows.
+						<br/><br/>
+						
+						You can <a href='https://docs.windmill.dev/docs/advanced/self_host/#deployment'>self-host</a> Windmill using a docker compose up, our go with the <a href='https://app.windmill.dev/user/login'>cloud app</a>.
+
 					</div>
 				</div>
 			}

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# Windmill compared to its peers`
	`1`	`+# Windmill Compared to its Peers`
`2`	`2`
`3`	`3`	`We are aware other frameworks exist out there. Some of them might suit your specific needs. We believe Windmill is the only solution to provide this comprehensive set of feature and to be fully open-source at the same time.`
`4`	`4`