Skip to content

Commit

Permalink
implement summary bars for feature attributes (#21667)
Browse files Browse the repository at this point in the history
  • Loading branch information
sarahsanders-docker authored Jan 21, 2025
1 parent cd6b6e6 commit 3de8201
Show file tree
Hide file tree
Showing 76 changed files with 334 additions and 163 deletions.
2 changes: 2 additions & 0 deletions content/manuals/admin/company/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@ aliases:
- /docker-hub/creating-companies/
---

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

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

Learn how to administer a company in the following sections.
Expand Down
2 changes: 2 additions & 0 deletions content/manuals/admin/company/new-company.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ aliases:
- /docker-hub/new-company/
---

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

You can create a new company in the Docker Admin Console. Before you begin, you must:
- Be the owner of the organization you want to add to your company
- Have a Docker Business subscription
Expand Down
2 changes: 2 additions & 0 deletions content/manuals/admin/company/organizations.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ keywords: company, multiple organizations, manage organizations
title: Manage company organizations
---

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

You can manage the organizations in a company in the Docker Admin Console.

{{< include "admin-early-access.md" >}}
Expand Down
2 changes: 2 additions & 0 deletions content/manuals/admin/company/owners.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ aliases:
- /docker-hub/company-owner/
---

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

A company can have multiple owners. Company owners have company-wide
observability and can manage company-wide settings that apply to all associated
organizations. In addition, company owners have the same access as organization
Expand Down
2 changes: 2 additions & 0 deletions content/manuals/admin/company/users.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ keywords: company, company users, users, admin, Admin Console
title: Manage company users
---

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

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

{{% admin-users product="admin" layer="company" %}}
Expand Down
2 changes: 2 additions & 0 deletions content/manuals/admin/deactivate-account.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ aliases:
- /docker-hub/deactivate-account/
---

{{< summary-bar feature_name="General admin" >}}

You can deactivate an account at any time. This section describes the prerequisites and steps to deactivate an organization account. For information on deactivating a user account, see [Deactivate a user account](../accounts/deactivate-user-account.md).

> [!WARNING]
Expand Down
6 changes: 2 additions & 4 deletions content/manuals/admin/organization/activity-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ aliases:
- /docker-hub/audit-log/
---

{{< summary-bar feature_name="Activity logs" >}}

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:
Expand All @@ -18,10 +20,6 @@ For example, activity logs display activities such as the date when a repository

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](/manuals/subscription/_index.md).
## Manage activity logs

{{< tabs >}}
Expand Down
2 changes: 2 additions & 0 deletions content/manuals/admin/organization/convert-account.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ aliases:
- /docker-hub/convert-account/
---

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

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).

When you convert a user account to an organization, the account is migrated to a Docker Team plan.
Expand Down
10 changes: 7 additions & 3 deletions content/manuals/admin/organization/insights.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@ keywords: organization, insights
title: Insights
---

