Skip to content

Commit

Permalink
Add summary bars to guides
Browse files Browse the repository at this point in the history
  • Loading branch information
sarahsanders-docker committed Jan 15, 2025
1 parent 30a5c9a commit 71e5562
Show file tree
Hide file tree
Showing 9 changed files with 70 additions and 32 deletions.
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
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
10 changes: 6 additions & 4 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,7 +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**.
### Known issues
### Known issues

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

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,7 @@ description: Integrate Docker Scout using the GitHub app to get remediation advi
keywords: scout, github, integration, image analysis, supply chain, remediation, source code
---

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

The GitHub app integration for Docker Scout grants Docker Scout access to your
source code repository on GitHub. This improved visibility into how your image
Expand Down
4 changes: 1 addition & 3 deletions content/manuals/scout/policy/remediation.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,7 @@ description: Learn how Docker Scout can help you improve your software quality a
keywords: scout, supply chain, security, remediation, automation
---

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

Docker Scout helps you remediate supply chain or security issues by providing
recommendations based on policy evaluation results. Recommendations are
Expand Down
4 changes: 1 addition & 3 deletions content/manuals/security/for-admins/access-tokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@ keywords: docker hub, security, OAT, organization access token
linkTitle: Organization access tokens (Beta)
---

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

> [!WARNING]
>
Expand Down
4 changes: 1 addition & 3 deletions content/reference/cli/docker/desktop/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,4 @@ title: docker desktop (Beta)
layout: cli
---

{{% experimental title="Beta" %}}
Docker Desktop CLI is currently in [Beta](/manuals/release-lifecycle.md#beta).
{{% /experimental %}}
{{< summary-bar feature_name="Docker Desktop CLI" >}}
60 changes: 54 additions & 6 deletions data/summary.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,16 @@

features:
- name: Admin Console
subscriptionIcon: domain
subscriptionText: Business
subscriptionIcon:
- domain
subscriptionText:
- Business
availabilityIcon: rocket_launch
availabilityText: Early access
versionIcon: null
versionText: null
forIcon: null
forText: null
forIcon: admin_panel_settings
forText: Administrators

- name: Allow list
subscriptionIcon: null
Expand Down Expand Up @@ -104,6 +106,16 @@ features:
forIcon: null
forText: null

- name: Docker Scout GitHub
subscriptionIcon: null
subscriptionText: null
availabilityIcon: bolt
availabilityText: Beta
versionIcon: null
versionText: null
forIcon: null
forText: null

- name: Docker Scout health scores
subscriptionIcon: null
subscriptionText: null
Expand Down Expand Up @@ -139,8 +151,8 @@ features:
subscriptionText: null
availabilityIcon: bolt
availabilityText: Beta
versionIcon: null
versionText: null
versionIcon: browser_updated
versionText: Docker Desktop 4.31 and later
forIcon: null
forText: null

Expand Down Expand Up @@ -174,6 +186,20 @@ features:
forIcon: admin_panel_settings
forText: Administrator

- name: OATs
subscriptionIcon:
- group
- domain
subscriptionText:
- Team
- Business
availabilityIcon: bolt
availabilityText: Beta
versionIcon: null
versionText: null
forIcon: null
forText: null

- name: PKG Installer
subscriptionIcon: null
subscriptionText: null
Expand Down Expand Up @@ -204,6 +230,18 @@ features:
forIcon: null
forText: null

- name: SSO
subscriptionIcon:
- domain
subscriptionText:
- Business
availabilityIcon: null
availabilityText: null
versionIcon: null
versionText: null
forIcon: admin_panel_settings
forText: Administrators

- name: USB/IP support
subscriptionIcon: null
subscriptionText: null
Expand All @@ -214,6 +252,16 @@ features:
forIcon: null
forText: null

- name: VMM
subscriptionIcon: null
subscriptionText: null
availabilityIcon: bolt
availabilityText: Beta
versionIcon: browser_updated
versionText: Docker Desktop 4.35.0 and later
forIcon: null
forText: null

- name: Wasm workloads
subscriptionIcon: null
subscriptionText: null
Expand Down
6 changes: 4 additions & 2 deletions layouts/shortcodes/summary-bar.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,12 @@
{{ if $feature.subscriptionText }}
<div class="flex items-center gap-1">
<span class="text-black dark:text-white font-bold">Subscription:</span>
<span class="text-black dark:text-white">{{ $feature.subscriptionText }}</span>
{{ range $i, $text := $feature.subscriptionText }}
<span class="text-black dark:text-white">{{ $text }}</span>
<span class="material-symbols-rounded text-black dark:text-white">
{{ $feature.subscriptionIcon }}
{{ index $feature.subscriptionIcon $i }}
</span>
{{ end }}
</div>
{{ end }}

Expand Down

0 comments on commit 71e5562

Please sign in to comment.