Generate the docs properly

springernature · Oct 1, 2024 · 35eee25 · 35eee25
1 parent b797249
commit 35eee25
Show file tree

Hide file tree

Showing 6 changed files with 28 additions and 50 deletions.
diff --git a/docs/data-sources/teams.md b/docs/data-sources/teams.md
@@ -13,6 +13,18 @@ Retrieves all teams
 ## Example Usage
 
 ```terraform
+terraform {
+  required_providers {
+    ee-platform = {
+      source = "springernature/ee-platform"
+    }
+  }
+}
+
+provider "ee-platform" {
+  platform_api = "https://ee-platform-dev.springernature.app"
+}
+
 data "ee-platform_teams" "all_teams" {}
 
 output "teams" {
@@ -24,7 +36,7 @@ output "teams" {
 resource "local_file" "foo" {
   for_each = data.ee-platform_teams.all_teams.teams
   filename = "/tmp/test/${each.key}"
-  content  = "name = ${each.value.name}, department = ${each.value.department}"
+  content  = "name = ${each.value.name}, id = ${each.value.id}"
 }
 ```
 
@@ -40,11 +52,9 @@ resource "local_file" "foo" {
 
 Required:
 
-- `department` (String) SN department the team is part of
 - `id` (String) Unique identifier of the team
 - `name` (String) Team name
 
 Optional:
 
-- `domain` (String) SN Digital domain the team is part of
 - `snpaas_org` (String) SNPaaS Cloud Foundry organization that the team deploys to
diff --git a/docs/index.md b/docs/index.md
@@ -22,8 +22,14 @@ terraform {
   }
 }
 
-provider "ee-platform" {}
+provider "ee-platform" {
+  platform_api = "https://ee-platform-dev.springernature.app"
+}
 ```
 
 <!-- schema generated by tfplugindocs -->
 ## Schema
+
+### Optional
+
+- `platform_api` (String)
diff --git a/...les/provider-install-verification/main.tf → ...-sources/ee-platform_teams/data-source.tf b/...les/provider-install-verification/main.tf → ...-sources/ee-platform_teams/data-source.tf
@@ -7,7 +7,7 @@ terraform {
 }
 
 provider "ee-platform" {
-    platform_api = "https://ee-platform.springernature.app:8080"
+  platform_api = "https://ee-platform-dev.springernature.app"
 }
 
 data "ee-platform_teams" "all_teams" {}
@@ -22,4 +22,4 @@ resource "local_file" "foo" {
   for_each = data.ee-platform_teams.all_teams.teams
   filename = "/tmp/test/${each.key}"
   content  = "name = ${each.value.name}, id = ${each.value.id}"
-}
+}
diff --git a/examples/provider-install-verification/.terraform.lock.hcl b/examples/provider-install-verification/.terraform.lock.hcl
diff --git a/examples/provider/provider.tf b/examples/provider/provider.tf
@@ -7,4 +7,6 @@ terraform {
   }
 }
 
-provider "ee-platform" {}
+provider "ee-platform" {
+  platform_api = "https://ee-platform-dev.springernature.app"
+}
diff --git a/internal/client/platform.go b/internal/client/platform.go
@@ -1,3 +1,6 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
 package client
 
 import (