Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): Improve documentations to warn about new domains, and explain how to import them. #25

Merged
merged 1 commit into from
May 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
## Purpose

This repository is used to manage a domain on scaleway using terraform.
Beware this module *can not* be used to register a new domain. Existing domains must first be imported manually after initializing the terraform project. Refer to examples for more informations.

## Usage

Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,14 @@
# Simple domain
# Existing domain

This example shows how to manage a single domain named `example.net`.
This example shows how to import an existing domain named `example.net` in order to manage it.

## Usage

To run this example you need to execute:

```bash
$ terraform init
$ terraform import domain.scaleway_domain_zone.this example.net
$ terraform plan
$ terraform apply
```
Expand Down
File renamed without changes.
File renamed without changes.
3 changes: 1 addition & 2 deletions examples/with-subdomain/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Manage a subdomain

This example shows how to manage the domain `exemple.net` along with a subdomain named `contact`.
This example shows how to manage the domain `contact.example.net`.

## Usage

Expand Down Expand Up @@ -32,7 +32,6 @@ Note that this example won't work as the domain name has been reserved by IANA f

| Name | Source | Version |
|------|--------|---------|
| <a name="module_root"></a> [root](#module_root) | ../../ | n/a |
| <a name="module_subdomain"></a> [subdomain](#module_subdomain) | ../../ | n/a |

## Resources
Expand Down
7 changes: 0 additions & 7 deletions examples/with-subdomain/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,6 @@ locals {
subdomain = "contact"
}

module "root" {
source = "../../"

domain = local.domain_name
project_id = data.scaleway_account_project.default.id
}

module "subdomain" {
source = "../../"

Expand Down
3 changes: 1 addition & 2 deletions examples/with-tem-and-mx/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Complete domain

This example shows how to manage the domain `exemple.net` along with a subdomain named `contact`, setting up transaction email and external MX records on this latest.
This example shows how to manage the sub-domain `contact.example.net`, setting up transaction email and external MX records.

## Usage

Expand Down Expand Up @@ -32,7 +32,6 @@ Note that this example won't work as the domain name has been reserved by IANA f

| Name | Source | Version |
|------|--------|---------|
| <a name="module_root"></a> [root](#module_root) | ../../ | n/a |
| <a name="module_subdomain"></a> [subdomain](#module_subdomain) | ../../ | n/a |

## Resources
Expand Down
7 changes: 0 additions & 7 deletions examples/with-tem-and-mx/main.tf
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,6 @@ locals {
subdomain = "contact"
}

module "root" {
source = "../../"

domain = local.domain_name
project_id = data.scaleway_account_project.default.id
}

module "subdomain" {
source = "../../"

Expand Down