Skip to content

Commit

Permalink
Restructure administration docs IA (#18940)
Browse files Browse the repository at this point in the history
* cli: use the new add-host separator

Signed-off-by: David Karlsson <[email protected]>

* update organization admin sections

* update company sections and move faqs

* add create company steps and clean up overview

* update faq paths in tiles and add ea banner to admin tab

* fix spaces and update admin console references

* update banner message, clarify content, and streamline onboarding guide

---------

Signed-off-by: David Karlsson <[email protected]>
Co-authored-by: David Karlsson <[email protected]>
  • Loading branch information
stephaurelio and dvdksn authored Dec 19, 2023
1 parent 196b807 commit 482bcb4
Show file tree
Hide file tree
Showing 65 changed files with 401 additions and 348 deletions.
29 changes: 21 additions & 8 deletions content/admin/_index.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,35 @@
---
description: Docker Admin provides administrators with centralized observability,
access management, and controls for their company and organizations.
keywords: admin, administration, company, organization
title: Docker Admin overview
description: Discover manuals on administration for accounts, organizations, and companies.
keywords: admin, administration, company, organization, Admin Console, user accounts, account management
title: Administration overview
grid:
- title: Company administration
description: Explore how to manage a company in Docker Admin.
description: Explore how to manage a company.
icon: apartment
link: /admin/company/
- title: Organization administration
description: Learn about organization administration in Docker Admin.
description: Learn about organization administration.
icon: store
link: /admin/organization/
- title: Company FAQ
description: Discover common questions and answers about companies.
icon: help
link: /faq/admin/company-faqs/
- title: Organization FAQ
description: Explore popular FAQ topics about organizations.
icon: help
link: /faq/admin/organization-faqs/
- title: Security
description: Explore security features for administrators.
icon: shield_locked
link: /security/
aliases:
- /docker-hub/admin-overview
---

{{< include "admin-early-access.md" >}}
Administrators can manage companies and organizations using Docker Hub or the Docker Admin Console.

The [Docker Admin](https://admin.docker.com) console provides administrators with centralized observability, access management, and controls for their company and organizations. To provide these features, Docker uses the following hierarchy and roles.
The Docker Admin Console is available in [Early Access](../release-lifecycle.md#early-access-ea) to all company owners and organization owners that have a Docker Business or Docker Team subscription. The [Docker Admin Console](https://admin.docker.com) provides administrators with centralized observability, access management, and controls for their company and organizations. To provide these features, Docker uses the following hierarchy and roles.

![Docker hierarchy](./images/docker-admin-structure.webp)

Expand Down
17 changes: 9 additions & 8 deletions content/admin/company/_index.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
---
description: Learn about companies.
description: Learn about managing companies.
keywords: company, multiple organizations, manage companies
title: Overview
grid:
- title: Create a company
description: Get started by learning how to create a company.
icon: apartment
link: /admin/company/new-company/
- title: Manage organizations
description: Learn how to add and manage organizations as well as seats within your
company.
Expand Down Expand Up @@ -31,17 +35,14 @@ grid:
link: /admin/company/settings/domains/
- title: FAQs
description: Explore common company FAQs.
link: /docker-hub/company-faqs/
link: /faq/admin/company-faqs/
icon: help
aliases:
- /docker-hub/creating-companies/
---

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

{{< include "admin-company-overview.md" >}}

To create a company, see
[Create a company](../organization/general-settings.md#create-a-company).

Learn how to administer a company using Docker Admin in the following sections.
Learn how to administer a company in the following sections.

{{< grid >}}
61 changes: 61 additions & 0 deletions content/admin/company/new-company.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
title: Create a company
description: Learn how to create a company.
keywords: company, hub, organization, company owner, Admin Console, company management
---

You can create a new company in Docker Hub or Docker Admin Console. Before you begin, make sure you're the owner of the organization you want to add to the new company. The organization also needs to have a Docker Business subscription.

{{< tabs >}}

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

## Create a company

To create a new company:

1. In Docker Hub, navigate to the organization you want to place under a company. The organization must have a Business subscription, and you must be an owner of the organization.
2. Select **Settings**.
3. Near the bottom of the **General** tab, select **Create a company**.
4. Enter a unique name for your company, then select **Continue**.

> **Tip**
>
> The name for your company can't be the same as an existing user, organization, or company namespace.
{ .tip }

5. Review the company migration details and then select **Create company**.

{{< /tab >}}

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

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

## Create a company

To create a new company:

1. In the Admin Console, navigate to the organization you want to place under a company. The organization must have a Business subscription, and you must be an owner of the organization.
2. Under **Organization Settings**, select **General**.
3. In the **Organization management** section, select **Create a company**.
4. Enter a unique name for your company, then select **Continue**.

> **Tip**
>
> The name for your company can't be the same as an existing user, organization, or company namespace.
{ .tip }

5. Review the company migration details and then select **Create company**.

For more information on how you can add organizations to your company, see [Add organizations to a company](./organizations.md#add-organizations-to-a-company).

{{< /tab >}}

{{< /tabs >}}

## Next steps

- [Manage organizations](./organizations.md)
- [Manage company users](./users.md)
- [Manage company owners](./owners.md)
60 changes: 53 additions & 7 deletions content/admin/company/organizations.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,87 @@
---
description: Manage organizations for a company in Docker Admin.
description: Learn how to manage organization in a company.
keywords: company, multiple organizations, manage organizations
title: Manage organizations
---

You can manage the organizations in a company in Docker Hub and the Docker Admin Console. In Docker Hub, you can manage seats and members at the organization-level. When you use the Admin Console, you can do more to manage organizations at the company-level.

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

## View all organizations

1. In Docker Hub, select **Organizations**.
2. Select your company.
3. From the company page, you can view all organizations in the **Overview** tab.

## Add organizations to a company

>**Important**
>
> You must be a company owner to add an organization to a company. You must also be an organization owner of the organization you want to add.
{ .important }

There is no limit to the number of organizations you can have under a company layer. All organizations must have a Business subscription.

>**Important**
>
> Once you add an organization to a company, you can't remove it from the company.
{ .important }

1. In Docker Hub, select **Organizations**.
2. Select your company.
3. From the company page, select **Add organization**.
4. Choose the organization you want to add from the drop-down menu.
5. Select **Add organization** to confirm.

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

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

## View all organizations

1. Sign in to [Docker Admin](https://admin.docker.com).
1. Sign in to the [Admin Console](https://admin.docker.com).
2. In the left navigation, select your company in the drop-down menu.
3. Under **Organizations**, select **Overview**.

## Add seats to an organization

When you have a [self-serve](../../subscription/details.md#self-serve) subscription that has no pending subscription changes, you can add seats using the following steps.

1. Sign in to [Docker Admin](https://admin.docker.com).
1. Sign in to the [Admin Console](https://admin.docker.com).
2. In the left navigation, select your company in the drop-down menu.
3. Under **Organizations**, select **Overview**.
4. Select the action icon in the organization's card, and then select **Get more seats**.


## Add organizations to a company

>**Important**
>
> You must be a company owner to add an organization to a company. You must also be an organization owner of the organization you want to add.
{ .important }

There is no limit to the number of organizations you can have under a company layer. All organizations must have a Business subscription.

1. Sign in to [Docker Admin](https://admin.docker.com).
>**Important**
>
> Once you add an organization to a company, you can't remove it from the company.
{ .important }

1. Sign in to the [Admin Console](https://admin.docker.com).
2. In the left navigation, select your company in the drop-down menu.
3. Select **Add organization**.
4. Choose the organization you want to add from the drop-down menu.
5. Select **Add organization** to confirm.

## Manage an organization

1. Sign in to [Docker Admin](https://admin.docker.com).
1. Sign in to the [Admin Console](https://admin.docker.com).
2. In the left navigation, select your company in the drop-down menu.
3. Select the organization that you want to manage.

For more details about managing an organization, see [Organization administration](../organization/index.md).
For more details about managing an organization, see [Organization administration](../organization/index.md).
{{< /tab >}}

{{< /tabs >}}
37 changes: 32 additions & 5 deletions content/admin/company/owners.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,39 @@
description: Learn about company owners.
keywords: company, owners
title: Manage company owners
aliases:
- /docker-hub/company-owner/
---

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

As a company owner, you can configure [Single Sign-on (SSO)](../../security/for-admins/single-sign-on/_index.md) and [System for Cross-domain Identity Management (SCIM)](../../security/for-admins/scim.md) for all organizations under the company.

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

## Add a company owner

1. Sign in to [Docker Admin](https://admin.docker.com).
1. Sign in to [Docker Hub](https://hub.docker.com/), navigate to the **Organizations** page, and select your company.
2. In the **Overview** tab, select **Add owner** and enter their Docker ID or email address.
3. Once you've selected **Add Owner**, you can view the user in the **Company Owners** table.

![company-overview](../images/company-overview.png)

## Remove a company owner

1. Sign in to [Docker Hub](https://hub.docker.com/), navigate to the **Organizations** page, and select your company.
2. In the **Overview** tab, find the **Company Owner** you want to remove.
3. Select the **Action** icon and remove the owner.

![remove-owner](../images/remove-owner.png)

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

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

## Add a company owner

1. Sign in to the [Admin Console](https://admin.docker.com).
2. In the left navigation, select your company in the drop-down menu.
3. Select **Company Owners**.
4. Select **Add Owner**.
Expand All @@ -19,8 +43,11 @@ As a company owner, you can configure [Single Sign-on (SSO)](../../security/for-

## Remove a company owner

1. Sign in to [Docker Admin](https://admin.docker.com).
1. Sign in to the [Admin Console](https://admin.docker.com).
2. In the left navigation, select your company in the drop-down menu.
3. Select **Company Owners**.
4. Select the **Action** icon in the row of the company owner that your want to remove.
5. Select **Remove as Company Owner**.
5. Select **Remove as Company Owner**.

{{< /tab >}}
{{< /tabs >}}
8 changes: 5 additions & 3 deletions content/admin/company/users.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
---
description: Manage company users
keywords: company, company users, users, admin, docker admin
description: Learn how to manage company users in the Docker Admin Console.
keywords: company, company users, users, admin, Admin Console
title: Manage company users
---

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

You can manage users at the company-level in the Docker Admin Console.

{{% admin-users product="admin" layer="company" %}}

## Manage members on a team

Use Docker Hub to add a member to a team or remove a member from a team. For more details, see [Manage members in Docker Hub](../../docker-hub/members.md).
Use Docker Hub to add a member to a team or remove a member from a team. For more details, see [Manage members in Docker Hub](#).
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
description: Convert your Docker Hub user account into an organization
title: Convert an account into an organization
keywords: docker hub, hub, organization
aliases:
- /docker-hub/convert-account/
---

You can convert an existing user account to an organization. This is useful if you need multiple users to access your account and the repositories that it’s connected to. Converting it to an organization gives you better control over permissions for these users through [teams](manage-a-team.md) and [roles](roles-and-permissions.md).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@
title: Deactivating an account or an organization
description: Learn how to deactivate a Docker Hub account or an organization
keywords: Docker Hub, delete, deactivate, account, organization
aliases:
- /docker-hub/deactivate-account/
---

You can deactivate an account at any time.
Expand Down
File renamed without changes
File renamed without changes
8 changes: 3 additions & 5 deletions content/admin/organization/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,14 @@ grid:
icon: domain_verification
- title: FAQs
description: Explore common organization FAQs.
link: /docker-hub/organization-faqs/
link: /faq/admin/organization-faqs/
icon: help
---

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

{{< include "admin-org-overview.md" >}}

To create an organization, see [Create your organization](../../docker-hub/orgs.md).
To create an organization, see [Create your organization](../organization/orgs.md).

Learn how to administer an organization using Docker Admin in the following sections.
Learn how to administer an organization in the following sections.

{{< grid >}}
30 changes: 29 additions & 1 deletion content/admin/organization/activity-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,36 @@
description: Learn about activity logs.
keywords: team, organization, activity, log, audit, activities
title: Activity logs
aliases:
- /docker-hub/audit-log/
---

Activity logs display a chronological list of activities that occur at organization and repository levels. It provides a report to owners on all their member activities.

With activity logs, owners can view and track:
- What changes were made
- The date when a change was made
- Who initiated the change

For example, activity logs display activities such as the date when a repository was created or deleted, the member who created the repository, the name of the repository, and when there was a change to the privacy settings.

Owners can also see the activity logs for their repository if the repository is part of the organization subscribed to a Docker Business or Team plan.

> **Note**
>
> Activity logs requires a [Docker Team or Business subscription](../../subscription/_index.md).
{{< tabs >}}
{{< tab name="Docker Hub" >}}

{{% admin-org-audit-log product="hub" %}}

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

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

{{% admin-org-audit-log product="admin" %}}
{{% admin-org-audit-log product="admin" %}}

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

0 comments on commit 482bcb4

Please sign in to comment.