feat: add version to module docs (#122)

This commit is contained in:
Muhammad Atif Ali
2024-01-23 13:50:55 +03:00
committed by GitHub
parent 5b3edd9bbd
commit b968a2aa22
26 changed files with 271 additions and 207 deletions

View File

@@ -13,12 +13,13 @@ This module adds Google Cloud Platform regions to your Coder template.
```hcl
module "gcp_region" {
source = "https://registry.coder.com/modules/gcp-region"
regions = ["us", "europe"]
source = "registry.coder.com/modules/gcp-region/coder"
version = "1.0.0"
regions = ["us", "europe"]
}
resource "google_compute_instance" "example" {
zone = module.gcp_region.value
zone = module.gcp_region.value
}
```
@@ -32,14 +33,15 @@ Note: setting `gpu_only = true` and using a default region without GPU support,
```hcl
module "gcp_region" {
source = "https://registry.coder.com/modules/gcp-region"
default = ["us-west1-a"]
regions = ["us-west1"]
gpu_only = false
source = "registry.coder.com/modules/gcp-region/coder"
version = "1.0.0"
default = ["us-west1-a"]
regions = ["us-west1"]
gpu_only = false
}
resource "google_compute_instance" "example" {
zone = module.gcp_region.value
zone = module.gcp_region.value
}
```
@@ -47,13 +49,14 @@ resource "google_compute_instance" "example" {
```hcl
module "gcp_region" {
source = "https://registry.coder.com/modules/gcp-region"
regions = ["europe-west"]
single_zone_per_region = false
source = "registry.coder.com/modules/gcp-region/coder"
version = "1.0.0"
regions = ["europe-west"]
single_zone_per_region = false
}
resource "google_compute_instance" "example" {
zone = module.gcp_region.value
zone = module.gcp_region.value
}
```
@@ -61,13 +64,14 @@ resource "google_compute_instance" "example" {
```hcl
module "gcp_region" {
source = "https://registry.coder.com/modules/gcp-region"
regions = ["us", "europe"]
gpu_only = true
single_zone_per_region = true
source = "registry.coder.com/modules/gcp-region/coder"
version = "1.0.0"
regions = ["us", "europe"]
gpu_only = true
single_zone_per_region = true
}
resource "google_compute_instance" "example" {
zone = module.gcp_region.value
zone = module.gcp_region.value
}
```