Skip to content
Draft
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
64 changes: 50 additions & 14 deletions COMPONENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -292,23 +292,31 @@ empty string default.

### Summary bars

Summary bars indicate subscription requirements, version requirements, or
administrator-only features at the top of a page.
Summary bars indicate the account type, subscription, purchase path, version
requirements, the role or permission a task needs, or the feature's
availability at the top of a page.

**Example:**

{{< summary-bar feature_name="Docker Scout" >}}

**Setup:**

1. Add feature to `/data/summary.yaml`:
1. Add feature to `/data/summary.yaml`. The file is a flat map keyed by
feature name, and `subscription` is a list:

```yaml
features:
Docker Scout:
subscription: Business
availability: GA
requires: "Docker Desktop 4.17 or later"
Docker Scout:
subscription: [Pro, Team, Business]
availability: GA
requires: "Docker Desktop 4.17 or later"
Activity logs:
subscription: [Team, Business]
role: Owner
permission: View activity logs
Gordon plans:
account: Individual
purchase: Self-serve
```
2. Add shortcode to page:
Expand All @@ -319,12 +327,40 @@ features:

**Attributes in summary.yaml:**

| Attribute | Description | Values |
| ------------ | ------------------------------------- | ------------------------------------------------- |
| subscription | Subscription tier required | All, Personal, Pro, Team, Business |
| availability | Product development stage | Experimental, Beta, Early Access, GA, Retired |
| requires | Minimum version requirement | String describing version (link to release notes) |
| for | Audience for the feature | Administrators, Individuals |
| Attribute | Description | Values |
| ------------ | ------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| account | Account the plan or setting belongs to | Individual, Organization |
| subscription | Subscription tiers required (list). Use `Available to all organization accounts` when the task is not limited to a plan. Set it only when the page is gated to those tiers. The bar displays Personal, Pro, Team, and Business as Docker Personal, Docker Pro, Docker Team, and Docker Business to match the [pricing page](https://www.docker.com/pricing/). | Personal, Pro, Team, Business, AI Governance, Docker Offload, Available to all organization accounts, and the Docker Hardened Images tiers |
| purchase | How you buy the plan | Self-serve, Sales-led |
| role | Core role that has the task | Owner, Editor, Company owner |
| permission | Custom role permission that grants the same task. Must match an exact name from the permissions reference. | An exact permission name from `content/manuals/security/roles-and-permissions/custom-roles/permissions-reference.md` |
| availability | Product development stage | Experimental, Beta, Early Access, GA, Retired |
| requires | Minimum version or other prerequisite | String describing the requirement (link to release notes) |
| for | Audience for the feature | Administrators, Individuals. Prefer `role` and `permission` for new records; `for` remains for records that still set it |

Role and permission render as separate lines. The **Core role** and
**Custom role permission** labels (without the colon) link to the
[core roles](/manuals/security/roles-and-permissions/core-roles.md) and
[custom roles](/manuals/security/roles-and-permissions/custom-roles/_index.md)

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Suggest we point to Custom role permissions reference page here instead of the Custom roles index page to allow users to view the permissions in the table.

overview pages. The core role is the built-in role that already includes the
task. The permission name appears as plain text after the label, followed by a
key icon. A custom role on a Docker Business subscription can grant that
permission to a member. A record with only a role shows the core role line.

**Page override:**

When several pages share one record but each page is gated by a different
permission, pass `permission` on the shortcode. The page value replaces the
record value for that page only:

```markdown
{{</* summary-bar feature_name="Admin orgs" permission="Manage teams" */>}}
```

The build fails when `permission`, on the record or on the page, is not an
exact name from the permissions reference, the same way it fails for an
unknown `feature_name`. A page can't override `subscription` or `role`;
passing either on the shortcode fails the build. Change the record instead.

### Buttons

Expand Down
7 changes: 0 additions & 7 deletions content/manuals/accounts/company/new-company.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,6 @@ aliases:
Learn how to create a new company in Docker Home, a centralized
dashboard for managing organizations.

## Prerequisites

Before you begin, you must:

- Be the owner of the organization you want to add to your company
- Have a Docker Business subscription

## Create a company

To create a new company:
Expand Down
3 changes: 0 additions & 3 deletions content/manuals/accounts/organization/activity-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,6 @@ Activity logs show a chronological list of organization and repository
changes in Docker Home. Use them to see what changed, when it changed, and who
made the change.

Organization owners and members with a custom role that includes the
**View activity logs** permission can open the activity log.

> [!TIP]
>
> Use activity logs for an admin audit trail of your organization and
Expand Down
1 change: 0 additions & 1 deletion content/manuals/accounts/organization/insights.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ use.

To use Insights, you must meet the following requirements:

- A Docker Business subscription
- Administrators must
[enforce sign-in](/manuals/desktop/enterprise/enforce-sign-in/_index.md)
for users
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ aliases:
- /accounts/organization/setup/general-settings/
---

{{< summary-bar feature_name="Organization information" >}}

Learn how to update your organization information.

## Update organization information
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ aliases:
- /admin/organization/manage-a-team/
---

{{< summary-bar feature_name="Admin orgs" >}}
{{< summary-bar feature_name="Admin orgs" permission="Manage teams" >}}

You can create teams for your organization in Docker Home or Docker Hub,
and configure team repository access in Docker Hub.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,10 @@ aliases:
- /admin/organization/manage/manage-licenses/
---

Licenses control which organization members can use supported Docker products.
As an organization owner, you manage license availability for your
organization.
{{< summary-bar feature_name="Licenses" >}}

Licenses control which organization members can use supported Docker
products. You manage license availability for your organization.

> [!TIP]
> To learn more about product licenses, Docker Team and Business seats, and
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ aliases:
- /admin/organization/manage-products/
---

{{< summary-bar feature_name="Admin orgs" >}}
{{< summary-bar feature_name="Admin orgs" permission="Manage Desktop settings" >}}

Use this page to learn how to control and monitor product access and usage
for your organization's members. If you're looking for setup and
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ aliases:
weight: 50
---

{{< summary-bar feature_name="Admin orgs" permission="Manage billing" >}}

You can add or remove seats from your Docker Team or Business subscription at any time to accommodate team changes. When you add seats mid-billing cycle, you're charged a prorated amount for the additional seats.

> [!IMPORTANT]
Expand Down
2 changes: 2 additions & 0 deletions content/manuals/accounts/organization/manage/members.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ aliases:
- /admin/organization/members/
---

{{< summary-bar feature_name="Admin orgs" permission="Member management" >}}

Invite and manage members for your organization in Docker Home.

## Invite members
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ aliases:
toc_max: 3
---

{{< summary-bar feature_name="Admin orgs" >}}
{{< summary-bar feature_name="Create organization" >}}

When you convert, your
[Docker ID](/manuals/accounts/_index.md) becomes an organization instead of
Expand Down
6 changes: 2 additions & 4 deletions content/manuals/accounts/organization/setup/onboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,11 +38,9 @@ pull limits and other benefits when they are signed in.

## Prerequisites

Before you onboard your organization, you need a Docker Team or Business
subscription. For details, see
[Docker subscriptions and features](https://www.docker.com/pricing?ref=Docs&refAction=DocsAdminOnboard).
When you buy a self-serve subscription, the on-screen instructions guide
you through creating an organization.
you through creating an organization. For plan details, see
[Docker subscriptions and features](https://www.docker.com/pricing?ref=Docs&refAction=DocsAdminOnboard).

If you bought a subscription through Docker Sales and you haven't created
an organization yet, see
Expand Down
2 changes: 1 addition & 1 deletion content/manuals/accounts/organization/setup/orgs.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ aliases:
- /admin/organization/orgs/
---

{{< summary-bar feature_name="Admin orgs" >}}
{{< summary-bar feature_name="Create organization" >}}

Create an organization to group members and teams under one namespace and
one subscription. Your Docker ID stays an individual account. To use an
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ working when people join or leave the organization.

Unlike a personal access token (PAT), an OAT belongs to the
organization. Any organization owner can see, edit, deactivate, or
delete it. Each token has its own scopes, so it can only reach the
delete it. A company owner can do the same for organizations in the
company. Each token has its own scopes, so it can only reach the
repositories and organization settings you choose.

> [!WARNING]
Expand All @@ -42,17 +43,6 @@ repositories and organization settings you choose.
- Deactivate or delete a token as soon as it's compromised or no longer
needed

## Prerequisites

To create and manage OATs, you need:

- A Docker Team or Docker Business subscription
- One of these roles in the organization:
- Organization owner
- Company owner, for organizations that belong to a company
- A [custom role](/manuals/security/roles-and-permissions/custom-roles/permissions-reference.md)
that includes the **Manage organization access tokens** permission

## Create an organization access token

> [!IMPORTANT]
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,7 @@ changing your password. From Docker Home, you can view the token list,
which shows when each token was last used.

Treat PATs like passwords and keep them secure. Store tokens in a
credential manager and never commit them to source code. Before you
create a PAT, you must verify your email address.
credential manager and never commit them to source code.

> [!TIP]
>
Expand Down
1 change: 0 additions & 1 deletion content/manuals/security/authentication/2fa/manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ Before you turn on 2FA, you need:
- A time-based one-time password (TOTP) authenticator app on your phone or
another device
- Your Docker account password
- A verified email address on your account

## Enable two-factor authentication

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ aliases:

{{< summary-bar feature_name="OIDC connections" >}}

Organization owners and editors create and manage OIDC connections from
**OIDC connections** in Docker Home. After you create a connection,
Create and manage OIDC connections from **OIDC connections** in Docker
Home. After you create a connection,
configure your GitHub Actions workflow so it can sign in to Docker Hub
with a short-lived token.

Expand Down
2 changes: 2 additions & 0 deletions content/manuals/security/provisioning/auto-provisioning.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ aliases:
- /enterprise/security/provisioning/auto-provisioning/
---

{{< summary-bar feature_name="Domain management" >}}

Auto-provisioning automatically adds users to your organization when they
sign in with email addresses that match your verified domains. You must verify
a domain before enabling auto-provisioning.
Expand Down
2 changes: 1 addition & 1 deletion content/manuals/security/provisioning/scim/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ account lifecycle.
Before you begin, you must have:

- SSO configured for your organization
- Administrator access to Docker Home and your identity provider
- Administrator access to your identity provider

## How SCIM works

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ Use group mapping to manage team membership through SAML SSO, SCIM, or both.
Before you begin, you must have:

- SSO configured for your organization
- Administrator access to Docker Home and your identity provider
- Administrator access to your identity provider

## How group mapping works

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,6 @@ If Docker's predefined permission sets meet your needs, use
[core roles](/manuals/security/roles-and-permissions/_index.md)
instead.

## Prerequisites

- A Docker Business subscription
- Owner permissions in your Docker organization

## Creating custom roles

To create a custom role, you select permissions from organization management,
Expand Down
2 changes: 2 additions & 0 deletions content/manuals/subscription-billing/manage/details.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ aliases:
- /billing/cycle/
---

{{< summary-bar feature_name="Billing" >}}

You can update your billing contact information, address, and notification email at any time. Existing invoices, whether paid or unpaid, cannot be updated. Changes only apply to future invoices.

## Update billing details
Expand Down
2 changes: 2 additions & 0 deletions content/manuals/subscription-billing/manage/history.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ aliases:
- /billing/core-billing/history/
---

{{< summary-bar feature_name="Billing" permission="View billing" >}}

Docker issues an invoice each time a subscription to a Docker plan renews or changes. You can track invoices issued to your account so you can review the plans you've
subscribed to over time, check payment status, and download records as
needed.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ aliases:
- /billing/core-billing/payment-method/
---

{{< summary-bar feature_name="Billing" >}}

Docker supports several payment methods for paid individual accounts and
organizations. This page describes supported payment types, how to manage
payments from [Docker Home](https://app.docker.com/), and how to set up pay
Expand Down
2 changes: 2 additions & 0 deletions content/manuals/subscription-billing/manage/plans.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ aliases:
- /billing/subscription-management/
---

{{< summary-bar feature_name="Billing" >}}

You can add and manage your plans from the billing portal in Docker Home. Within the billing portal, you use the product catalog to view
self-serve Docker products, while the Overview page shows your active plans with options to upgrade or cancel.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ aliases:
- /billing/tax-certificate/
---

{{< summary-bar feature_name="Billing" >}}

Depending on your location, Docker may collect sales tax or VAT on your
subscription. Tax relief is the same idea in both cases, but the process
differs:
Expand Down
2 changes: 2 additions & 0 deletions content/manuals/subscription-billing/plans/ai-governance.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ aliases:
- /subscription/ai-governance/
---

{{< summary-bar feature_name="AI Governance plan" >}}

> [!TIP]
> To subscribe to AI Governance, <a href="https://www.docker.com/pricing/contact-sales/" id="dkr_docs_cs_plans_aigov" class="link" rel="noopener">contact sales</a>.

Expand Down
2 changes: 2 additions & 0 deletions content/manuals/subscription-billing/plans/dhi.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ aliases:
- /subscription/plans/dhi-select/
---

{{< summary-bar feature_name="DHI plans" >}}

[Docker Hardened Images (DHI)](/manuals/dhi/_index.md) are secure, minimal, production-ready container images maintained by Docker.

- DHI Community is free and available to every developer.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,7 @@ aliases:
- /subscription/plans/docker-agentic-platform/
---

> [!TIP]
> Docker Agentic Platform signups receive a one-time promotional
> credit toward cloud compute usage. To review your balance, see
> [Credits](/manuals/subscription-billing/manage/_index.md#credits).
{{< summary-bar feature_name="Docker Agentic Platform" >}}

[Docker Agentic Platform](https://agentic-platform.docker.com/) is a
pay-as-you-go plan for running agent and tool workloads in isolated
Expand All @@ -27,6 +24,12 @@ subscription fee.
To activate access for the Console, cloud sandbox CLI, or API and SDKs, follow
[Signup and billing](/manuals/agentic-platform/signup.md#activate-cloud-access).

> [!TIP]
>
> Docker Agentic Platform signups receive a one-time promotional
> credit toward cloud compute usage. To review your balance, see
> [Credits](/manuals/subscription-billing/manage/_index.md#credits).

## Usage

> [!NOTE]
Expand Down
Loading
Loading