Skip to content

Commit

Permalink
docs freshness: updates for organization section (#21630)
Browse files Browse the repository at this point in the history
## Description
- Docs freshness updates:
    - Style guide updates/consistency
- Improved UI flow steps, some did not link to DH or Admin Console, and
were vague
    - Added Admin Console steps where missing
    - Fixed a few incorrect UI flows
- ENGDOCS-2357 updates: Updated Insights DD table for new fields

## Related issues or tickets
- [ENGDOCS-2348](https://docker.atlassian.net/browse/ENGDOCS-2348)
- [ENGDOCS-2357](https://docker.atlassian.net/browse/ENGDOCS-2357)

## Reviews
- [ ] Editorial review

[ENGDOCS-2348]:
https://docker.atlassian.net/browse/ENGDOCS-2348?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ
[ENGDOCS-2357]:
https://docker.atlassian.net/browse/ENGDOCS-2357?atlOrigin=eyJpIjoiNWRkNTljNzYxNjVmNDY3MDlhMDU5Y2ZhYzA5YTRkZjUiLCJwIjoiZ2l0aHViLWNvbS1KU1cifQ

---------

Co-authored-by: David Karlsson <[email protected]>
  • Loading branch information
sarahsanders-docker and dvdksn authored Dec 16, 2024
1 parent bd7617d commit de764a8
Show file tree
Hide file tree
Showing 7 changed files with 174 additions and 93 deletions.
Binary file not shown.
2 changes: 1 addition & 1 deletion content/manuals/admin/organization/general-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This section describes how to manage organization settings in the Docker Admin C

## Configure general information

General organization information appears on your organization landing page in Docker Hub.
General organization information appears on your organization landing page in the Admin Console.

This information includes:
- Organization Name
Expand Down
34 changes: 18 additions & 16 deletions content/manuals/admin/organization/insights.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,36 +15,39 @@ productivity and efficiency across the organization.

Key benefits include:

* Uniform working environment. Establish and maintain standardized
- Uniform working environment. Establish and maintain standardized
configurations across teams.
* Best practices. Promote and enforce usage guidelines to ensure optimal
- Best practices. Promote and enforce usage guidelines to ensure optimal
performance.
* Increased visibility. Monitor and drive adoption of organizational
- Increased visibility. Monitor and drive adoption of organizational
configurations and policies.
* Optimized license use. Ensure that developers have access to advanced
- Optimized license use. Ensure that developers have access to advanced
features provided by a Docker subscription.

## View Insights for organization users

{{< include "admin-early-access.md" >}}

1. Go to the [Admin Console](https://app.docker.com/admin/) and sign in to an
account that is an organization owner.
2. Select your company on the **Choose profile** page.
3. Select **Insights**.
4. On the **Insights** page, select the period of time for the data.

> [!NOTE]
>
> Insights data is not real-time and is updated daily. At the top-right of the
> Insights page, view the **Last updated** date to understand when the data was
> last updated.
You can view data in the following charts:

* [Docker Desktop users](#docker-desktop-users)
* [Builds](#builds)
* [Containers](#containers)
* [Docker Desktop usage](#docker-desktop-usage)
* [Docker Hub images](#docker-hub-images)
* [Extensions](#extensions)
- [Docker Desktop users](#docker-desktop-users)
- [Builds](#builds)
- [Containers](#containers)
- [Docker Desktop usage](#docker-desktop-usage)
- [Docker Hub images](#docker-hub-images)
- [Extensions](#extensions)

### Docker Desktop users

Expand All @@ -56,13 +59,12 @@ counts.

The chart contains the following data.

| Data | Description |
| Data | Description |
|:-----------------------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| Total active users | The number of users that have actively used Docker Desktop and either signed in with a Docker account that has a license in your organization or signed in to a Docker account with an email address from a domain associated with your organization. <br><br>Users who don’t sign in to an account associated with your organization are not represented in the data. To ensure users sign in with an account associated with your organization, you can [enforce sign-in](/security/for-admins/enforce-sign-in/). |
| Active with license | The number of users that have actively used Docker Desktop and have signed in to a Docker account with a license in your organization. |
| Active without license | The number of users that have actively used Docker Desktop, are linked to a Docker account with an email address from a domain associated with your organization, and don’t have a license assigned to their account. <br><br>Users without a license don’t receive the benefits of your subscription. You can use [domain audit](/security/for-admins/domain-audit/) to identify users without a license. You can also use [Just-in-Time provisioning](/security/for-admins/provisioning/just-in-time/) or [SCIM](/security/for-admins/provisioning/scim/) to help automatically provision users with a license. Note that when SSO is configured and enforced, active without license will be 0. |
| Users opted out of analytics | The number of users that are a member of your organization that have opted out of sending analytics. <br><br>When users opt out of sending analytics, you won't see any of their data in Insights. To ensure that the data includes all users, you can use [Settings Management](/desktop/hardened-desktop/settings-management/) to set `analyticsEnabled` for all your users. |
| Active users (graph) | The view over time for total active users. |
| Active user | The number of users that have actively used Docker Desktop and either signed in with a Docker account that has a license in your organization or signed in to a Docker account with an email address from a domain associated with your organization. <br><br>Users who don’t sign in to an account associated with your organization are not represented in the data. To ensure users sign in with an account associated with your organization, you can [enforce sign-in](/security/for-admins/enforce-sign-in/). |
| Total organization members | The number of users that have used Docker Desktop, regardless of their Insights activity. |
| Users opted out of analytics | The number of users that are a member of your organization that have opted out of sending analytics. <br><br>When users opt out of sending analytics, you won't see any of their data in Insights. To ensure that the data includes all users, you can use [Settings Management](/desktop/hardened-desktop/settings-management/) to set `analyticsEnabled` for all your users. |
| Active users (graph) | The view over time for total active users. |


### Builds
Expand Down
67 changes: 34 additions & 33 deletions content/manuals/admin/organization/manage-a-team.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,37 +10,36 @@ aliases:

You can create teams for your organization in Docker Hub and the Docker Admin Console. You can [configure repository access for a team](#configure-repository-permissions-for-a-team) in Docker Hub.

A team is a group of Docker users that belong to an organization. An
organization can have multiple teams. An
organization owner can then create new teams and add members to an existing team
using their Docker ID or email address and by selecting a team the user should be part of. Members aren't required to be part of a team to be associated with an organization.
A team is a group of Docker users that belong to an organization. An organization can have multiple teams. An organization owner can then create new teams and add members to an existing team using their Docker ID or email address and by selecting a team the user should be part of. Members aren't required to be part of a team to be associated with an organization.

The organization owner can add additional organization owners to help them manage users, teams, and repositories in the organization by assigning them the owner role.

## Organization owner

An organization owner is an administrator who is responsible to manage
repositories and add team members to the organization. They have full access to
private repositories, all teams, billing information, and org settings. An org
owner can also specify [permissions](#permissions-reference) for each team in
the organization. Only an org owner can enable [SSO](../../security/for-admins/single-sign-on/_index.md)
for
the organization. When SSO is enabled for your organization, the org owner can
An organization owner is an administrator who has the following permissions:

- Manage repositories and add team members to the organization.
- Access private repositories, all teams, billing information, and organization settings.
- Specify [permissions](#permissions-reference) for each team in the organization.
- Enable [SSO](../../security/for-admins/single-sign-on/_index.md) for the organization.

When SSO is enabled for your organization, the organization owner can
also manage users. Docker can auto-provision Docker IDs for new end-users or
users who'd like to have a separate Docker ID for company use through SSO
enforcement.

The org owner can also add additional org owners to help them manage users, teams, and repositories in the organization.
The organization owner can also add additional organization owners to help them manage users, teams, and repositories in the organization.

## Create a team

{{< tabs >}}
{{< tab name="Docker Hub" >}}

1. Go to **Organizations** in Docker Hub, and select your organization.
2. Select the **Teams** tab and then select **Create Team**.
3. Fill out your team's information and select **Create**.
4. [Add members to your team](members.md#add-a-member-to-a-team).
1. Sign in to [Docker Hub](https://hub.docker.com).
2. Select **Organizations** and choose your organization.
3. Select the **Teams** tab and then select **Create Team**.
4. Fill out your team's information and select **Create**.
5. [Add members to your team](members.md#add-a-member-to-a-team).

{{< /tab >}}
{{< tab name="Admin Console" >}}
Expand All @@ -61,19 +60,18 @@ The org owner can also add additional org owners to help them manage users, team
Organization owners can configure repository permissions on a per-team basis.
For example, you can specify that all teams within an organization have "Read and
Write" access to repositories A and B, whereas only specific teams have "Admin"
access. Note that org owners have full administrative access to all repositories within the organization.
access. Note that organization owners have full administrative access to all repositories within the organization.

To give a team access to a repository
To give a team access to a repository:

1. Navigate to **Organizations** in Docker Hub, and select your organization.
2. Select the **Teams** tab and select the team that you'd like to configure repository access to.
3. Select the **Permissions** tab and select a repository from the
1. Sign in to [Docker Hub](https://hub.docker.com).
2. Select **Organizations** and choose your organization.
3. Select the **Teams** tab and select the team that you'd like to configure repository access to.
4. Select the **Permissions** tab and select a repository from the
**Repository** drop-down.
4. Choose a permission from the **Permissions** drop-down list and select
5. Choose a permission from the **Permissions** drop-down list and select
**Add**.

![Team Repo Permissions](../images/team-repo-permission.png)

Organization owners can also assign members the editor role to grant partial administrative access. See [Roles and permissions](../../security/for-admins/roles-and-permissions.md) for more about the editor role.

### Permissions reference
Expand Down Expand Up @@ -110,8 +108,10 @@ you automatically have "Read-only" permissions:

To view a team's permissions across all repositories:

1. Open **Organizations** > **_Your Organization_** > **Teams** > **_Team Name_**.
2. Select the **Permissions** tab, where you can view the repositories this team can access.
1. Sign in to [Docker Hub](https://hub.docker.com).
2. Select **Organizations** and choose your organization.
3. Select **Teams** and choose your team name.
4. Select the **Permissions** tab, where you can view the repositories this team can access.

## Delete a team

Expand All @@ -120,19 +120,20 @@ Organization owners can delete a team in Docker Hub or Admin Console. When you r
{{< tabs >}}
{{< tab name="Docker Hub" >}}

1. Go to **Organizations** in Docker Hub, and select your organization.
2. Select the **Teams** tab.
3. Select the name of the team that you want to delete.
4. Select **Settings**.
5. Select **Delete Team**.
6. Review the confirmation message, then select **Delete**.
1. Sign in to [Docker Hub](https://hub.docker.com).
2. Select **Organizations** and choose your organization.
3. Select the **Teams** tab.
4. Select the name of the team that you want to delete.
5. Select **Settings**.
6. Select **Delete Team**.
7. Review the confirmation message, then select **Delete**.

{{< /tab >}}
{{< tab name="Admin Console" >}}

{{< include "admin-early-access.md" >}}

1. In Admin Console, select your organization.
1. In the [Admin Console](https://app.docker.com/admin), select your organization.
2. In the **User management** section, select **Teams**.
3. Select the **Actions** icon next to the name of the team you want to delete.
4. Select **Delete team**.
Expand Down
22 changes: 20 additions & 2 deletions content/manuals/admin/organization/members.md
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,25 @@ Owners can export a CSV file containing all members. The CSV file for 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:
{{< tabs >}}
{{< tab name="Docker Hub" >}}

To export a CSV file of your members:

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**.
3. Select the **Action** icon and then select **Export users as CSV**.

{{< /tab >}}
{{< tab name="Admin Console" >}}

{{< include "admin-early-access.md" >}}

To export a CSV file of your members:

1. In the [Admin Console](https://app.docker.com/admin), select your organization.
2. Select **Members**.
3. Select the **download** icon to export a CSV file of all members.

{{< /tab >}}
{{< /tabs >}}
Loading

0 comments on commit de764a8

Please sign in to comment.