Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TF-15131 Update product documentation with new default project behavior #689

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
2 changes: 1 addition & 1 deletion website/docs/cloud-docs/api-docs/workspaces.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -142,7 +142,7 @@ By supplying the necessary attributes under a `vcs-repository` object, you can c
| `data.attributes.working-directory` | string | (nothing) | A relative path that Terraform will execute within. This defaults to the root of your repository and is typically set to a subdirectory matching the environment when multiple environments exist within the same repository. |
| `data.attributes.setting-overwrites` | object | none | The keys in this object are attributes that have organization-level defaults. Each attribute key stores a boolean value which is `true` by default. To overwrite the default inherited value, set an attribute's value to `false`. For example, to set `execution-mode` as the organization default, set `setting-overwrites.execution-mode` to `false`. |
| `data.relationships` | object | none | Specifies a group of workspace associations. |
| `data.relationships.project.data.id` | string | default project | The ID of the project to create the workspace in. If left blank, Terraform creates the workspace in the organization's default project. You must have permission to create workspaces in the project, either by organization-level permissions or team admin access to a specific project. |
| `data.relationships.project.data.id` | string | default project | The ID of the project to create the workspace in. You must supply a project ID if no default project exists. You must have permission to create workspaces in the project, either by organization-level permissions or team admin access to a specific project. |
netramali marked this conversation as resolved.
Show resolved Hide resolved
| `data.relationships.tag-bindings.data` | list of objects | none | Specifies a list of tags to attach to the workspace. |
| `data.relationships.tag-bindings.data.type` | string | none | Must be `tag-bindings` for each object in the list. |
| `data.relationships.tag-bindings.data.attributes.key` | string | none | Specifies the tag key for each object in the list. |
Expand Down
9 changes: 6 additions & 3 deletions website/docs/cloud-docs/projects/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,12 @@ departments, subsidiaries, or technical teams.
## Default Project

Every workspace must belong to exactly one project. By default, all workspaces
belong to an organization's **Default Project**. You can rename the default
project, but you cannot delete it. You can specify a workspace's project at the
time of creation and move it to a different project later.
belong to an organization's **Default Project**. You can rename the default project
or set another project as the default, but you cannot delete an organization's default
project. When creating a workspace, you can specify which project it belongs to,
and you can always move it to a different project later. If you are creating a
workspace and your organization does not have a default project, you must specify
which project your workspace belongs to.

The “Manage Workspaces” team permission lets users create and manage workspaces.
Users with this permission can read and manage all workspaces, but new
Expand Down
9 changes: 4 additions & 5 deletions website/docs/cloud-docs/projects/manage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -55,9 +55,8 @@ information.
1. Click on a project name of the project you want to edit.
1. Click **Settings**.

On this **General settings** page, you can update the project name, project
description, and delete the project. On the **Team access** page, you can modify
team access to the project.
On this **General settings** page, you can update the project name and project
description, override the default project, and delete the project. On the **Team access** page, you can modify team access to the project.

## Automatically destroy inactive workspaces

Expand Down Expand Up @@ -88,9 +87,9 @@ this default configuration. Refer to [automatically destroy workspaces](/terrafo

## Delete a project

You can only delete projects that do not contain workspaces.
You cannot delete the default project or projects that contain workspaces.

To delete an empty project:
To delete a project:

1. Click **Projects**.
1. Search for a project that you want to review by scrolling down the table or
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ You may be able to manage the following organization settings.

#### General

Review the organization name and contact email. Organization owners can choose to change the organization name, contact email, and the default execution mode, or delete the organization. When an organization owner updates the default execution mode, all workspaces configured to [inherit this value](/terraform/cloud-docs/workspaces/settings#execution-mode) will be affected.
Review the organization name and contact email. Organization owners can choose to change the organization name, contact email, default execution mode, and the default project, or delete the organization. When an organization owner updates the default execution mode, all workspaces configured to [inherit this value](/terraform/cloud-docs/workspaces/settings#execution-mode) are affected.
netramali marked this conversation as resolved.
Show resolved Hide resolved

Organization owners can also choose whether [workspace administrators](/terraform/cloud-docs/users-teams-organizations/permissions#workspace-admins) can delete workspaces that are managing resources. Deleting a workspace with resources under management introduces risk because Terraform can no longer track or manage the infrastructure. The workspace's users must manually delete any remaining resources or [import](/terraform/cli/commands/import) them into another Terraform workspace.

Expand Down