improve s3 docs

rubenfiszel · rubenfiszel · commit 87af2eaa694a · 2024-03-09T14:56:27.000+01:00
diff --git a/docs/core_concepts/11_persistent_storage/large_data_files.mdx b/docs/core_concepts/11_persistent_storage/large_data_files.mdx
@@ -23,11 +23,11 @@ S3 files in Windmill are just pointers to the S3 object using its key. As such,
 
 ```json
 {
-	"s3": "/s3/object/file/key"
+	"s3": "path/to/file"
 }
 ```
 
-![S3 Integration Infographic](./s3_infographics.png "S3 Integration Infographic")
+![S3 Integration Infographic](./s3_infographics.png 'S3 Integration Infographic')
 
 The resource can be set to be public with toggle "S3 resource details can be accessed by all users of this workspace".
 
@@ -364,4 +364,4 @@ Then from Windmill, just [fill the S3 resource type](../../integrations/s3.mdx).
 
 3. [Create a container](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-quickstart-blobs-portal). Azure's containers are roughly the equivalent to S3 buckets. Note though that secret access key are per account, not per container.
 
-4. [Integrate it to Windmill](../../integrations/microsoft-azure-blob.md) by filling the [resource type details](https://hub.windmill.dev/resource_types/137) for Azure Blob APIs.
+4. [Integrate it to Windmill](../../integrations/microsoft-azure-blob.md) by filling the [resource type details](https://hub.windmill.dev/resource_types/137) for Azure Blob APIs.
diff --git a/docs/core_concepts/18_files_binary_data/index.mdx b/docs/core_concepts/18_files_binary_data/index.mdx
@@ -26,7 +26,7 @@ S3 files in Windmill are just pointers to the S3 object using its key. As such,
 
 ```json
 {
-	"s3": "/s3/object/file/key"
+	"s3": "path/to/file"
 }
 ```
 
diff --git a/docs/core_concepts/27_data_pipelines/index.mdx b/docs/core_concepts/27_data_pipelines/index.mdx
@@ -62,7 +62,7 @@ S3 files in Windmill are just pointers to the S3 object using its key. As such,
 
 ```json
 {
-	"s3": "/s3/object/file/key"
+	"s3": "path/to/file"
 }
 ```
 
@@ -334,7 +334,6 @@ Polars and DuckDB need to be configured to access S3 within the Windmill script.
 
 :::
 
-
 ### Canonical data pipeline in Windmill w/ Polars and DuckDB
 
 With S3 as the external store, a transformation script in a flow will typically perform:

Original file line number	Diff line number	Diff line change
`@@ -23,11 +23,11 @@ S3 files in Windmill are just pointers to the S3 object using its key. As such,`
`23`	`23`
`24`	`24`	```json
`25`	`25`	`{`
`26`		`- "s3": "/s3/object/file/key"`
	`26`	`+ "s3": "path/to/file"`
`27`	`27`	`}`
`28`	`28`	```
`29`	`29`
`30`		`-![S3 Integration Infographic](./s3_infographics.png "S3 Integration Infographic")`
	`30`	`+![S3 Integration Infographic](./s3_infographics.png 'S3 Integration Infographic')`
`31`	`31`
`32`	`32`	`The resource can be set to be public with toggle "S3 resource details can be accessed by all users of this workspace".`
`33`	`33`
`@@ -364,4 +364,4 @@ Then from Windmill, just [fill the S3 resource type](../../integrations/s3.mdx).`
`364`	`364`
`365`	`365`	`3. [Create a container](https://learn.microsoft.com/en-us/azure/storage/blobs/storage-quickstart-blobs-portal). Azure's containers are roughly the equivalent to S3 buckets. Note though that secret access key are per account, not per container.`
`366`	`366`
`367`		`-4. [Integrate it to Windmill](../../integrations/microsoft-azure-blob.md) by filling the [resource type details](https://hub.windmill.dev/resource_types/137) for Azure Blob APIs.`
	`367`	`+4. [Integrate it to Windmill](../../integrations/microsoft-azure-blob.md) by filling the [resource type details](https://hub.windmill.dev/resource_types/137) for Azure Blob APIs.`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ S3 files in Windmill are just pointers to the S3 object using its key. As such,`
`26`	`26`
`27`	`27`	```json
`28`	`28`	`{`
`29`		`- "s3": "/s3/object/file/key"`
	`29`	`+ "s3": "path/to/file"`
`30`	`30`	`}`
`31`	`31`	```
`32`	`32`
Original file line number	Diff line number	Diff line change
`@@ -62,7 +62,7 @@ S3 files in Windmill are just pointers to the S3 object using its key. As such,`
`62`	`62`
`63`	`63`	```json
`64`	`64`	`{`
`65`		`- "s3": "/s3/object/file/key"`
	`65`	`+ "s3": "path/to/file"`
`66`	`66`	`}`
`67`	`67`	```
`68`	`68`
`@@ -334,7 +334,6 @@ Polars and DuckDB need to be configured to access S3 within the Windmill script.`
`334`	`334`
`335`	`335`	`:::`
`336`	`336`
`337`		`-`
`338`	`337`	`### Canonical data pipeline in Windmill w/ Polars and DuckDB`
`339`	`338`
`340`	`339`	`With S3 as the external store, a transformation script in a flow will typically perform:`