From 30a5c9ae9225f085b64afd185c9afe3ec5266c31 Mon Sep 17 00:00:00 2001 From: Sarah Sanders Date: Tue, 14 Jan 2025 10:26:09 -0800 Subject: [PATCH] Add summary bars for features --- content/manuals/build/checks.md | 2 +- .../features/dev-environments/_index.md | 4 +- content/manuals/desktop/features/usbip.md | 2 +- content/manuals/desktop/features/wasm.md | 6 +- content/manuals/desktop/setup/allow-list.md | 2 + .../enterprise-deployment/use-intune.md | 2 + data/summary.yaml | 165 +++++++++++++++--- layouts/shortcodes/summary-bar.html | 2 +- 8 files changed, 153 insertions(+), 32 deletions(-) diff --git a/content/manuals/build/checks.md b/content/manuals/build/checks.md index 84df51a0b4c..b741f71800e 100644 --- a/content/manuals/build/checks.md +++ b/content/manuals/build/checks.md @@ -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 diff --git a/content/manuals/desktop/features/dev-environments/_index.md b/content/manuals/desktop/features/dev-environments/_index.md index 85cdf928583..a4df3143c6f 100644 --- a/content/manuals/desktop/features/dev-environments/_index.md +++ b/content/manuals/desktop/features/dev-environments/_index.md @@ -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. diff --git a/content/manuals/desktop/features/usbip.md b/content/manuals/desktop/features/usbip.md index 12483da06bf..3ed10113c92 100644 --- a/content/manuals/desktop/features/usbip.md +++ b/content/manuals/desktop/features/usbip.md @@ -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] > diff --git a/content/manuals/desktop/features/wasm.md b/content/manuals/desktop/features/wasm.md index 741637fc12f..07103eeb8c5 100644 --- a/content/manuals/desktop/features/wasm.md +++ b/content/manuals/desktop/features/wasm.md @@ -8,11 +8,7 @@ aliases: - /desktop/wasm/ --- -{{% experimental title="Beta" %}} -The Wasm feature is currently in [Beta](/manuals/release-lifecycle.md#beta). -We recommend that you do not use this feature in production environments as -this feature may change or be removed from future releases. -{{% /experimental %}} +{{< summary-bar feature_name="Wasm workloads" >}} Wasm (short for WebAssembly) is a fast, light alternative to the Linux and Windows containers you’re using in Docker today (with diff --git a/content/manuals/desktop/setup/allow-list.md b/content/manuals/desktop/setup/allow-list.md index 78b7ea3e6a4..b29a777db1a 100644 --- a/content/manuals/desktop/setup/allow-list.md +++ b/content/manuals/desktop/setup/allow-list.md @@ -8,6 +8,8 @@ aliases: - /desktop/allow-list/ --- +{{< summary-bar feature_name="Allow list" >}} + This page contains the domain URLs that you need to add to a firewall allowlist to ensure Docker Desktop works properly within your organization. ## Domain URLs to allow diff --git a/content/manuals/desktop/setup/install/enterprise-deployment/use-intune.md b/content/manuals/desktop/setup/install/enterprise-deployment/use-intune.md index 7e7637c4e2b..4aa7430c23d 100644 --- a/content/manuals/desktop/setup/install/enterprise-deployment/use-intune.md +++ b/content/manuals/desktop/setup/install/enterprise-deployment/use-intune.md @@ -8,6 +8,8 @@ aliases: - /desktop/setup/install/msi/use-intune/ --- +{{< summary-bar feature_name="Intune" >}} + Learn how to deploy Docker Desktop for Windows and Mac using Intune, Microsoft's cloud-based device management tool. {{< tabs >}} diff --git a/data/summary.yaml b/data/summary.yaml index 40b95d7046e..a30eee3ac2c 100644 --- a/data/summary.yaml +++ b/data/summary.yaml @@ -1,24 +1,27 @@ # Summary bar icon library: # 1. Subscription: - # - Label: Business | Icon: domain - # - Label: Team | Icon: groups - # - Label: Pro | Icon: person_add - # - Label: Personal | Icon: person - # - Label: Available to all | Icon: public + # - Label: Business | Icon: domain + # - Label: Team | Icon: groups + # - Label: Pro | Icon: person_add + # - Label: Personal | Icon: person + # - Label: Available to all | Icon: public # 2. Availability: - # - Label: Experimental | Icon: science - # - Label: Beta | Icon: bolt - # - Label: Early access | Icon: rocket_launch - # - Label: GA | Icon: check_circle - # - Label: Retired | Icon: package_2 + # - Label: Experimental | Icon: science + # - Label: Beta | Icon: bolt + # - Label: Early access | Icon: rocket_launch + # - Label: GA | Icon: check_circle + # - Label: Retired | Icon: package_2 # 3. Minimum version: - # - Label: [version_number] | Icon: browser_updated + # - Label: [product] [version_number] and later | Icon: browser_updated # 4. For: - # - Label: Administrators | Icon: admin_panel_settings + # - Label: Administrators | Icon: admin_panel_settings # Instructions for adding summary bar: Create a new feature and fill out each # line as needed. In your markdown file, use the following syntax to call the -# summary bar: {{< summary-bar feature_name="your feature name here" >} +# summary bar: {{< summary-bar feature_name="your feature name here, case sensitive" >}} + +# To add an ADMIN ONLY summary bar: In your markdown file, use the following +# syntax to call the summary bar: {{< summary-bar feature_name="General admin" >}} features: - name: Admin Console @@ -28,8 +31,18 @@ features: availabilityText: Early access versionIcon: null versionText: null - forText: null forIcon: null + forText: null + + - name: Allow list + subscriptionIcon: null + subscriptionText: null + availabilityIcon: null + availabilityText: null + versionIcon: null + versionText: null + forIcon: admin_panel_settings + forText: Administrators - name: Ask Gordon subscriptionIcon: null @@ -38,8 +51,18 @@ features: availabilityText: Beta versionIcon: null versionText: null + forIcon: null forText: null + + - name: Build checks + subscriptionIcon: null + subscriptionText: null + availabilityIcon: bolt + availabilityText: Beta + versionIcon: browser_updated + versionText: Buildx 0.15.0 and later forIcon: null + forText: null - name: Dev Environments subscriptionIcon: null @@ -48,8 +71,18 @@ features: availabilityText: Beta versionIcon: null versionText: null + forIcon: null forText: null + + - name: docker compose alpha + subscriptionIcon: null + subscriptionText: null + availabilityIcon: science + availabilityText: Experimental + versionIcon: null + versionText: null forIcon: null + forText: null - name: Docker Desktop CLI subscriptionIcon: null @@ -57,9 +90,29 @@ features: availabilityIcon: bolt availabilityText: Beta versionIcon: browser_updated - versionText: 4.37 and later + versionText: Docker Desktop 4.37 and later + forIcon: null forText: null + + - name: Docker GitHub Copilot + subscriptionIcon: null + subscriptionText: null + availabilityIcon: rocket_launch + availabilityText: Early access + versionIcon: null + versionText: null forIcon: null + forText: null + + - name: Docker Scout health scores + subscriptionIcon: null + subscriptionText: null + availabilityIcon: bolt + availabilityText: Beta + versionIcon: null + versionText: null + forIcon: null + forText: null - name: Docker VMM subscriptionIcon: null @@ -67,29 +120,99 @@ features: availabilityIcon: bolt availabilityText: Beta versionIcon: browser_updated - versionText: 4.35.0 and later + versionText: Docker Desktop 4.35.0 and later + forIcon: null forText: null + + - name: General admin + subscriptionIcon: null + subscriptionText: null + availabilityIcon: null + availabilityText: null + versionIcon: null + versionText: null + forIcon: admin_panel_settings + forText: Administrators + + - name: Import builds + subscriptionIcon: null + subscriptionText: null + availabilityIcon: bolt + availabilityText: Beta + versionIcon: null + versionText: null forIcon: null + forText: null + + - name: Intune + subscriptionIcon: null + subscriptionText: null + availabilityIcon: null + availabilityText: null + versionIcon: null + versionText: null + forIcon: admin_panel_settings + forText: Administrators + + - name: Jamf Pro + subscriptionIcon: null + subscriptionText: null + availabilityIcon: null + availabilityText: null + versionIcon: null + versionText: null + forIcon: admin_panel_settings + forText: Administrators - name: MSI Installer + subscriptionIcon: null + subscriptionText: null + availabilityIcon: null + availabilityText: null + versionIcon: browser_updated + versionText: Docker Desktop 4.32 and later + forIcon: admin_panel_settings + forText: Administrator + + - name: PKG Installer + subscriptionIcon: null + subscriptionText: null + availabilityIcon: rocket_launch + availabilityText: Early access + versionIcon: browser_updated + versionText: Docker Desktop 4.36 and later + forIcon: admin_panel_settings + forText: Administrator + + - name: Private marketplace subscriptionIcon: null subscriptionText: null availabilityIcon: bolt availabilityText: Beta - versionIcon: browser_updated - versionText: 4.32 and later + versionIcon: null + versionText: null forIcon: admin_panel_settings forText: Administrator + - name: Remediation with Docker Scout + subscriptionIcon: null + subscriptionText: null + availabilityIcon: bolt + availabilityText: Beta + versionIcon: null + versionText: null + forIcon: null + forText: null + - name: USB/IP support subscriptionIcon: null subscriptionText: null availabilityIcon: null availabilityText: null versionIcon: browser_updated - versionText: 4.35.0 and later - forText: null + versionText: Docker Desktop 4.35.0 and later forIcon: null + forText: null - name: Wasm workloads subscriptionIcon: null @@ -98,5 +221,5 @@ features: availabilityText: Beta versionIcon: null versionText: null - forText: null forIcon: null + forText: null \ No newline at end of file diff --git a/layouts/shortcodes/summary-bar.html b/layouts/shortcodes/summary-bar.html index d9488a2cb30..b5add0078ba 100644 --- a/layouts/shortcodes/summary-bar.html +++ b/layouts/shortcodes/summary-bar.html @@ -4,7 +4,7 @@ {{ $feature := index (where site.Data.summary.features "name" $featureName) 0 }} {{ if $feature }}
+ style="border-left: 4px solid #677285; padding-left: 16px; padding-top: 1px; padding-bottom: 1px; margin-top: 1px; margin-bottom: 1px;">
{{ if $feature.subscriptionText }}