docs: add smtp config note and generate docs

zitadel · Aug 21, 2024 · 6021f7b · 6021f7b
1 parent 6a1012c
commit 6021f7b
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 0 deletions.
diff --git a/docs/resources/smtp_config.md b/docs/resources/smtp_config.md
@@ -14,6 +14,17 @@ Resource representing the SMTP configuration of an instance.
 
 Breaking changes in update to ZITADEL provider v2.0.0, please remove and reimport the SMTP configuration into the Terraform state, as the logic for the ID in this resource changed.
 
+```bash
+# Find out the state path of your SMTP resource
+export SMTP_CONFIG=$(terraform state list | grep 'smtp_config')
+
+# Remove the current state of your SMTP resource
+terraform state rm ${SMTP_CONFIG}
+
+# Reimport your SMTP resource
+terraform import ${SMTP_CONFIG} "${SMTP_CONFIG_ID}:${SMTP_CONFIG_PASSWORD}"
+```
+
 ---
 
 ## Example Usage

diff --git a/templates/resources/smtp_config.md.tmpl b/templates/resources/smtp_config.md.tmpl
@@ -14,6 +14,17 @@ description: |-
 
 Breaking changes in update to ZITADEL provider v2.0.0, please remove and reimport the SMTP configuration into the Terraform state, as the logic for the ID in this resource changed.
 
+```bash
+# Find out the state path of your SMTP resource
+export SMTP_CONFIG=$(terraform state list | grep 'smtp_config')
+
+# Remove the current state of your SMTP resource
+terraform state rm ${SMTP_CONFIG}
+
+# Reimport your SMTP resource
+terraform import ${SMTP_CONFIG} "${SMTP_CONFIG_ID}:${SMTP_CONFIG_PASSWORD}"
+```
+
 ---
 
 ## Example Usage