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

Update Settings Menu #1130

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ If you would like to export all the data managed in your Dedicated cloud instanc
| Export reports | [Reports API]({{< relref "/guides/core/reports/clone-and-export-reports/" >}}) |
| Export artifacts | [Explore artifact graphs]({{< relref "/guides/core/artifacts/explore-and-traverse-an-artifact-graph" >}}), [Download and use artifacts]({{< relref "/guides/core/artifacts/download-and-use-an-artifact/#download-and-use-an-artifact-stored-on-wb" >}}) |

If you manage artifacts stored in the Dedicated cloud with [Secure Storage Connector]({{< relref "/guides/models/app/settings-page/teams/#secure-storage-connector" >}}), you may not need to export the artifacts using the W&B SDK API.
If you manage artifacts stored in the Dedicated cloud with [Secure Storage Connector]({{< relref "/guides/models/app/features/teams.md/#secure-storage-connector" >}}), you may not need to export the artifacts using the W&B SDK API.
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
If you manage artifacts stored in the Dedicated cloud with [Secure Storage Connector]({{< relref "/guides/models/app/features/teams.md/#secure-storage-connector" >}}), you may not need to export the artifacts using the W&B SDK API.
If you manage artifacts stored in the Dedicated cloud with [Secure Storage Connector]({{< relref "/guides/models/app/features/teams.md#secure-storage-connector" >}}), you may not need to export the artifacts using the W&B SDK API.


{{% alert %}}
Using W&B SDK API to export all of your data can be slow if you have a large number of runs, artifacts etc. W&B recommends running the export process in appropriately sized batches so as not to overwhelm your Dedicated cloud instance.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Collaborate with your colleagues, share results, and track all the
menu:
default:
identifier: teams
parent: settings
parent: w-b-app-ui-reference
title: Manage teams
weight: 50
---
Expand Down
21 changes: 17 additions & 4 deletions content/guides/models/app/settings-page/_index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,26 @@
---
description: Use the Weights and Biases Settings Page to customize your individual
user profile or team settings.
description: Customize your individual user profile or team settings.
menu:
default:
identifier: settings
parent: w-b-app-ui-reference
title: Settings
---

Within your individual user account you can edit: your profile picture, display name, geography location, biography information, emails associated to your account, and manage alerts for runs. You can also use the settings page to link your GitHub repository and delete your account. For more information, see [User settings]({{< relref "./user-settings.md" >}}).
## User settings
In the **User Settings** page, you can:
- Edit your profile picture, display name, geography location, biography information, emails associated to your account, and manage alerts for runs.
- Link your GitHub repository and delete your account.

Use the team settings page to invite or remove new members to a team, manage alerts for team runs, change privacy settings, and view and manage storage usage. For more information about team settings, see [Team settings]({{< relref "./team-settings.md" >}}).
To access your user settings, click your profile image, then click **User Settings**.

For more information, see [User settings]({{< relref "./user-settings.md" >}}).

## Team settings
In the **Settings** page for your team:

- Team admins can manage the team's settings, including alerts for team runs and privacy settings.
- Team admins can view and manage storage usage.
- Depending on the team's settings, team admins or any team member can invite members to the team.

For more information about team settings, see [Team settings]({{< relref "./team-settings.md" >}}).
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ description: Manage your organization's billing settings
menu:
default:
parent: settings
title: Manage billing settings
title: Billing settings
weight: 20
---

Expand Down
2 changes: 1 addition & 1 deletion content/guides/models/app/settings-page/emails.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ menu:
default:
identifier: emails
parent: settings
title: Manage email settings
title: Email settings
weight: 40
---

Expand Down
2 changes: 1 addition & 1 deletion content/guides/models/app/settings-page/storage.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ menu:
default:
identifier: app_storage
parent: settings
title: Manage storage
title: Storage settings
weight: 60
---

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ menu:
default:
identifier: system-metrics
parent: settings
title: System metrics
title: System metric settings
weight: 70
---

Expand Down
2 changes: 1 addition & 1 deletion content/guides/models/app/settings-page/team-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ menu:
default:
identifier: team-settings
parent: settings
title: Manage team settings
title: Team settings
weight: 30
---

