From 22f7fa208f54aa393b396e2ec0df05f9c7f5a17a Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Tue, 6 Feb 2024 13:31:31 +0100 Subject: [PATCH 1/2] docs: fix links and project names --- examples/organization/README.md | 4 ++-- examples/organization/org_units_projects.tf | 12 ++++++------ examples/organization/secrets.tfvars.tmp | 6 +++--- 3 files changed, 11 insertions(+), 11 deletions(-) diff --git a/examples/organization/README.md b/examples/organization/README.md index b55b96a56..8d239c64c 100644 --- a/examples/organization/README.md +++ b/examples/organization/README.md @@ -1,6 +1,6 @@ # Aiven organizations, units, and projects example -The Aiven platform uses [organizations, organizational units, and projects to organize services](https://docs.aiven.io/docs/platform/concepts/projects_accounts_access.html). +The Aiven platform uses [organizations, organizational units, and projects](https://aiven.io/docs/platform/concepts/projects_accounts_access) to organize services. This example shows you how to use the Aiven Provider for Terraform to create an organization with two organizaitonal units, and add projects to those units. @@ -12,7 +12,7 @@ In each unit, three projects will be created for production, QA, and development * [Install Terraform](https://www.terraform.io/downloads) * [Sign up for Aiven](https://console.aiven.io/signup?utm_source=github&utm_medium=organic&utm_campaign=devportal&utm_content=repo) -* [Create an authentication token](https://docs.aiven.io/docs/platform/howto/create_authentication_token.html) +* [Create an authentication token](https://aiven.io/docs/platform/howto/create_authentication_token) ## Set up the Terraform project diff --git a/examples/organization/org_units_projects.tf b/examples/organization/org_units_projects.tf index 582dff416..bf9f31bd6 100644 --- a/examples/organization/org_units_projects.tf +++ b/examples/organization/org_units_projects.tf @@ -37,33 +37,33 @@ resource "aiven_organizational_unit" "unit-fin" { # Create projects in units # Engineering projects -resource "aiven_project" "staceys-prod-eng" { +resource "aiven_project" "prod-eng" { project = "${var.prod_project_name}-eng" parent_id = aiven_organizational_unit.unit-eng.id } -resource "aiven_project" "staceys-qa-eng" { +resource "aiven_project" "qa-eng" { project = "${var.qa_project_name}-eng" parent_id = aiven_organizational_unit.unit-eng.id } -resource "aiven_project" "staceys-dev-eng" { +resource "aiven_project" "dev-eng" { project = "${var.dev_project_name}-eng" parent_id = aiven_organizational_unit.unit-eng.id } # Finance projects -resource "aiven_project" "staceys-prod-fin" { +resource "aiven_project" "prod-fin" { project = "${var.prod_project_name}-fin" parent_id = aiven_organizational_unit.unit-fin.id } -resource "aiven_project" "staceys-qa-fin" { +resource "aiven_project" "qa-fin" { project = "${var.qa_project_name}-fin" parent_id = aiven_organizational_unit.unit-fin.id } -resource "aiven_project" "staceys-dev-fin" { +resource "aiven_project" "dev-fin" { project = "${var.dev_project_name}-fin" parent_id = aiven_organizational_unit.unit-fin.id } \ No newline at end of file diff --git a/examples/organization/secrets.tfvars.tmp b/examples/organization/secrets.tfvars.tmp index 012c7710c..797f87fa3 100644 --- a/examples/organization/secrets.tfvars.tmp +++ b/examples/organization/secrets.tfvars.tmp @@ -1,5 +1,5 @@ aiven_api_token = "AIVEN_API_TOKEN" -prod_project_name = "demo-tech-prod" -qa_project_name = "demo-tech-qa" -dev_project_name = "demo-tech-dev" \ No newline at end of file +prod_project_name = "YOUR_ORG_NAME-demo-prod" +qa_project_name = "YOUR_ORG_NAME-demo-qa" +dev_project_name = "YOUR_ORG_NAME-demo-dev" \ No newline at end of file From 7c4bde3e8519b7555bb429dafc7ed4ea85c5c9e0 Mon Sep 17 00:00:00 2001 From: Stacey Salamon Date: Tue, 6 Feb 2024 14:48:37 +0100 Subject: [PATCH 2/2] docs: fix all old links --- README.md | 2 +- docs/guides/creating-static-ip-addresses.md | 2 +- docs/index.md | 2 +- internal/sdkprovider/service/kafka/kafka.go | 2 +- internal/sdkprovider/service/kafkatopic/kafka_topic.go | 2 +- .../service/vpc/azure_vpc_peering_connection_test.go | 2 +- templates/guides/creating-static-ip-addresses.md | 2 +- templates/index.md | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 80f442f85..f76dc9a76 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ The Terraform provider for [Aiven.io](https://aiven.io/), an open source data pl ## Quick start - [Signup for Aiven](https://console.aiven.io/signup?utm_source=github&utm_medium=organic&utm_campaign=terraform&utm_content=signup) -- [Get your authentication token and project name](https://help.aiven.io/en/articles/2059201-authentication-tokens) +- [Create your authentication token](https://aiven.io/docs/platform/howto/create_authentication_token) - Create a file named `main.tf` with the content below: ```hcl diff --git a/docs/guides/creating-static-ip-addresses.md b/docs/guides/creating-static-ip-addresses.md index 5a2beb85c..fb17ea22e 100644 --- a/docs/guides/creating-static-ip-addresses.md +++ b/docs/guides/creating-static-ip-addresses.md @@ -6,7 +6,7 @@ page_title: "Creating static IP addresses" You can create static IP addresses for your services for an additional charge. Static IP addresses belong to a project and are created in the cloud you specify. -For more information, see the article on [static IP addresses in Aiven](https://docs.aiven.io/docs/platform/concepts/static-ips). +For more information, see the article on [static IP addresses in Aiven](https://aiven.io/docs/platform/concepts/static-ips). # Example diff --git a/docs/index.md b/docs/index.md index 41b9b1523..6d9b7b693 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2,7 +2,7 @@ The Terraform provider for [Aiven](https://aiven.io/), an open source data platform as a service. ## Authentication token -[Signup at Aiven](https://console.aiven.io/signup?utm_source=terraformregistry&utm_medium=organic&utm_campaign=terraform&utm_content=signup) and see the [official instructions](https://docs.aiven.io/docs/platform/howto/create_authentication_token.html) to create an API Authentication Token. +[Sign up for Aiven](https://console.aiven.io/signup?utm_source=terraformregistry&utm_medium=organic&utm_campaign=terraform&utm_content=signup) and [create an authentication token](https://aiven.io/docs/platform/howto/create_authentication_token). ## Example usage _Only available for Terraform v0.13 and above. For older versions, see [here](guides/install-terraform-v012.md)._ diff --git a/internal/sdkprovider/service/kafka/kafka.go b/internal/sdkprovider/service/kafka/kafka.go index 094efcb0d..a9e645b41 100644 --- a/internal/sdkprovider/service/kafka/kafka.go +++ b/internal/sdkprovider/service/kafka/kafka.go @@ -216,7 +216,7 @@ func resourceKafkaRead(ctx context.Context, d *schema.ResourceData, m interface{ "on Kafka v3.0. Please switch to Karapace, a drop-in open source replacement " + "before proceeding with the upgrade. To do that use aiven_kafka.karapace=true " + "that will switch the service to use Karapace for schema registry and REST proxy. " + - "For more information, please refer to our help article: https://help.aiven.io/en/articles/5651983", + "More information about Karpace is available in our documentation: https://aiven.io/docs/products/kafka/karapace", }) } diff --git a/internal/sdkprovider/service/kafkatopic/kafka_topic.go b/internal/sdkprovider/service/kafkatopic/kafka_topic.go index add1e08cb..c26c2540e 100644 --- a/internal/sdkprovider/service/kafkatopic/kafka_topic.go +++ b/internal/sdkprovider/service/kafkatopic/kafka_topic.go @@ -402,7 +402,7 @@ func resourceKafkaTopicRead(ctx context.Context, d *schema.ResourceData, m inter topic, err := kafkatopicrepository.New(client.KafkaTopics).Read(ctx, project, serviceName, topicName) // Topics are destroyed when kafka is off - // https://docs.aiven.io/docs/platform/concepts/service-power-cycle + // https://aiven.io/docs/platform/concepts/service-power-cycle // So it's better to recreate them, than make user to clear the state manually // Recreates missing topics: // 1. if server returns 404 diff --git a/internal/sdkprovider/service/vpc/azure_vpc_peering_connection_test.go b/internal/sdkprovider/service/vpc/azure_vpc_peering_connection_test.go index 2733ebcae..1d1020a6e 100644 --- a/internal/sdkprovider/service/vpc/azure_vpc_peering_connection_test.go +++ b/internal/sdkprovider/service/vpc/azure_vpc_peering_connection_test.go @@ -85,7 +85,7 @@ func TestAccAivenAzureVPCPeeringConnection_basic(t *testing.T) { } // testAccVPCPeeringConnectionAzureResourcePartOne -// Based on https://help.aiven.io/en/articles/3435096-azure-virtual-network-peering +// Based on https://aiven.io/docs/platform/howto/vnet-peering-azure func testAccVPCPeeringConnectionAzureResourcePartOne(prefix string, s *azureSecrets) string { return fmt.Sprintf(` provider "azurerm" { diff --git a/templates/guides/creating-static-ip-addresses.md b/templates/guides/creating-static-ip-addresses.md index 5a2beb85c..fb17ea22e 100644 --- a/templates/guides/creating-static-ip-addresses.md +++ b/templates/guides/creating-static-ip-addresses.md @@ -6,7 +6,7 @@ page_title: "Creating static IP addresses" You can create static IP addresses for your services for an additional charge. Static IP addresses belong to a project and are created in the cloud you specify. -For more information, see the article on [static IP addresses in Aiven](https://docs.aiven.io/docs/platform/concepts/static-ips). +For more information, see the article on [static IP addresses in Aiven](https://aiven.io/docs/platform/concepts/static-ips). # Example diff --git a/templates/index.md b/templates/index.md index 41b9b1523..6d9b7b693 100644 --- a/templates/index.md +++ b/templates/index.md @@ -2,7 +2,7 @@ The Terraform provider for [Aiven](https://aiven.io/), an open source data platform as a service. ## Authentication token -[Signup at Aiven](https://console.aiven.io/signup?utm_source=terraformregistry&utm_medium=organic&utm_campaign=terraform&utm_content=signup) and see the [official instructions](https://docs.aiven.io/docs/platform/howto/create_authentication_token.html) to create an API Authentication Token. +[Sign up for Aiven](https://console.aiven.io/signup?utm_source=terraformregistry&utm_medium=organic&utm_campaign=terraform&utm_content=signup) and [create an authentication token](https://aiven.io/docs/platform/howto/create_authentication_token). ## Example usage _Only available for Terraform v0.13 and above. For older versions, see [here](guides/install-terraform-v012.md)._