Skip to content

Commit

Permalink
docs: fix broken links to conceptual docs (#1761)
Browse files Browse the repository at this point in the history
  • Loading branch information
staceysalamon-aiven authored Jun 12, 2024
1 parent b8c5d98 commit 6d6f72e
Show file tree
Hide file tree
Showing 14 changed files with 22 additions and 22 deletions.
2 changes: 1 addition & 1 deletion docs/data-sources/project.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ data "aiven_project" "example_project" {
- `default_cloud` (String) Default cloud provider and region where services are hosted. This can be changed after the project is created and will not affect existing services.
- `estimated_balance` (String) The monthly running estimate for this project for the current billing period.
- `id` (String) The ID of this resource.
- `parent_id` (String) Link a project to an [organization, organizational unit,](https://aiven.io/docs/platform/concepts/projects_accounts_access) or account by using its ID. To set up proper dependencies please refer to this variable as a reference.
- `parent_id` (String) Link a project to an [organization, organizational unit,](https://aiven.io/docs/platform/concepts/orgs-units-projects) or account by using its ID. To set up proper dependencies please refer to this variable as a reference.
- `payment_method` (String) The payment type used for this project. For example,`card`.
- `tag` (Set of Object) Tags are key-value pairs that allow you to categorize projects. (see [below for nested schema](#nestedatt--tag))
- `technical_emails` (Set of String) The email addresses for [project contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this project and its services. You can also set email contacts at the service level. It's good practice to keep these up-to-date to be aware of any potential issues with your project.
Expand Down
4 changes: 2 additions & 2 deletions docs/resources/organization.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "aiven_organization Resource - terraform-provider-aiven"
subcategory: ""
description: |-
Creates and manages an organization https://aiven.io/docs/platform/concepts/projects_accounts_access.
Creates and manages an organization https://aiven.io/docs/platform/concepts/orgs-units-projects.
---

# aiven_organization (Resource)

Creates and manages an [organization](https://aiven.io/docs/platform/concepts/projects_accounts_access).
Creates and manages an [organization](https://aiven.io/docs/platform/concepts/orgs-units-projects).

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/resources/organization_group_project.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "aiven_organization_group_project Resource - terraform-provider-aiven"
subcategory: ""
description: |-
Adds and manages a group https://aiven.io/docs/platform/concepts/projects_accounts_access#groups of users as members of a project https://aiven.io/docs/platform/reference/project-member-privileges.
Adds and manages a group https://aiven.io/docs/platform/howto/list-groups of users as members of a project https://aiven.io/docs/platform/reference/project-member-privileges.
---

# aiven_organization_group_project (Resource)

Adds and manages a [group](https://aiven.io/docs/platform/concepts/projects_accounts_access#groups) of users as [members of a project](https://aiven.io/docs/platform/reference/project-member-privileges).
Adds and manages a [group](https://aiven.io/docs/platform/howto/list-groups) of users as [members of a project](https://aiven.io/docs/platform/reference/project-member-privileges).

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/resources/organization_user_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "aiven_organization_user_group Resource - terraform-provider-aiven"
subcategory: ""
description: |-
Creates and manages a user group https://aiven.io/docs/platform/concepts/projects_accounts_access#groups in an organization.
Creates and manages a user group https://aiven.io/docs/platform/howto/list-groups in an organization.
---

# aiven_organization_user_group (Resource)

Creates and manages a [user group](https://aiven.io/docs/platform/concepts/projects_accounts_access#groups) in an organization.
Creates and manages a [user group](https://aiven.io/docs/platform/howto/list-groups) in an organization.

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/resources/organization_user_group_member.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "aiven_organization_user_group_member Resource - terraform-provider-aiven"
subcategory: ""
description: |-
Adds and manages users in a user group https://aiven.io/docs/platform/concepts/projects_accounts_access#groups.
Adds and manages users in a user group https://aiven.io/docs/platform/howto/list-groups.
---

# aiven_organization_user_group_member (Resource)

Adds and manages users in a [user group](https://aiven.io/docs/platform/concepts/projects_accounts_access#groups).
Adds and manages users in a [user group](https://aiven.io/docs/platform/howto/list-groups).

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/resources/organizational_unit.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "aiven_organizational_unit Resource - terraform-provider-aiven"
subcategory: ""
description: |-
Creates and manages an organizational unit https://aiven.io/docs/platform/concepts/projects_accounts_access in an Aiven organization.
Creates and manages an organizational unit https://aiven.io/docs/platform/concepts/orgs-units-projects in an Aiven organization.
---

# aiven_organizational_unit (Resource)

Creates and manages an [organizational unit](https://aiven.io/docs/platform/concepts/projects_accounts_access) in an Aiven organization.
Creates and manages an [organizational unit](https://aiven.io/docs/platform/concepts/orgs-units-projects) in an Aiven organization.

## Example Usage

Expand Down
6 changes: 3 additions & 3 deletions docs/resources/project.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
page_title: "aiven_project Resource - terraform-provider-aiven"
subcategory: ""
description: |-
Creates and manages an Aiven project https://aiven.io/docs/platform/concepts/projects_accounts_access#projects.
Creates and manages an Aiven project https://aiven.io/docs/platform/concepts/orgs-units-projects#projects.
---

# aiven_project (Resource)

Creates and manages an [Aiven project](https://aiven.io/docs/platform/concepts/projects_accounts_access#projects).
Creates and manages an [Aiven project](https://aiven.io/docs/platform/concepts/orgs-units-projects#projects).

## Example Usage

Expand All @@ -33,7 +33,7 @@ resource "aiven_project" "example_project" {
- `billing_group` (String) The ID of the billing group this project is assigned to. To set up proper dependencies please refer to this variable as a reference.
- `copy_from_project` (String) The name of the project to copy billing information, technical contacts, and some other project attributes from. This is most useful to set up the same billing method when you use bank transfers to pay invoices for other projects. You can only do this when creating a project. You can't set the billing over the API for an existing. To set up proper dependencies please refer to this variable as a reference.
- `default_cloud` (String) Default cloud provider and region where services are hosted. This can be changed after the project is created and will not affect existing services.
- `parent_id` (String) Link a project to an [organization, organizational unit,](https://aiven.io/docs/platform/concepts/projects_accounts_access) or account by using its ID. To set up proper dependencies please refer to this variable as a reference.
- `parent_id` (String) Link a project to an [organization, organizational unit,](https://aiven.io/docs/platform/concepts/orgs-units-projects) or account by using its ID. To set up proper dependencies please refer to this variable as a reference.
- `tag` (Block Set) Tags are key-value pairs that allow you to categorize projects. (see [below for nested schema](#nestedblock--tag))
- `technical_emails` (Set of String) The email addresses for [project contacts](https://aiven.io/docs/platform/howto/technical-emails), who will receive important alerts and updates about this project and its services. You can also set email contacts at the service level. It's good practice to keep these up-to-date to be aware of any potential issues with your project.
- `timeouts` (Block, Optional) (see [below for nested schema](#nestedblock--timeouts))
Expand Down
2 changes: 1 addition & 1 deletion examples/organization/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Aiven organizations, units, and projects example

The Aiven platform uses [organizations, organizational units, and projects](https://aiven.io/docs/platform/concepts/projects_accounts_access) to organize services.
The Aiven platform uses [organizations, organizational units, and projects](https://aiven.io/docs/platform/concepts/orgs-units-projects) 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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ func (r *organizationGroupProjectResource) Schema(
resp.Schema = util.GeneralizeSchema(ctx, schema.Schema{
Description: userconfig.Desc(
"Adds and manages a " +
"[group](https://aiven.io/docs/platform/concepts/projects_accounts_access#groups) of users as " +
"[group](https://aiven.io/docs/platform/howto/list-groups) of users as " +
"[members of a project](https://aiven.io/docs/platform/reference/project-member-privileges).",
).
Build(),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -73,7 +73,7 @@ func (r *organizationResource) TypeName() string {
// Schema defines the schema for the organization resource.
func (r *organizationResource) Schema(ctx context.Context, _ resource.SchemaRequest, resp *resource.SchemaResponse) {
resp.Schema = util.GeneralizeSchema(ctx, schema.Schema{
Description: "Creates and manages an [organization](https://aiven.io/docs/platform/concepts/projects_accounts_access).",
Description: "Creates and manages an [organization](https://aiven.io/docs/platform/concepts/orgs-units-projects).",
Attributes: map[string]schema.Attribute{
"id": schema.StringAttribute{
Description: "ID of the organization.",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ func (r *organizationUserGroupMembersResource) Schema(
resp.Schema = util.GeneralizeSchema(ctx, schema.Schema{
Description: userconfig.Desc(
"Adds and manages users in a " +
"[user group](https://aiven.io/docs/platform/concepts/projects_accounts_access#groups).",
"[user group](https://aiven.io/docs/platform/howto/list-groups).",
).
Build(),
Attributes: map[string]schema.Attribute{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ var aivenOrganizationUserGroupSchema = map[string]*schema.Schema{

func ResourceOrganizationUserGroup() *schema.Resource {
return &schema.Resource{
Description: "Creates and manages a [user group](https://aiven.io/docs/platform/concepts/projects_accounts_access#groups) in an organization.",
Description: "Creates and manages a [user group](https://aiven.io/docs/platform/howto/list-groups) in an organization.",
CreateContext: resourceOrganizationUserGroupCreate,
ReadContext: resourceOrganizationUserGroupRead,
UpdateContext: resourceOrganizationUserGroupUpdate,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ var aivenOrganizationalUnitSchema = map[string]*schema.Schema{

func ResourceOrganizationalUnit() *schema.Resource {
return &schema.Resource{
Description: "Creates and manages an [organizational unit](https://aiven.io/docs/platform/concepts/projects_accounts_access) in an Aiven organization.",
Description: "Creates and manages an [organizational unit](https://aiven.io/docs/platform/concepts/orgs-units-projects) in an Aiven organization.",
CreateContext: resourceOrganizationalUnitCreate,
ReadContext: resourceOrganizationalUnitRead,
UpdateContext: resourceOrganizationalUnitUpdate,
Expand Down
4 changes: 2 additions & 2 deletions internal/sdkprovider/service/project/project.go
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ var aivenProjectSchema = map[string]*schema.Schema{
Type: schema.TypeString,
Optional: true,
Description: userconfig.Desc(
"Link a project to an [organization, organizational unit,](https://aiven.io/docs/platform/concepts/projects_accounts_access) or account by using its ID.",
"Link a project to an [organization, organizational unit,](https://aiven.io/docs/platform/concepts/orgs-units-projects) or account by using its ID.",
).Referenced().Build(),
DiffSuppressFunc: func(_, _, _ string, d *schema.ResourceData) bool {
_, ok := d.GetOk("account_id")
Expand Down Expand Up @@ -134,7 +134,7 @@ var aivenProjectSchema = map[string]*schema.Schema{

func ResourceProject() *schema.Resource {
return &schema.Resource{
Description: "Creates and manages an [Aiven project](https://aiven.io/docs/platform/concepts/projects_accounts_access#projects).",
Description: "Creates and manages an [Aiven project](https://aiven.io/docs/platform/concepts/orgs-units-projects#projects).",
CreateContext: resourceProjectCreate,
ReadContext: resourceProjectRead,
UpdateContext: resourceProjectUpdate,
Expand Down

0 comments on commit 6d6f72e

Please sign in to comment.