Skip to content

Commit 3bc2d7f

Browse files
hcourdenthcourdent
authored
Re-work on integration section landing + Added some integrations (windmill-labs#282)
1 parent 38d8108 commit 3bc2d7f

File tree

22 files changed

+262
-86
lines changed

22 files changed

+262
-86
lines changed

‎docs/advanced/9_deploy_gh_gl/index.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
# Version control from GitHub / GitLab
1+
# GitHub / GitLab for Version Control
22

3-
At https://github.com/windmill-labs/windmill-sync-example you'll find an example repo that demonstrate how to use a github repo as source of truth for part or all of your Windmill workspace.
3+
Learn how to integrate GitHub / GitLab repositories with your Windmill workspace for effective version control.
44

5-
Users of this repo can commit changes to the main branches and have it deployed to their Windmill workspace thanks to a github action that will simply use the [windmill CLI's](https://github.com/windmill-labs/windmill/tree/main/cli) `wmill sync push` under the hood.
5+
Check out the [windmill-sync-example repository](https://github.com/windmill-labs/windmill-sync-example) as an illustrative guide on utilizing GitHub / GitLab repositories as the version control source for your Windmill workspace.
66

7-
This repo is used to sync with the example folder in the demo workspace
7+
Users of this repo can commit changes to the main branches and have it deployed to their Windmill workspace thanks to a GitHub / GitLab action that will simply use the [Windmill CLI's](https://github.com/windmill-labs/windmill/tree/main/cli) `wmill sync push` under the hood.
8+
9+
This repo is used to sync with the example folder in the demo workspace.
810

911
## Setup
1012

‎docs/assets/integrations/add-nextcloud.png

455 KB
Loading

‎docs/core_concepts/11_persistent_storage/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -249,7 +249,7 @@ You can find examples and premade S3 scripts on [Windmill Hub](https://hub.windm
249249

250250
2. [Create a bucket](https://developers.cloudflare.com/r2/get-started/) on R2.
251251

252-
3. [Integrate it to Windmill](../../integrations/cloudlare-r2.md) by filling the [resource type details](https://hub.windmill.dev/resource_types/42) for S3 APIs.
252+
3. [Integrate it to Windmill](../../integrations/cloudflare-r2.md) by filling the [resource type details](https://hub.windmill.dev/resource_types/42) for S3 APIs.
253253

254254
### MinIO
255255

‎docs/integrations/0_integrations_on_windmill.mdx

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import DocCard from '@site/src/components/DocCard';
22

3-
# Creating integrations on Windmill
3+
# Creating Integrations on Windmill
44

55
Integrations are key on Windmill as they allow databases (internal & external) and service providers to interact.
66

@@ -56,8 +56,8 @@ On [self-hosted instances](../advanced/1_self_host/index.md), integrating OAuth
5656
| [Google Drive (gdrive)](./gdrive.md) | Cloud-based storage platform |
5757
| [Gmail](./gmail.md) | Free email service provided by Google |
5858
| [Google Sheets (gsheets)](./gsheets.md) | Online spreadsheet application |
59-
| [GitHub](./github.md) | Web-based platform for version control and collaboration |
60-
| [GitLab](./gitlab.md) | Web-based Git-repository manager with CI/CD capabilities |
59+
| [GitHub](./github.mdx) | Web-based platform for version control and collaboration |
60+
| [GitLab](./gitlab.mdx) | Web-based Git-repository manager with CI/CD capabilities |
6161
| [LinkedIn](./linkedin.md) | Professional networking and career development platform |
6262
| [Slack](./slack.mdx) | Instant messaging and collaboration platform |
6363

@@ -71,7 +71,7 @@ On [self-hosted instances](../advanced/1_self_host/index.md), integrating OAuth
7171
| [Amazon S3](./aws-s3.md) | Cloud storage service |
7272
| [BigQuery](./bigquery.mdx) | Cloud-based data warehousing platform |
7373
| [Clickhouse](./clickhouse.md) | Open-source column-oriented database management system |
74-
| [Cloudlare R2](./cloudlare-r2.md) | Cloud object storage service for data-intensive applications |
74+
| [Cloudlare R2](./cloudflare-r2.md) | Cloud object storage service for data-intensive applications |
7575
| [Datadog](./datadog.md) | Monitoring and analytics platform for cloud-scale infrastructure and applications |
7676
| [Discord](./discord.md) | Voice, video, and text communication platform for gamers |
7777
| [FaunaDB](./faunadb.md) | Serverless, document-oriented database for modern applications |
@@ -86,6 +86,7 @@ On [self-hosted instances](../advanced/1_self_host/index.md), integrating OAuth
8686
| [MongoDB](./mongodb.md) | NoSQL document-oriented database |
8787
| [MySQL](./mysql.md) | Open-source relational database management system |
8888
| [Neon.tech](./neon.md) | Open-source database management system |
89+
| [Nextcloud](./nextcloud.md) | Suite of client-server software for creating and using file hosting services |
8990
| [OpenAI](./openai.md) | Research laboratory consisting of the for-profit OpenAI LP and the non-profit OpenAI Inc |
9091
| [PostgreSQL](./postgresql.md) | Open-source object-relational database management system |
9192
| [Redis](./redis.md) | In-memory data structure store used as a database, cache, and message broker |

‎docs/integrations/cloudlare-r2.md renamed to ‎docs/integrations/cloudflare-r2.md

File renamed without changes.

‎docs/integrations/github.md renamed to ‎docs/integrations/github.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import DocCard from '@site/src/components/DocCard';
2+
13
# GitHub Integration
24

35
<video
@@ -15,6 +17,16 @@ The [GitHub](https://github.com/) integration is done through OAuth. You just ne
1517

1618
On [self-hosted instances](../advanced/1_self_host/index.md), integrating an OAuth API will require [Setup OAuth and SSO](../misc/2_setup_oauth/index.md).
1719

20+
You might also look for how to [version control from GitHub / GitLab](../advanced/9_deploy_gh_gl/index.md).
21+
22+
<div class="grid grid-cols-2 gap-6 mb-4">
23+
<DocCard
24+
title="GitHub / GitLab for Version Control"
25+
description="Learn how to integrate GitHub / GitLab repositories with your Windmill workspace for effective version control."
26+
href="/docs/advanced/deploy_gh_gl"
27+
/>
28+
</div>
29+
1830
:::tip
1931

2032
Find some pre-set interactions with Github on the [Hub](https://hub.windmill.dev/integrations/github).

‎docs/integrations/gitlab.md renamed to ‎docs/integrations/gitlab.mdx

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,21 @@
1+
import DocCard from '@site/src/components/DocCard';
2+
13
# GitLab Integration
24

35
The [GitLab](https://about.gitlab.com/) integration is done through OAuth. You just need to sign in from your GitLab account on your browser. The access will be automatically saved to the workspace as a [resource](../core_concepts/3_resources_and_types/index.mdx).
46

57
On [self-hosted instances](../advanced/1_self_host/index.md), integrating an OAuth API will require [Setup OAuth and SSO](../misc/2_setup_oauth/index.md).
68

7-
![Add Gitlab Resource](../assets/integrations/add-gitlab.png.webp)
9+
![Add GitLab Resource](../assets/integrations/add-gitlab.png.webp)
10+
11+
<div class="grid grid-cols-2 gap-6 mb-4">
12+
<DocCard
13+
title="GitHub / GitLab for Version Control"
14+
description="Learn how to integrate GitHub / GitLab repositories with your Windmill workspace for effective version control."
15+
href="/docs/advanced/deploy_gh_gl"
16+
/>
17+
</div>
18+
819

920
:::tip
1021

‎docs/integrations/nextcloud.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Nextcloud Integration
2+
3+
To integrate [Nextcloud](https://nextcloud.com/) to Windmill, you need to save the following elements as a [resource](../core_concepts/3_resources_and_types/index.mdx).
4+
5+
![Add Nextcloud Resource](../assets/integrations/add-nextcloud.png)
6+
7+
| Property | Type | Description | Default | Required | Where to Find |
8+
| -------- | ------ | ----------------------------------------------------------- | ------- | -------- | ------------------------------------------------------- |
9+
| username | string | The username for accessing the Nextcloud instance | | true | Your Nextcloud account credentials |
10+
| password | string | The password associated with the provided username | | true | Your Nextcloud account credentials |
11+
| baseUrl | string | The base URL of the Nextcloud instance (e.g., "https://nextcloud.example.com") | | true | Found in the address bar of your Nextcloud instance |
12+
<br/><br/>
13+
14+
:::tip
15+
16+
Find some pre-set interactions with Nextcloud on the [Hub](https://hub.windmill.dev/integrations/nextcloud).
17+
18+
Feel free to create your own Nextcloud scripts on [Windmill](../getting_started/00_how_to_use_windmill/index.mdx).
19+
20+
:::

‎docs/integrations/s3.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Here are the required details:
1818

1919
<br/>
2020

21-
For guidelines on where to find such details on a given platform, please go to the [AWS S3](./aws-s3.md) or [Cloudflare R2](./cloudlare-r2.md) pages.
21+
For guidelines on where to find such details on a given platform, please go to the [AWS S3](./aws-s3.md) or [Cloudflare R2](./cloudflare-r2.md) pages.
2222

2323
<br/>
2424

‎sidebars.js

Lines changed: 38 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -70,36 +70,6 @@ const sidebars = {
7070
'getting_started/trigger_flows/index'
7171
]
7272
},
73-
{
74-
type: 'category',
75-
label: 'Core Concepts',
76-
77-
items: [
78-
'core_concepts/auto_generated_uis/index',
79-
'core_concepts/json_schema_and_parsing/index',
80-
'advanced/imports/index',
81-
'core_concepts/instant_preview/index',
82-
'core_concepts/roles_and_permissions/index',
83-
'core_concepts/authentification/index',
84-
'core_concepts/error_handling/index',
85-
'core_concepts/collaboration/index',
86-
'core_concepts/scheduling/index',
87-
'core_concepts/monitor_past_and_future_runs/index',
88-
'core_concepts/webhooks/index',
89-
'core_concepts/variables_and_secrets/index',
90-
'core_concepts/resources_and_types/index',
91-
'core_concepts/groups_and_folders/index',
92-
'core_concepts/worker_groups/index',
93-
'core_concepts/jobs/index',
94-
'core_concepts/concurrency_limits/index',
95-
'core_concepts/draft_and_deploy/index',
96-
'core_concepts/files_binary_data/index',
97-
'core_concepts/rich_display_rendering/index',
98-
'core_concepts/persistent_storage/index',
99-
'core_concepts/ai_generation/index',
100-
],
101-
collapsed: false
102-
},
10373
{
10474
type: 'category',
10575
label: 'Editors Manual',
@@ -202,6 +172,36 @@ const sidebars = {
202172
}
203173
]
204174
},
175+
{
176+
type: 'category',
177+
label: 'Core Concepts',
178+
179+
items: [
180+
'core_concepts/auto_generated_uis/index',
181+
'core_concepts/json_schema_and_parsing/index',
182+
'advanced/imports/index',
183+
'core_concepts/instant_preview/index',
184+
'core_concepts/roles_and_permissions/index',
185+
'core_concepts/authentification/index',
186+
'core_concepts/error_handling/index',
187+
'core_concepts/collaboration/index',
188+
'core_concepts/scheduling/index',
189+
'core_concepts/monitor_past_and_future_runs/index',
190+
'core_concepts/webhooks/index',
191+
'core_concepts/variables_and_secrets/index',
192+
'core_concepts/resources_and_types/index',
193+
'core_concepts/groups_and_folders/index',
194+
'core_concepts/worker_groups/index',
195+
'core_concepts/jobs/index',
196+
'core_concepts/concurrency_limits/index',
197+
'core_concepts/draft_and_deploy/index',
198+
'core_concepts/files_binary_data/index',
199+
'core_concepts/rich_display_rendering/index',
200+
'core_concepts/persistent_storage/index',
201+
'core_concepts/ai_generation/index',
202+
],
203+
collapsed: false
204+
},
205205
{
206206
type: 'category',
207207
label: 'Developer',
@@ -272,7 +272,7 @@ const sidebars = {
272272
'integrations/integrations_on_windmill',
273273
{
274274
type: 'category',
275-
label: 'List of integrations',
275+
label: 'List of Integrations',
276276
items: [
277277
{
278278
type: 'doc',
@@ -311,8 +311,8 @@ const sidebars = {
311311
},
312312
{
313313
type: 'doc',
314-
id: 'integrations/cloudlare-r2',
315-
label: 'Cloudlare R2'
314+
id: 'integrations/cloudflare-r2',
315+
label: 'Cloudflare R2'
316316
},
317317
{
318318
type: 'doc',
@@ -419,6 +419,11 @@ const sidebars = {
419419
id: 'integrations/neon',
420420
label: 'Neon.tech'
421421
},
422+
{
423+
type: 'doc',
424+
id: 'integrations/nextcloud',
425+
label: 'Nextcloud'
426+
},
422427
{
423428
type: 'doc',
424429
id: 'integrations/openai',

0 commit comments

Comments
 (0)