Update tf build instructions + fix dead link

gravitational · Nov 15, 2024 · 71e698a · 71e698a
1 parent 653b5fa
commit 71e698a
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 13 deletions.
diff --git a/docs/config.json b/docs/config.json
@@ -2240,6 +2240,11 @@
       "destination": "/admin-guides/infrastructure-as-code/teleport-operator/teleport-operator/",
       "permanent": true
     },
+    {
+      "source": "/admin-guides/infrastructure-as-code/terraform-provider/",
+      "destination": "/admin-guides/infrastructure-as-code/terraform-provider/terraform-provider/",
+      "permanent": true
+    },
     {
       "source": "/management/dynamic-resources/terraform-provider/",
       "destination": "/admin-guides/infrastructure-as-code/terraform-provider/terraform-provider/",

diff --git a/integrations/terraform/README.md b/integrations/terraform/README.md
@@ -2,7 +2,7 @@
 
 ## Usage
 
-Please, refer to [official documentation](https://goteleport.com/docs/admin-guides/infrastructure-as-code/terraform-provider/).
+Please, refer to [official documentation](https://goteleport.com/docs/admin-guides/infrastructure-as-code/terraform-provider/terraform-provider/).
 
 ## Development
 
@@ -13,28 +13,19 @@ Please, refer to [official documentation](https://goteleport.com/docs/admin-guid
 
 3. Install [`Terraform`](https://learn.hashicorp.com/tutorials/terraform/install-cli) v1.1.0+. Alternatively, you can use [`tfenv`](https://github.com/tfutils/tfenv). Please note that on Mac M1 you need to specify `TFENV_ARCH` (ex: `TFENV_ARCH=arm64 tfenv install 1.1.6`).
 
-4. Clone the plugin:
+4. Build and install the plugin:
 
     ```bash
-    git clone git@github.com:gravitational/teleport-plugins
-    ```
-
-5. Build and install the plugin:
-
-    ```bash
-    cd teleport-plugins/terraform
+    cd integrations/terraform
     make install
     ```
 
-6. Run tests:
+5. Run tests:
 
     ```bash
     make test
     ```
 
-    Note: Some tests won't pass without a valid `teleport` binary, enterprise license, etc. 
-    See [Testing](../TESTING.md) to see how to provide these values to the tests locally.
-
 # Updating the provider
 
 Run:
@@ -45,6 +36,11 @@ make gen-tfschema
 
 This will generate `types_tfschema.go` from a current API `.proto` file, and regenerate the provider code.
 
+If the schema changed, you will need to re-render the docs with:
+```
+make docs
+```
+
 # Playing with examples locally
 
 1. Start Teleport.