> [!NOTE]
>
> Insights requires a [Docker Business subscription](../../subscription/details.md#docker-business) and administrators must [enforce sign-in](/security/for-admins/enforce-sign-in/). This ensures users sign in with an account associated with their organization.
{{< summary-bar feature_name="Insights" >}}

Insights helps administrators visualize and understand how Docker is used within
their organizations. With Insights, administrators can ensure their teams are
Expand All @@ -24,6 +22,12 @@ Key benefits include:
- Optimized license use. Ensure that developers have access to advanced
features provided by a Docker subscription.

## Prerequisites

- [Docker Business subscription](../../subscription/details.md#docker-business)
- Administrators must [enforce sign-in](/security/for-admins/enforce-sign-in/) for users
- Insights enabled by your Customer Success Manager

## View Insights for organization users

{{< include "admin-early-access.md" >}}
Expand Down
2 changes: 2 additions & 0 deletions content/manuals/admin/organization/manage-a-team.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ aliases:
- /docker-hub/manage-a-team/
---

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

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.
Expand Down
2 changes: 2 additions & 0 deletions content/manuals/admin/organization/manage-products.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ description: Learn how to manage Docker products for your organization
keywords: organization, tools, products
---

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

In this section, learn how to manage access and view usage of the Docker
products for your organization. For more detailed information about each
product, including how to set up and configure them, see the following manuals:
Expand Down
2 changes: 2 additions & 0 deletions content/manuals/admin/organization/members.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,6 +197,8 @@ To update a member role:

## Export members CSV file

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

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
Expand Down
2 changes: 2 additions & 0 deletions content/manuals/admin/organization/onboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ aliases:
- /docker-hub/onboard-business/
---

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

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

Learn how to onboard your organization using Docker Hub or the Docker Admin Console.
Expand Down
2 changes: 2 additions & 0 deletions content/manuals/admin/organization/orgs.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ aliases:
- /docker-hub/orgs/
---

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

This section describes how to create an organization. Before you begin:

- You need a [Docker ID](/accounts/create-account/)
Expand Down
2 changes: 2 additions & 0 deletions content/manuals/build-cloud/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,8 @@ aliases:
- /build/cloud/
---

{{< summary-bar feature_name="Docker Build Cloud" >}}

Docker Build Cloud is a service that lets you build your container images
faster, both locally and in CI. Builds run on cloud infrastructure optimally
dimensioned for your workloads, no configuration required. The service uses a
Expand Down
2 changes: 2 additions & 0 deletions content/manuals/build/bake/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ aliases:
- /build/customize/bake/
---

{{< summary-bar feature_name="Build bake" >}}

Bake is a feature of Docker Buildx that lets you define your build configuration
using a declarative file, as opposed to specifying a complex CLI expression. It
also lets you run multiple builds concurrently with a single invocation.
Expand Down
5 changes: 1 addition & 4 deletions content/manuals/build/cache/backends/azblob.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,7 @@ aliases:
- /build/building/cache/backends/azblob/
---

{{% experimental %}}
This is an experimental feature. The interface and behavior are unstable and
may change in future releases.
{{% /experimental %}}
{{< summary-bar feature_name="Azure blob" >}}

The `azblob` cache store uploads your resulting build cache to
[Azure's blob storage service](https://azure.microsoft.com/en-us/services/storage/blobs/).
Expand Down
5 changes: 1 addition & 4 deletions content/manuals/build/cache/backends/gha.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,7 @@ aliases:
- /build/building/cache/backends/gha/
---

{{% restricted %}}
This is an experimental feature. The interface and behavior are unstable and
may change in future releases.
{{% /restricted %}}
{{< summary-bar feature_name="GitHub Actions cache" >}}

The GitHub Actions cache utilizes the
[GitHub-provided Action's cache](https://github.com/actions/cache) or other
Expand Down
5 changes: 1 addition & 4 deletions content/manuals/build/cache/backends/s3.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,7 @@ aliases:
- /build/building/cache/backends/s3/
---

{{% restricted %}}
This is an experimental feature. The interface and behavior are unstable and
may change in future releases.
{{% /restricted %}}
{{< summary-bar feature_name="Amazon S3 cache" >}}

The `s3` cache storage uploads your resulting build cache to
[Amazon S3 file storage service](https://aws.amazon.com/s3/)
Expand Down
2 changes: 1 addition & 1 deletion content/manuals/build/checks.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ description: Learn how to use build checks to validate your build configuration.
keywords: build, buildx, buildkit, checks, validate, configuration, lint
---

{{< introduced buildx 0.15.0 >}}
{{< summary-bar feature_name="Build checks" >}}

Build checks are a feature introduced in Dockerfile 1.8. It lets you validate
your build configuration and conduct a series of checks prior to executing your
Expand Down
6 changes: 1 addition & 5 deletions content/manuals/build/ci/github-actions/build-summary.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,7 @@ message that caused the build to fail:

## Import build records to Docker Desktop

{{< introduced desktop 4.31 >}}

{{% experimental title="Beta feature" %}}
Import builds is currently in [Beta](../../../release-lifecycle.md#Beta).
{{% /experimental %}}
{{< summary-bar feature_name="Import builds" >}}

The job summary includes a link for downloading a build record archive for the
run. The build record archive is a ZIP file containing the details about a build
Expand Down
6 changes: 1 addition & 5 deletions content/manuals/build/ci/github-actions/cache.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,11 +84,7 @@ jobs:
### Cache backend API
{{% experimental %}}
This cache exporter is experimental. Please provide feedback on the
[BuildKit repository](https://github.com/moby/buildkit)
if you experience any issues.
{{% /experimental %}}
{{< summary-bar feature_name="Cache backend API" >}}
The [GitHub Actions cache exporter](../../cache/backends/gha.md)
backend uses the [GitHub Cache API](https://github.com/tonistiigi/go-actions-cache/blob/master/api.md)
Expand Down
2 changes: 1 addition & 1 deletion content/manuals/compose/bridge/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ linkTitle: Compose Bridge
weight: 50
---

{{< include "compose-bridge-experimental.md" >}}
{{< summary-bar feature_name="Compose bridge" >}}

Compose Bridge lets you transform your Compose configuration file into configuration files for different platforms, primarily focusing on Kubernetes. The default transformation generates Kubernetes manifests and a Kustomize overlay which are designed for deployment on Docker Desktop with Kubernetes enabled.

Expand Down
2 changes: 1 addition & 1 deletion content/manuals/compose/bridge/advanced-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Learn about how Compose Bridge can function a kubectl plugin
keywords: kubernetes, compose, compose bridge, plugin, advanced
---

{{< include "compose-bridge-experimental.md" >}}
{{< summary-bar feature_name="Compose bridge" >}}

Compose Bridge can also function as a `kubectl` plugin, allowing you to integrate its capabilities directly into your Kubernetes command-line operations. This integration simplifies the process of converting and deploying applications from Docker Compose to Kubernetes.

Expand Down
2 changes: 1 addition & 1 deletion content/manuals/compose/bridge/customize.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Learn about the Compose Bridge templates syntax
keywords: compose, bridge, templates
---

{{< include "compose-bridge-experimental.md" >}}
{{< summary-bar feature_name="Compose bridge" >}}

This page explains how Compose Bridge utilizes templating to efficiently translate Docker Compose files into Kubernetes manifests. It also explain how you can customize these templates for your specific requirements and needs, or how you can build your own transformation.

Expand Down
2 changes: 1 addition & 1 deletion content/manuals/compose/bridge/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: Learn about and use the Compose Bridge default transformation
keywords: compose, bridge, kubernetes
---

{{< include "compose-bridge-experimental.md" >}}
{{< summary-bar feature_name="Compose bridge" >}}

Compose Bridge supplies an out-of-the box transformation for your Compose configuration file. Based on an arbitrary `compose.yaml` file, Compose Bridge produces:

Expand Down
4 changes: 1 addition & 3 deletions content/manuals/copilot/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,9 +15,7 @@ description: |
keywords: Docker, GitHub Copilot, extension, Visual Studio Code, chat, ai, containerization
---

{{% restricted title="Early Access" %}}
The Docker for GitHub Copilot extension is an [early access](/release-lifecycle#early-access-ea) product.
{{% /restricted %}}
{{< summary-bar feature_name="Docker GitHub Copilot" >}}

The [Docker for GitHub Copilot](https://github.com/marketplace/docker-for-github-copilot)
extension integrates Docker's capabilities with GitHub Copilot, providing
Expand Down
4 changes: 1 addition & 3 deletions content/manuals/copilot/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@ description: |
weight: 30
---

{{% restricted title="Early Access" %}}
The Docker for GitHub Copilot extension is an [early access](/release-lifecycle#early-access-ea) product.
{{% /restricted %}}
{{< summary-bar feature_name="Docker GitHub Copilot" >}}

## Use cases

Expand Down
4 changes: 1 addition & 3 deletions content/manuals/copilot/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@ description: |
weight: 10
---

{{% restricted title="Early Access" %}}
The Docker for GitHub Copilot extension is an [early access](/release-lifecycle#early-access-ea) product.
{{% /restricted %}}
{{< summary-bar feature_name="Docker GitHub Copilot" >}}

To use the Docker for GitHub copilot extension, you first need to
[install](#install) the extension for your organization, and
Expand Down
4 changes: 1 addition & 3 deletions content/manuals/copilot/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,7 @@ description: |
weight: 20
---

{{% restricted title="Early Access" %}}
The Docker for GitHub Copilot extension is an [early access](/release-lifecycle#early-access-ea) product.
{{% /restricted %}}
{{< summary-bar feature_name="Docker GitHub Copilot" >}}

The Docker Extension for GitHub Copilot provides a chat interface that you can
use to interact with the Docker agent. You can ask questions and get help
Expand Down
4 changes: 1 addition & 3 deletions content/manuals/desktop/features/desktop-cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,7 @@ params:
text: New
---

{{% experimental title="Beta" %}}
Docker Desktop CLI is currently in [Beta](../../release-lifecycle.md#beta).
{{% /experimental %}}
{{< summary-bar feature_name="Docker Desktop CLI" >}}

The Docker Desktop CLI lets you perform key operations such as starting, stopping, restarting, and checking the status of Docker Desktop directly from the command line. It is available with Docker Desktop version 4.37 and later.

Expand Down
4 changes: 1 addition & 3 deletions content/manuals/desktop/features/dev-environments/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,7 @@ aliases:

{{< include "dev-envs-changing.md" >}}

{{% experimental title="Beta" %}}
The Dev Environments feature is currently in [Beta](/manuals/release-lifecycle.md#beta).
{{% /experimental %}}
{{< summary-bar feature_name="Dev Environments" >}}

Dev Environments let you create a configurable developer environment with all the code and tools you need to quickly get up and running.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@ aliases:
- /desktop/synchronized-file-sharing/
---

> [!NOTE]
>
> Synchronized file shares is available with Docker Desktop version 4.27 and later. It is available for customers with a Docker Pro, Team, or Business subscription.
{{< summary-bar feature_name="Synchronized file sharing" >}}

Synchronized file shares is an alternative file sharing mechanism that provides fast and flexible host-to-VM file sharing, enhancing bind mount performance through the use of synchronized filesystem caches.

Expand Down
2 changes: 1 addition & 1 deletion content/manuals/desktop/features/usbip.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ params:
text: New
---

{{< introduced desktop 4.35.0 "../../desktop/release-notes.md#4350" >}}
{{< summary-bar feature_name="USB/IP support" >}}

> [!NOTE]
>
Expand Down
12 changes: 6 additions & 6 deletions content/manuals/desktop/features/vmm.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,15 @@ aliases:
- /desktop/vmm/
---

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

The Virtual Machine Manager (VMM) in Docker Desktop for Mac is responsible for creating and managing the virtual machine used to run containers. Depending on your system architecture and performance needs, you can choose from multiple VMM options in Docker Desktop's [settings](/manuals/desktop/settings-and-maintenance/settings.md#general). This page provides an overview of the available options.

## Docker VMM (Beta)
## Docker VMM

Docker VMM is a new, container-optimized hypervisor introduced in Docker Desktop 4.35 and available on Apple Silicon Macs only. Its enhanced speed and resource efficiency makes it an ideal choice for optimizing your workflow.
Docker VMM is a new, container-optimized hypervisor introduced in Docker Desktop 4.35 and available on Apple Silicon Macs only. Its enhanced speed and resource efficiency makes it an ideal choice for optimizing your workflow.

Docker VMM brings exciting advancements specifically tailored for Apple Silicon machines. By optimizing both the Linux kernel and hypervisor layers, Docker VMM delivers significant performance enhancements across common developer tasks.
Docker VMM brings exciting advancements specifically tailored for Apple Silicon machines. By optimizing both the Linux kernel and hypervisor layers, Docker VMM delivers significant performance enhancements across common developer tasks.

Some key performance enhancements provided by Docker VMM include:
- Faster I/O operations: With a cold cache, iterating over a large shared filesystem with `find` is 2x faster than when the Apple Virtualization Framework is used.
Expand All @@ -31,9 +33,7 @@ These improvements directly impact developers who rely on frequent file access a
>
> Docker VMM requires a minimum of 4GB of memory to be allocated to the Docker Linux VM. The memory needs to be increased before Docker VMM is enabled, and this can be done from the **Resources** tab in **Settings**.
Docker VMM is based on [libkrun](https://github.com/containers/libkrun).

### Known issues
### Known issues

As Docker VMM is still in Beta, there are a few known limitations:

Expand Down
Loading

0 comments on commit 3de8201

Please sign in to comment.