Expand Down
2 changes: 1 addition & 1 deletion content/guides/models/app/settings-page/user-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ menu:
default:
identifier: user-settings
parent: settings
title: Manage user settings
title: User settings
weight: 10
---

Expand Down
2 changes: 1 addition & 1 deletion content/guides/models/registry/configure_registry.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ A registry admin can assign or modify roles for users and teams in a registry.
See [Configure user roles in a registry]({{< relref "configure_registry.md#configure-registry-roles" >}}) for more information.

{{% alert title="W&B role types" %}}
There are two different types of roles in W&B: [Team roles]({{< ref "/guides/models/app/settings-page/teams.md#team-role-and-permissions" >}}) and [Registry roles]({{< relref "configure_registry.md#configure-registry-roles" >}}).
There are two different types of roles in W&B: [Team roles]({{< ref "/guides/models/app/features/teams.md#team-role-and-permissions" >}}) and [Registry roles]({{< relref "configure_registry.md#configure-registry-roles" >}}).

Your role in a team has no impact or relationship to your role in any registry.
{{% /alert %}}
Expand Down
2 changes: 1 addition & 1 deletion content/support/create_team_add_delete_people_team.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ type: docs
tags:
- team management
---
Refer to the link for details on roles and permissions: [Team Roles and Permissions]({{< relref "/guides/models/app/settings-page/teams.md#team-roles-and-permissions" >}}).
Refer to the link for details on roles and permissions: [Team Roles and Permissions]({{< relref "/guides/models/app/features/teams.md#team-roles-and-permissions" >}}).
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
Refer to the link for details on roles and permissions: [Team Roles and Permissions]({{< relref "/guides/models/app/features/teams.md#team-roles-and-permissions" >}}).
Refer [Team Roles and Permissions]({{< relref "/guides/models/app/features/teams.md#team-roles-and-permissions" >}}).

2 changes: 1 addition & 1 deletion content/support/how_can_i_be_removed_from_a_team.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ tags:
- team management
---

A team admin can [remove you from a team]({{< relref "/guides/models/app/settings-page/teams.md" >}}) from the **Users** tab of the team settings.
A team admin can [remove you from a team]({{< relref "/guides/models/app/features/teams.md" >}}) from the **Users** tab of the team settings.
2 changes: 1 addition & 1 deletion content/support/service_account_useful.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Among other things, service accounts are useful for tracking automated jobs logg



Refer to [Team Service Account Behavior]({{< relref "/guides/models/app/settings-page/teams.md#team-service-account-behavior" >}}) for more information.
Refer to [Team Service Account Behavior]({{< relref "/guides/models/app/features/teams.md#team-service-account-behavior" >}}) for more information.
Copy link
Contributor

Choose a reason for hiding this comment

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

I don't think we use title case in link text generally.


You can get the API key for a service account in your team at `<WANDB_HOST_URL>/<your-team-name>/service-accounts`. Alternatively you can go to the **Team settings** for your team and then refer to the **Service Accounts** tab.

Expand Down
2 changes: 1 addition & 1 deletion content/support/team_find_more_information.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,4 @@ type: docs
tags:
- team management
---
For additional information about teams, visit the [teams section]({{< relref "/guides/models/app/settings-page/teams.md" >}}).
For additional information about teams, visit the [teams section]({{< relref "/guides/models/app/features/teams.md" >}}).
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
For additional information about teams, visit the [teams section]({{< relref "/guides/models/app/features/teams.md" >}}).
For additional information about teams, visit [Teams]({{< relref "/guides/models/app/features/teams.md" >}}).

2 changes: 1 addition & 1 deletion content/support/type_roles_available_differences.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@ tags:
- user management
- team management
---
Visit [this]({{< relref "/guides/models/app/settings-page/teams.md#team-roles-and-permissions" >}}) page for an overview of the available roles and permissions.
Visit [this]({{< relref "/guides/models/app/features/teams.md#team-roles-and-permissions" >}}) page for an overview of the available roles and permissions.
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
Visit [this]({{< relref "/guides/models/app/features/teams.md#team-roles-and-permissions" >}}) page for an overview of the available roles and permissions.
Visit [Teams]({{< relref "/guides/models/app/features/teams.md#team-roles-and-permissions" >}}) page for details.