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

Updating access page #6037

Merged
merged 22 commits into from
Sep 24, 2024
Merged

Updating access page #6037

merged 22 commits into from
Sep 24, 2024

Conversation

matthewshaver
Copy link
Contributor

@matthewshaver matthewshaver commented Sep 9, 2024

What are you changing in this pull request and why?

Updating the user access page based on feedback.

See this internal page for more info

Checklist

  • I have reviewed the Content style guide so my content adheres to these guidelines.
  • The topic I'm writing about is for specific dbt version(s) and I have versioned it according to the version a whole page and/or version a block of content guidelines.
  • I have added checklist item(s) to this list for anything anything that needs to happen before this PR is merged, such as "needs technical review" or "change base branch."

@matthewshaver matthewshaver requested a review from a team as a code owner September 9, 2024 20:31
Copy link

vercel bot commented Sep 9, 2024

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

Name Status Preview Updated (UTC)
docs-getdbt-com ✅ Ready (Inspect) Visit Preview Sep 24, 2024 8:29pm

@github-actions github-actions bot added content Improvements or additions to content size: medium This change will take up to a week to address Docs team Authored by the Docs team @dbt Labs labels Sep 9, 2024
Copy link
Collaborator

@runleonarun runleonarun left a comment

Choose a reason for hiding this comment

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

@matthewshaver This reads GREAT! I absolutely love you running through the okta and Cloud configs with a persona (good ol' Euclid.) I feel like we should do this in other places where there's an admin and user personas and they both have steps to follow.

@@ -8,142 +8,203 @@ pagination_prev: null

:::info "User access" is not "Model access"

**User groups and access** and **model groups and access** mean two different things. "Model groups and access" is a specific term used in the language of dbt-core. Refer to [Model access](/docs/collaborate/govern/model-access) for more info on what it means in dbt-core.
**User groups and access** and **model groups and access** are two different things. "Model groups and access" is a specific term used in the language of [model governance](/docs/collaborate/govern/about-model-governance). Refer to [Model access](/docs/collaborate/govern/model-access) for more information.
Copy link
Collaborator

Choose a reason for hiding this comment

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

The note on the Model access page says a little more about the future of these two things. I wonder if we should have a reusable and use one note in both places?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

What if we change the perspective on both but keep similar information?

"You're on this page to do x which is not y'
"You're on this page to do y, which is not x"

Copy link
Collaborator

Choose a reason for hiding this comment

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

I love that @matthewshaver. Feels more appropriate


## Role-based access control
Delete users from this same window to free up licenses for new users.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think a line after an image can easily get lost. It feels like it might be helpful to move this important line into the paragraph preceding the image.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good call

:::info dbt Cloud Enterprise
### Groups

Groups in dbt Cloud serve much of the same purpose as they do in traditional directory tools — to gather individual users together to make bulk assignment of permissions easier. Admins use groups in dbt Cloud to assign [licenses](#licenses) and [permissions](#permissions). The permissions are more granular than licenses, and you only assign them at the group level; _ you can’t assign permissions at the user level._ Every user in dbt Cloud must be assigned to at least one group.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Something is not working with the italics here. Maybe need to remove the semicolon?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Weird. I'll try a few things


Role-based access control is a feature of the dbt Cloud Enterprise plan
If a user is assigned licenses and permissions from multiple groups, the group that grants the most access will take precedence. You must assign a permission set to any groups created beyond the three defaults, or users assigned will not have access to features beyond their user profile.
Copy link
Collaborator

Choose a reason for hiding this comment

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

"You must assign a permission set to any groups created beyond the three defaults, or users assigned will not have access to features beyond their user profile."

This sentence might be more helpful in the paragraph above that begins with "Create new groups from the..."

If a user is assigned licenses and permissions from multiple groups, the group that grants the most access will take precedence.

What do you think about simplifying this a little? I had to read it a couple of times to get it. Maybe something like:

Suggested change
If a user is assigned licenses and permissions from multiple groups, the group that grants the most access will take precedence. You must assign a permission set to any groups created beyond the three defaults, or users assigned will not have access to features beyond their user profile.
When a user belongs to multiple groups, the group that grants the most access will take precedence. You must assign a permission set to any groups created beyond the three defaults, or users assigned will not have access to features beyond their user profile.

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 think we should keep this specific because groups can be assigned with no permissions. It's about license and permission assignments. One piece of feedback was that customers were getting confused, so I think leaving in the specific language will help.

Maybe making it a callout would work better? This is an important part to stress

Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe making it a callout would work better? This is an important part to stress

That might work! See how it looks on the page. Your call either way!

website/docs/docs/cloud/manage-access/about-access.md Outdated Show resolved Hide resolved
website/docs/docs/cloud/manage-access/about-access.md Outdated Show resolved Hide resolved
website/docs/docs/cloud/manage-access/about-access.md Outdated Show resolved Hide resolved
website/docs/docs/cloud/manage-access/about-access.md Outdated Show resolved Hide resolved
website/docs/docs/cloud/manage-access/about-access.md Outdated Show resolved Hide resolved
website/docs/docs/cloud/manage-access/about-access.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@runleonarun runleonarun left a comment

Choose a reason for hiding this comment

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

I like your counter suggestions!


Role-based access control is a feature of the dbt Cloud Enterprise plan
If a user is assigned licenses and permissions from multiple groups, the group that grants the most access will take precedence. You must assign a permission set to any groups created beyond the three defaults, or users assigned will not have access to features beyond their user profile.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe making it a callout would work better? This is an important part to stress

That might work! See how it looks on the page. Your call either way!

@github-actions github-actions bot added size: large This change will more than a week to address and might require more than one person and removed size: medium This change will take up to a week to address labels Sep 24, 2024
@matthewshaver matthewshaver merged commit 36ceb71 into current Sep 24, 2024
10 checks passed
@matthewshaver matthewshaver deleted the access-page branch September 24, 2024 20:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content Improvements or additions to content Docs team Authored by the Docs team @dbt Labs size: large This change will more than a week to address and might require more than one person
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants