From 0e4d61ef7991002801d2c8b1f49867ac25c381c4 Mon Sep 17 00:00:00 2001 From: Sarah Sanders Date: Tue, 5 Nov 2024 11:20:46 -0800 Subject: [PATCH 1/6] Update manage org docs for user invitation flow --- content/manuals/admin/organization/members.md | 81 ++++++++++++++++++- layouts/shortcodes/admin-users.html | 72 +++-------------- 2 files changed, 91 insertions(+), 62 deletions(-) diff --git a/content/manuals/admin/organization/members.md b/content/manuals/admin/organization/members.md index 275e306974..6500e6d3a0 100644 --- a/content/manuals/admin/organization/members.md +++ b/content/manuals/admin/organization/members.md @@ -9,6 +9,8 @@ aliases: Learn how to manage members for your organization in Docker Hub and the Docker Admin Console. +## Invite members + {{< tabs >}} {{< tab name="Docker Hub" >}} @@ -24,9 +26,52 @@ Learn how to manage members for your organization in Docker Hub and the Docker A {{< /tab >}} {{< /tabs >}} +## Accept invitation + +When an invitation is to a user's email address, they receive +a link to [Docker Hub](https://hub.docker.com/) where they can accept or decline the invitation. + +1. Navigate to your email inbox and open the Docker email with an invitation to +join the Docker organization. +2. To open the link to Docker Hub, select the **click here** link. +3. The Docker create an account page will open. If you already have an account, select **Already have an account? Sign in**. +If you do not have an account yet, create an account using the same email +address you received the invitation through. +4. Optional. If you do not have an account and created one, you must navigate +back to your email inbox and verify your email address using the Docker verification +email. +5. Once you are signed in to [Docker Hub](https://hub.docker.com/), under Docker Products, select the **Docker Hub** tab. +6. Select **Organizations** from the top-level navigation menu. +7. The organizations page will display your invitation. Select **Accept**. + +After accepting an invitation, you are now a member of the organization. + +## Manage invitations + +After inviting members, you can resend or remove invitations as needed. + +### Resend invitations + +You may need to resend an invitation if an invitation is pending or was declined: + +1. Sign in to Docker Hub. +2. Select **Organizations**, your organization, and then **Members**. +3. In the table, locate the invitee, select the **Actions** icon, and then select +**Resend invitation**. +4. Select **Invite** to confirm. + +### Remove an invitation + +To remove a member's invitation from an organization: + +1. Sign in to Docker Hub. +2. Select **Organizations**, your organization, and then **Members**. +3. In the table, select the **Action** icon, and then select **Remove member** or **Remove invitee**. +4. Follow the on-screen instructions to remove the member or invitee. + ## Manage members on a team -Use Docker Hub to add a member to a team or remove a member from a team. +Use Docker Hub or the Admin Console to add or remove team members. ### Add a member to a team @@ -98,3 +143,37 @@ To remove a member from a specific team: {{< /tab >}} {{< /tabs >}} + +### Update a member role + +Organization owners can manage [roles](/security/for-admins/roles-and-permissions/) +within an organization. If an organization is part of a company, +the company owner can also manage that organization's roles. If you have SSO enabled, you can use {{ $role_mapping_link }}. + +> [!NOTE] +> +> If you're the only owner of an organization, +> you need to assign a new owner before you can edit your role. + +To update a member role: + +1. Sign in to Docker Hub. +2. Select **Organizations**, your organization, and then **Members**. +3. Find the username of the member whose role you want to edit. In the table, select the **Actions** icon. +4. Select **Edit role**. +5. Select their organization, select the role you want to assign, and then select **Save**. + +## Export members CSV file + +Owners can export a CSV file containing all members. The CSV file for a company contains the following fields: +- Name: The user's name. +- Username: The user's Docker ID. +- Email: The user's email address. +- Member of Organizations: All organizations the user is a member of within a company. +- Invited to Organizations: All organizations the user is an invitee of within a company. +- Account Created: The time and date when the user account was created. + +To export a CSV file of the members: +1. Sign in to Docker Hub. +2. Select **Organizations**, your organization, and then **Members**. +3. Select the **Action** icon and then select **Export users as CSV**. \ No newline at end of file diff --git a/layouts/shortcodes/admin-users.html b/layouts/shortcodes/admin-users.html index 0439c898c9..962be2405f 100644 --- a/layouts/shortcodes/admin-users.html +++ b/layouts/shortcodes/admin-users.html @@ -32,16 +32,14 @@ * **Account Created**: The time and date when the user account was created.` }} {{ $member_navigation = "Select your company in the left navigation drop-down menu, and then select **Users**." }} {{ $remove_button = "**Remove user**" }} -{{ $update_role = "Select their organization, select the role you want to assign, and then select **Save**." }} +Select their organization, select the role you want to assign, and then select **Save**.{{ $update_role = "" }} {{ $role_mapping_link = "[SCIM for role mapping](/security/for-admins/provisioning/scim/)"}} {{ end }} {{ end }} -## Invite members - -Owners can invite new members to an organization via Docker ID, email address, or via a CSV file containing email +Owners can invite new members to an organization via Docker ID, email address, or with a CSV file containing email addresses. If an invitee does not have a Docker account, they must create an account and verify their email address -before they can accept the invitation to join the organization. When inviting members, their pending invitation occupies +before they can accept an invitation to join the organization. When inviting members, their pending invitation occupies a seat. ### Invite members via Docker ID or email address @@ -56,7 +54,7 @@ of members to your organization via CSV file, see the next section. 5. Follow the on-screen instructions to invite members. Invite a maximum of 1000 members and separate multiple entries by comma, semicolon, or space. - > **Note** + > [!NOTE] > > When you invite members, you assign them a role. > See [Roles and permissions](/security/for-admins/roles-and-permissions/) @@ -98,7 +96,7 @@ To invite multiple members to an organization via a CSV file containing email ad 7. Select **Browse files** and then select your CSV file, or drag and drop the CSV file into the **Select a CSV file to upload** box. You can only select one CSV file at a time. - > **Note** + > [!NOTE] > > If the amount of email addresses in your CSV file exceeds the number of available seats in your organization, you > cannot continue to invite members. To invite members, you can purchase more seats, or remove some email addresses from @@ -110,69 +108,21 @@ To invite multiple members to an organization via a CSV file containing email ad Valid email addresses and any email addresses that have issues appear. Email addresses may have the following issues: - - **Invalid email**: The email address is not a valid address. + - Invalid email: The email address is not a valid address. The email address will be ignored if you send invites. You can correct the email address in the CSV file and re-import the file. - - **Already invited**: The user has already been sent an invite email and another invite email will not be sent. - - **Member**: The user is already a member of your organization and an invite email will not be sent. - - **Duplicate**: The CSV file has multiple occurrences of the same email address. + - Already invited: The user has already been sent an invite email and another invite email will not be sent. + - Member: The user is already a member of your organization and an invite email will not be sent. + - Duplicate: The CSV file has multiple occurrences of the same email address. The user will be sent only one invite email. 9. Follow the on-screen instructions to invite members. - > **Note** + > [!NOTE] > > When you invite members, you assign them a role. > See [Roles and permissions](/security/for-admins/roles-and-permissions/) > for details about the access permissions for each role. Pending invitations appear in the table. The invitees receive an email with a link to Docker Hub where they can accept -or decline the invitation. - -## Resend invitations - -To resend an invitation if the invite is pending or declined: - -1. Sign in to {{ $product_link }}. -2. {{ $member_navigation }} -3. In the table, locate the invitee, select the **Action** icon, and then select **Resend invitation**. -4. Select **Invite** to confirm. - -## Remove a member or invitee - -To remove a member from an organization: - -1. Sign in to {{ $product_link }}. -2. {{ $member_navigation }} -3. In the table, select the **Action** icon, and then select {{ $remove_button }} or **Remove invitee**. -4. Follow the on-screen instructions to remove the member or invitee. - -## Update a member role - -Organization owners can manage [roles](/security/for-admins/roles-and-permissions/) -within an organization. If an organization is part of a company, -the company owner can also manage that organization's roles. If you have SSO enabled, you can use {{ $role_mapping_link }}. - -> **Note** -> -> If you're the only owner of an organization, -> you need to assign a new owner before you can edit your role. - -To update a member role: - -1. Sign in to {{ $product_link }}. -2. {{ $member_navigation }} -3. Find the username of the member whose role you want to edit. In the table, select the **Actions** icon. -4. Select **Edit role**. -5. {{ $update_role }} - -## Export members - -Owners can export a CSV file containing all members. -{{ $export_fields }} - -To export a CSV file of the members: - -1. Sign in to {{ $product_link }}. -2. {{ $member_navigation }} -3. Select {{ $export_button }}. +or decline the invitation. \ No newline at end of file From ef47714f0ef52e9bee6c1bf95edd76712fd3ee0d Mon Sep 17 00:00:00 2001 From: Sarah Sanders Date: Tue, 5 Nov 2024 13:32:09 -0800 Subject: [PATCH 2/6] Fix typos and links --- content/manuals/admin/organization/members.md | 59 +++++++++++++++---- 1 file changed, 49 insertions(+), 10 deletions(-) diff --git a/content/manuals/admin/organization/members.md b/content/manuals/admin/organization/members.md index 6500e6d3a0..56272b5aff 100644 --- a/content/manuals/admin/organization/members.md +++ b/content/manuals/admin/organization/members.md @@ -30,6 +30,7 @@ Learn how to manage members for your organization in Docker Hub and the Docker A When an invitation is to a user's email address, they receive a link to [Docker Hub](https://hub.docker.com/) where they can accept or decline the invitation. +To accept an invitation: 1. Navigate to your email inbox and open the Docker email with an invitation to join the Docker organization. @@ -50,25 +51,63 @@ After accepting an invitation, you are now a member of the organization. After inviting members, you can resend or remove invitations as needed. -### Resend invitations +### Resend an invitation -You may need to resend an invitation if an invitation is pending or was declined: +{{< tabs >}} +{{< tab name="Docker Hub" >}} -1. Sign in to Docker Hub. +To resend an invitation from Docker Hub: + +1. Sign in to [Docker Hub](https://hub.docker.com/). 2. Select **Organizations**, your organization, and then **Members**. 3. In the table, locate the invitee, select the **Actions** icon, and then select **Resend invitation**. 4. Select **Invite** to confirm. +{{< /tab >}} +{{< tab name="Admin Console" >}} + +{{< include "admin-early-access.md" >}} + +To resend an invitation from the Admin Console: + +1. Open the [Admin Console](https://app.docker.com/admin) and select your organization from +top-left drop-down menu. +2. Select **Members**. +3. Select the **action menu** next to the invitee and select **Resend invitation**. +4. Select **Invite** to confirm. + +{{< /tab >}} +{{< /tabs >}} + ### Remove an invitation -To remove a member's invitation from an organization: +{{< tabs >}} +{{< tab name="Docker Hub" >}} -1. Sign in to Docker Hub. +To remove a member's invitation from Docker Hub: + +1. Sign in to [Docker Hub](https://hub.docker.com/). 2. Select **Organizations**, your organization, and then **Members**. 3. In the table, select the **Action** icon, and then select **Remove member** or **Remove invitee**. 4. Follow the on-screen instructions to remove the member or invitee. +{{< /tab >}} +{{< tab name="Admin Console" >}} + +{{< include "admin-early-access.md" >}} + +To remove an invitation from the Admin Console: + +1. 1. Open the [Admin Console](https://app.docker.com/admin) and select your organization from +top-left drop-down menu. +2. Select **Members**. +3. Select the **action menu** next to the invitee and select **Remove invitee**. +4. Select **Remove** to confirm. + +{{< /tab >}} +{{< /tabs >}} + ## Manage members on a team Use Docker Hub or the Admin Console to add or remove team members. @@ -102,7 +141,7 @@ To add a member to a team: To add a member to a team: -1. In the Admin Console, select your organization. +1. In the [Admin Console](https://app.docker.com/admin), select your organization. 2. Select the team name. 3. Select **Add member**. You can add the member by searching for their email address or username. @@ -136,7 +175,7 @@ To remove a member from a specific team: To remove a member from a specific team: -1. In the Admin Console, select your organization. +1. In the [Admin Console](https://app.docker.com/admin), select your organization. 2. Select the team name. 3. Select the **X** next to the user's name to remove them from the team. 4. When prompted, select **Remove** to confirm. @@ -148,7 +187,7 @@ To remove a member from a specific team: Organization owners can manage [roles](/security/for-admins/roles-and-permissions/) within an organization. If an organization is part of a company, -the company owner can also manage that organization's roles. If you have SSO enabled, you can use {{ $role_mapping_link }}. +the company owner can also manage that organization's roles. If you have SSO enabled, you can use [SCIM for role mapping](/security/for-admins/provisioning/scim/). > [!NOTE] > @@ -157,7 +196,7 @@ the company owner can also manage that organization's roles. If you have SSO ena To update a member role: -1. Sign in to Docker Hub. +1. Sign in to [Docker Hub](https://hub.docker.com). 2. Select **Organizations**, your organization, and then **Members**. 3. Find the username of the member whose role you want to edit. In the table, select the **Actions** icon. 4. Select **Edit role**. @@ -174,6 +213,6 @@ Owners can export a CSV file containing all members. The CSV file for a company - Account Created: The time and date when the user account was created. To export a CSV file of the members: -1. Sign in to Docker Hub. +1. Sign in to [Docker Hub](https://hub.docker.com). 2. Select **Organizations**, your organization, and then **Members**. 3. Select the **Action** icon and then select **Export users as CSV**. \ No newline at end of file From b0169e08c3cd2c83cddd45579fbe61a8eeff70ed Mon Sep 17 00:00:00 2001 From: Sarah Sanders Date: Tue, 5 Nov 2024 14:50:12 -0800 Subject: [PATCH 3/6] Fix more typos/errors --- content/manuals/admin/organization/members.md | 28 ++++++++----------- 1 file changed, 12 insertions(+), 16 deletions(-) diff --git a/content/manuals/admin/organization/members.md b/content/manuals/admin/organization/members.md index 56272b5aff..a526dd4016 100644 --- a/content/manuals/admin/organization/members.md +++ b/content/manuals/admin/organization/members.md @@ -99,7 +99,7 @@ To remove a member's invitation from Docker Hub: To remove an invitation from the Admin Console: -1. 1. Open the [Admin Console](https://app.docker.com/admin) and select your organization from +1. Open the [Admin Console](https://app.docker.com/admin) and select your organization from top-left drop-down menu. 2. Select **Members**. 3. Select the **action menu** next to the invitee and select **Remove invitee**. @@ -110,16 +110,14 @@ top-left drop-down menu. ## Manage members on a team -Use Docker Hub or the Admin Console to add or remove team members. +Use Docker Hub or the Admin Console to add or remove team members. Organization owners can add a member to one or more teams within an organization. ### Add a member to a team -Organization owners can add a member to one or more teams within an organization. - {{< tabs >}} {{< tab name="Docker Hub" >}} -To add a member to a team: +To add a member to a team with Docker Hub: 1. Sign in to [Docker Hub](https://hub.docker.com). 2. Select **Organizations**, your organization, and then **Members**. @@ -139,7 +137,7 @@ To add a member to a team: {{< include "admin-early-access.md" >}} -To add a member to a team: +To add a member to a team with the Admin Console: 1. In the [Admin Console](https://app.docker.com/admin), select your organization. 2. Select the team name. @@ -159,9 +157,7 @@ Organization owners can remove a member from a team in Docker Hub or Admin Conso {{< tabs >}} {{< tab name="Docker Hub" >}} -To add a member to a team: - -To remove a member from a specific team: +To remove a member from a specific team with Docker Hub: 1. Sign in to [Docker Hub](https://hub.docker.com). 2. Select **Organizations**, your organization, **Teams**, and then the team. @@ -173,7 +169,7 @@ To remove a member from a specific team: {{< include "admin-early-access.md" >}} -To remove a member from a specific team: +To remove a member from a specific team with the Admin Console: 1. In the [Admin Console](https://app.docker.com/admin), select your organization. 2. Select the team name. @@ -205,12 +201,12 @@ To update a member role: ## Export members CSV file Owners can export a CSV file containing all members. The CSV file for a company contains the following fields: -- Name: The user's name. -- Username: The user's Docker ID. -- Email: The user's email address. -- Member of Organizations: All organizations the user is a member of within a company. -- Invited to Organizations: All organizations the user is an invitee of within a company. -- Account Created: The time and date when the user account was created. +- Name: The user's name +- Username: The user's Docker ID +- Email: The user's email address +- Member of Organizations: All organizations the user is a member of within a company +- Invited to Organizations: All organizations the user is an invitee of within a company +- Account Created: The time and date when the user account was created To export a CSV file of the members: 1. Sign in to [Docker Hub](https://hub.docker.com). From 6d31e076f1daad233983be404ea8614d82948a76 Mon Sep 17 00:00:00 2001 From: Sarah Sanders Date: Wed, 6 Nov 2024 14:38:53 -0800 Subject: [PATCH 4/6] Update content/manuals/admin/organization/members.md Co-authored-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- content/manuals/admin/organization/members.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/manuals/admin/organization/members.md b/content/manuals/admin/organization/members.md index a526dd4016..4baf5a7327 100644 --- a/content/manuals/admin/organization/members.md +++ b/content/manuals/admin/organization/members.md @@ -29,7 +29,7 @@ Learn how to manage members for your organization in Docker Hub and the Docker A ## Accept invitation When an invitation is to a user's email address, they receive -a link to [Docker Hub](https://hub.docker.com/) where they can accept or decline the invitation. +a link to Docker Hub where they can accept or decline the invitation. To accept an invitation: 1. Navigate to your email inbox and open the Docker email with an invitation to From 2f928a7cfc02798350ef090057b75a262fdffbe2 Mon Sep 17 00:00:00 2001 From: Sarah Sanders Date: Wed, 6 Nov 2024 14:47:20 -0800 Subject: [PATCH 5/6] Fix accept invite flow --- content/manuals/admin/organization/members.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/content/manuals/admin/organization/members.md b/content/manuals/admin/organization/members.md index 4baf5a7327..25d78ce890 100644 --- a/content/manuals/admin/organization/members.md +++ b/content/manuals/admin/organization/members.md @@ -41,9 +41,8 @@ address you received the invitation through. 4. Optional. If you do not have an account and created one, you must navigate back to your email inbox and verify your email address using the Docker verification email. -5. Once you are signed in to [Docker Hub](https://hub.docker.com/), under Docker Products, select the **Docker Hub** tab. -6. Select **Organizations** from the top-level navigation menu. -7. The organizations page will display your invitation. Select **Accept**. +5. Once you are signed in to Docker Hub, select **Organizations** from the top-level navigation menu. +6. The organizations page will display your invitation. Select **Accept**. After accepting an invitation, you are now a member of the organization. From a1f398e9deb14802a29d1f31771df42b76a02728 Mon Sep 17 00:00:00 2001 From: Sarah Sanders Date: Fri, 8 Nov 2024 07:57:01 -0800 Subject: [PATCH 6/6] Update admin-users.html --- layouts/shortcodes/admin-users.html | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/layouts/shortcodes/admin-users.html b/layouts/shortcodes/admin-users.html index 962be2405f..999d9286a9 100644 --- a/layouts/shortcodes/admin-users.html +++ b/layouts/shortcodes/admin-users.html @@ -3,7 +3,6 @@ {{ $member_navigation := "Select **Organizations**, your organization, and then **Members**." }} {{ $remove_button := "**Remove member**" }} {{ $product_link := "[Docker Hub](https://hub.docker.com)" }} -{{ $update_role := "Select the role you want to assign, then select **Save**." }} {{ $role_mapping_link := "[SCIM for role mapping](/security/for-admins/provisioning/scim/)" }} {{ $export_fields := `The CSV file for an organization contains the following fields: * **Name**: The user's name. @@ -32,7 +31,6 @@ * **Account Created**: The time and date when the user account was created.` }} {{ $member_navigation = "Select your company in the left navigation drop-down menu, and then select **Users**." }} {{ $remove_button = "**Remove user**" }} -Select their organization, select the role you want to assign, and then select **Save**.{{ $update_role = "" }} {{ $role_mapping_link = "[SCIM for role mapping](/security/for-admins/provisioning/scim/)"}} {{ end }} {{ end }} @@ -125,4 +123,4 @@ To invite multiple members to an organization via a CSV file containing email ad > for details about the access permissions for each role. Pending invitations appear in the table. The invitees receive an email with a link to Docker Hub where they can accept -or decline the invitation. \ No newline at end of file +or decline the invitation.