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.

Sign up for GitHub

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

Jump to bottom

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

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

wants to merge 6 commits into from

Conversation

ker-an
Copy link
Contributor

@ker-an ker-an commented Jul 29, 2024 •
edited
Loading

What

An organization's default project can now be changed or removed. It is now possible that an organization can have no default project.

The following pages have been updated to reflect this change:

  • /cloud-docs/projects/index.mdx
  • /cloud-docs/projects/managing.mdx
  • /cloud-docs/users-teams-organizations/organizations/index.mdx
  • /cloud-docs/api-docs/workspaces.mdx

Why

This is part of our HCP Terraform unification efforts. See [RFC] TF-867: Configurable Default Project in Terraform Cloud.

Links

Merge Checklist

If items do not apply to your changes, add (N/A) and mark them as complete.

Pull Request

  • One or more labels describe the type of change (e.g. clarification) and associated product (e.g. HCP Terraform ).
  • Description links to related pull requests or issues, if any.

Content

  • Redirects have been added to website/redirects.js for moved, renamed, or deleted pages. N/A
  • API documentation and the API Changelog have been updated.
  • Links to related content where appropriate (e.g., API endpoints, permissions, etc.).
  • Pages with related content are updated and link to this content when appropriate.
  • Sidebar navigation files have been updated for added, deleted, reordered, or renamed pages. N/A
  • New pages have metadata (page name and description) at the top. N/A
  • New images are 2048 px wide. They have HashiCorp standard annotation color (#F92672) and format (rectangle with rounded corners), blurred sensitive details (e.g. credentials, usernames, user icons), and descriptive alt text in the markdown for accessibility. N/A
  • New code blocks have the correct syntax and line breaks to eliminate horizontal scroll bars. N/A
  • UI elements (button names, page names, etc.) are bolded.
  • The Vercel website preview successfully deployed.

Reviews

  • I or someone else reviewed the content for technical accuracy.
  • I or someone else reviewed the content for typos, punctuation, spelling, and grammar.

@vercel Vercel
Copy link

vercel bot commented Jul 29, 2024 •
edited
Loading

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
terraform-docs-common ✅ Ready (Inspect) Visit Preview 💬 Add feedback Aug 2, 2024 4:57pm

@ker-an ker-an added HCP Terraform do not merge documentation Improvements or additions to documentation labels Jul 29, 2024
@ker-an ker-an force-pushed the ker-an/update-default-project-documentation branch from 4c00f16 to 343404f Compare July 29, 2024 23:08
@ker-an
Copy link
Contributor Author

ker-an commented Jul 29, 2024 •
edited
Loading

Should this sentence be changed at all or does it still stand? @jbonhag

terraform-docs-common/website/docs/cloud-docs/users-teams-organizations/permissions.mdx

Line 279 in c262ccb

- Create new workspaces within the organization's **Default Project**, an action that is otherwise only available to organization owners.

@ker-an ker-an force-pushed the ker-an/update-default-project-documentation branch from 95913f5 to e54554f Compare July 30, 2024 16:38
@ker-an ker-an force-pushed the ker-an/update-default-project-documentation branch from e54554f to c573615 Compare July 30, 2024 16:42
ker-an
ker-an commented Jul 30, 2024
View reviewed changes
website/docs/cloud-docs/projects/index.mdx
time of creation and move it to a different project later.
belong to an organization's **Default Project**. You can rename and change 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.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I struggled with these updates. How much information is too much information? Should we mention that if no default project exists, you must specify a project on workspace creation?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of suggestions on multiple lines, (which I always find hard to read), here is my suggestion:
"
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.
"

How does that feel?

ker-an
ker-an commented Jul 30, 2024
View reviewed changes
website/docs/cloud-docs/projects/managing.mdx

## Delete a Project

You can only delete projects that do not contain workspaces.
You can only delete a project that does not contain workspaces and is not the
default project.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the future, we will allow deleting a default project but that isn't the case today.

@ker-an ker-an requested a review from a team July 30, 2024 16:47
@ker-an ker-an marked this pull request as ready for review July 30, 2024 16:47
@ker-an ker-an requested a review from a team July 30, 2024 16:48
rkoron007
rkoron007 approved these changes Aug 2, 2024
View reviewed changes
Copy link
Contributor

@rkoron007 rkoron007 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great! Made some small suggestions for style, but lease feel free to push back on anything that doesn't feel good! ✨

website/docs/cloud-docs/projects/index.mdx
time of creation and move it to a different project later.
belong to an organization's **Default Project**. You can rename and change 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Instead of suggestions on multiple lines, (which I always find hard to read), here is my suggestion:
"
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.
"

How does that feel?

website/docs/cloud-docs/projects/managing.mdx

## Delete a Project

You can only delete projects that do not contain workspaces.
You can only delete a project that does not contain workspaces and is not the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it's a little clearer to start with the default project in this sentence like so:

Suggested change
You can only delete a project that does not contain workspaces and is not the
You cannot delete the default project or projects that contain workspaces.

website/docs/cloud-docs/users-teams-organizations/organizations/index.mdx
@@ -79,7 +79,7 @@ You may be able to manage the following organization permissions.

#### 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) will be affected.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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) 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.

@jbonhag jbonhag self-assigned this Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rkoron007 rkoron007 rkoron007 approved these changes

Assignees

@jbonhag jbonhag

Labels
do not merge documentation Improvements or additions to documentation HCP Terraform
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ker-an @rkoron007 @jbonhag