update doc

scaleway · Dec 20, 2024 · 3f7fb91 · 3f7fb91
1 parent ebcfe94
commit 3f7fb91
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git a/builder/scaleway/config.go b/builder/scaleway/config.go
@@ -99,6 +99,7 @@ type Config struct {
 	RemoveVolume bool `mapstructure:"remove_volume"`
 
 	// BlockVolumes define block volumes attached to the server alongside the default volume
+	// See the [BlockVolumes](#block-volumes-configuration) documentation for fields.
 	BlockVolumes []ConfigBlockVolume `mapstructure:"block_volume"`
 
 	// This value allows the user to remove information

diff --git a/docs-partials/builder/scaleway/Config-not-required.mdx b/docs-partials/builder/scaleway/Config-not-required.mdx
@@ -24,6 +24,7 @@
 - `remove_volume` (bool) - RemoveVolume remove the temporary volumes created before running the server
 
 - `block_volume` ([]ConfigBlockVolume) - BlockVolumes define block volumes attached to the server alongside the default volume
+  See the [BlockVolumes](#block-volumes-configuration) documentation for fields.
 
 - `cleanup_machine_related_data` (string) - This value allows the user to remove information
   that is particular to the instance used to build the image

diff --git a/docs/builders/scaleway.mdx b/docs/builders/scaleway.mdx
@@ -49,6 +49,10 @@ can also be supplied to override the typical auto-generated key:
 
 @include 'builder/scaleway/Config-not-required.mdx'
 
+### Block volumes configuration
+
+@include 'builder/scaleway/ConfigBlockVolume-not-required.mdx'
+
 ## Basic Example
 
 Here is a basic example. It is completely valid as soon as you enter your own