Merge pull request #21474 from dvdksn/sidebar-grouping

feat: sidebar groups
This commit is contained in:
David Karlsson 2024-11-28 16:46:15 +01:00 committed by GitHub
commit 8a722e7ee1
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
23 changed files with 136 additions and 58 deletions

View File

@ -7,16 +7,13 @@ url: /manuals/
layout: wide layout: wide
params: params:
icon: description icon: description
sidebar:
groups:
- Open source
- Products
- Platform
notoc: true notoc: true
development: open-source:
- title: Docker Desktop
description: Your command center for container development.
icon: /assets/icons/Whale.svg
link: /desktop/
- title: Docker Compose
description: Define and run multi-container applications.
icon: /assets/icons/Compose.svg
link: /compose/
- title: Docker Build - title: Docker Build
description: Build and ship any application anywhere. description: Build and ship any application anywhere.
icon: build icon: build
@ -25,11 +22,19 @@ params:
description: The industry-leading container runtime. description: The industry-leading container runtime.
icon: developer_board icon: developer_board
link: /engine/ link: /engine/
- title: Docker Extensions - title: Docker Compose
description: Customize your Docker Desktop workflow. description: Define and run multi-container applications.
icon: extension icon: /assets/icons/Compose.svg
link: /extensions/ link: /compose/
services: products:
- title: Docker Desktop
description: Your command center for container development.
icon: /assets/icons/Whale.svg
link: /desktop/
- title: Build Cloud
description: Build your images faster in the cloud.
icon: /assets/images/logo-build-cloud.svg
link: /build-cloud/
- title: Docker Hub - title: Docker Hub
description: Discover, share, and integrate container images. description: Discover, share, and integrate container images.
icon: hub icon: hub
@ -38,50 +43,63 @@ params:
description: Image analysis and policy evaluation. description: Image analysis and policy evaluation.
icon: /assets/icons/Scout.svg icon: /assets/icons/Scout.svg
link: /scout/ link: /scout/
- title: Trusted content - title: Docker for GitHub Copilot
description: Curated, high-quality content from trusted sources. description: Integrate Docker's capabilities with GitHub Copilot.
icon: verified icon: chat
link: /trusted-content/ link: /copilot/
- title: Build Cloud - title: Docker Extensions
description: Build your images faster in the cloud. description: Customize your Docker Desktop workflow.
icon: /assets/images/logo-build-cloud.svg icon: extension
link: /build-cloud/ link: /extensions/
admin: - title: Testcontainers cloud
description: Run integration tests, with real dependencies, in the cloud.
icon: package_2
link: https://testcontainers.com/cloud/docs/
platform:
- title: Administration - title: Administration
description: Centralized observability for companies and organizations. description: Centralized observability for companies and organizations.
icon: admin_panel_settings icon: admin_panel_settings
link: /admin/ link: /admin/
- title: Security
description: Security guardrails for both administrators and developers.
icon: lock
link: /security/
- title: Billing - title: Billing
description: Manage billing and payment methods. description: Manage billing and payment methods.
icon: payments icon: payments
link: /billing/ link: /billing/
- title: Accounts
description: Manage your Docker account.
icon: account_circle
link: /accounts/
- title: Security
description: Security guardrails for both administrators and developers.
icon: lock
link: /security/
- title: Subscription - title: Subscription
description: Commercial use licenses for Docker products. description: Commercial use licenses for Docker products.
icon: card_membership icon: card_membership
link: /subscription/ link: /subscription/
- title: Trusted content
description: Curated, high-quality content from trusted sources.
icon: verified
link: /trusted-content/
--- ---
This section contains user guides on how to install, set up, configure, and use This section contains user guides on how to install, set up, configure, and use
Docker products. Docker products.
## Developer tools ## Open source
Software development and containerization technologies. Open source development and containerization technologies.
{{< grid items=development >}} {{< grid items=open-source >}}
## Services ## Products
Artifact management and supply chain security. End-to-end developer solutions for innovative teams.
{{< grid items=services >}} {{< grid items=products >}}
## Administration and accounts ## Platform
Administration and subscription management for organizations. Documentation related to the Docker platform, such as administration and
subscription management for organizations.
{{< grid items=admin >}} {{< grid items=platform >}}

View File

@ -1,8 +1,10 @@
--- ---
title: Docker accounts title: Docker accounts
weight: 200
description: Learn how to create and manage your Docker account. description: Learn how to create and manage your Docker account.
keywords: accounts, docker ID, account management, account settings, docker account, docker home keywords: accounts, docker ID, account management, account settings, docker account, docker home
params:
sidebar:
group: Platform
grid: grid:
- title: Create a Docker ID - title: Create a Docker ID
description: Get started with Docker and create an account. description: Get started with Docker and create an account.

View File

@ -1,8 +1,10 @@
--- ---
title: Administration title: Administration
weight: 200
description: Discover manuals on administration for accounts, organizations, and companies. description: Discover manuals on administration for accounts, organizations, and companies.
keywords: admin, administration, company, organization, Admin Console, user accounts, account management keywords: admin, administration, company, organization, Admin Console, user accounts, account management
params:
sidebar:
group: Platform
grid: grid:
- title: Company administration - title: Company administration
description: Explore how to manage a company. description: Explore how to manage a company.

View File

@ -1,9 +1,11 @@
--- ---
title: Billing and payments title: Billing and payments
linkTitle: Billing linkTitle: Billing
weight: 200
description: Discover information on billing and payment processes for Docker subscriptions. description: Discover information on billing and payment processes for Docker subscriptions.
keywords: billing, invoice, payment, subscription keywords: billing, invoice, payment, subscription
params:
sidebar:
group: Platform
grid_core: grid_core:
- title: Get started - title: Get started
description: Learn how to set up a Docker Core subscription for a personal account or organization. description: Learn how to set up a Docker Core subscription for a personal account or organization.

View File

@ -1,8 +1,11 @@
--- ---
title: Docker Build Cloud title: Docker Build Cloud
weight: 100 weight: 20
description: Find documentation on Docker Build Cloud to help you build your container images faster, both locally and in CI description: Find documentation on Docker Build Cloud to help you build your container images faster, both locally and in CI
keywords: build, cloud, cloud build, remote builder keywords: build, cloud, cloud build, remote builder
params:
sidebar:
group: Products
aliases: aliases:
- /build/cloud/faq/ - /build/cloud/faq/
- /build/cloud/ - /build/cloud/

View File

@ -1,8 +1,11 @@
--- ---
title: Docker Build title: Docker Build
weight: 100 weight: 20
description: Get an overview of Docker Build to package and bundle your code and ship it anywhere description: Get an overview of Docker Build to package and bundle your code and ship it anywhere
keywords: build, buildx, buildkit keywords: build, buildx, buildkit
params:
sidebar:
group: Open source
grid: grid:
- title: Packaging your software - title: Packaging your software
description: 'Build and package your application to run it anywhere: locally or description: 'Build and package your application to run it anywhere: locally or

View File

@ -2,6 +2,9 @@
title: Cloud integrations title: Cloud integrations
description: ACI and ECS integration information description: ACI and ECS integration information
keywords: compose, ACI, ECS, amazon, cloud integration keywords: compose, ACI, ECS, amazon, cloud integration
params:
sidebar:
group: Products
aliases: aliases:
- /engine/context/aci-integration/ - /engine/context/aci-integration/
- /cloud/aci-integration/ - /cloud/aci-integration/

View File

@ -1,11 +1,14 @@
--- ---
title: Docker Compose title: Docker Compose
weight: 100 weight: 30
description: Learn how to use Docker Compose to define and run multi-container applications description: Learn how to use Docker Compose to define and run multi-container applications
with this detailed introduction to the tool. with this detailed introduction to the tool.
keywords: docker compose, docker-compose, docker compose command, docker compose files, keywords: docker compose, docker-compose, docker compose command, docker compose files,
docker compose documentation, using docker compose, compose container, docker compose docker compose documentation, using docker compose, compose container, docker compose
service service
params:
sidebar:
group: Open source
grid: grid:
- title: Why use Compose? - title: Why use Compose?
description: Understand Docker Compose's key benefits description: Understand Docker Compose's key benefits

View File

@ -2,10 +2,11 @@
title: Docker for GitHub Copilot title: Docker for GitHub Copilot
params: params:
sidebar: sidebar:
group: Products
badge: badge:
color: violet color: violet
text: EA text: EA
weight: 100 weight: 50
description: | description: |
Learn how to streamline Docker-related tasks with the Docker for GitHub Learn how to streamline Docker-related tasks with the Docker for GitHub
Copilot extension. This integration helps you generate Docker assets, analyze Copilot extension. This integration helps you generate Docker assets, analyze

View File

@ -1,9 +1,12 @@
--- ---
title: Docker Desktop title: Docker Desktop
weight: 100 weight: 10
description: Explore Docker Desktop, what it has to offer, and its key features. Take the next step by downloading or find additional resources description: Explore Docker Desktop, what it has to offer, and its key features. Take the next step by downloading or find additional resources
keywords: how to use docker desktop, what is docker desktop used for, what does docker keywords: how to use docker desktop, what is docker desktop used for, what does docker
desktop do, using docker desktop desktop do, using docker desktop
params:
sidebar:
group: Products
grid: grid:
- title: Install Docker Desktop - title: Install Docker Desktop
description: | description: |

View File

@ -2,7 +2,10 @@
description: Get an overview on Docker Hub to find and share container images description: Get an overview on Docker Hub to find and share container images
keywords: docker hub, hub, repositories keywords: docker hub, hub, repositories
title: Docker Hub title: Docker Hub
weight: 100 weight: 30
params:
sidebar:
group: Products
grid: grid:
- title: Quickstart - title: Quickstart
description: Step-by-step instructions on getting started on Docker Hub. description: Step-by-step instructions on getting started on Docker Hub.
@ -46,4 +49,4 @@ In addition to the graphical interface, you can interact with Docker Hub using
the [Docker Hub API](../../reference/api/hub/latest.md) or experimental [Docker the [Docker Hub API](../../reference/api/hub/latest.md) or experimental [Docker
Hub CLI tool](https://github.com/docker/hub-tool#readme). Hub CLI tool](https://github.com/docker/hub-tool#readme).
{{< grid >}} {{< grid >}}

View File

@ -1,8 +1,11 @@
--- ---
title: Docker Engine title: Docker Engine
weight: 100 weight: 10
description: Find a comprehensive overview of Docker Engine, including how to install, storage details, networking, and more description: Find a comprehensive overview of Docker Engine, including how to install, storage details, networking, and more
keywords: Engine keywords: Engine
params:
sidebar:
group: Open source
grid: grid:
- title: Install Docker Engine - title: Install Docker Engine
description: Learn how to install the open source Docker Engine for your distribution. description: Learn how to install the open source Docker Engine for your distribution.

View File

@ -1,8 +1,11 @@
--- ---
title: Docker Extensions title: Docker Extensions
weight: 100 weight: 60
description: Extensions description: Extensions
keywords: Docker Extensions, Docker Desktop, Linux, Mac, Windows keywords: Docker Extensions, Docker Desktop, Linux, Mac, Windows
params:
sidebar:
group: Products
aliases: aliases:
- /desktop/extensions/ - /desktop/extensions/
--- ---

View File

@ -3,6 +3,9 @@ title: Project Harmonia
description: Learn how you can run your applications in the cloud with Project Harmonia description: Learn how you can run your applications in the cloud with Project Harmonia
keywords: run, cloud, docker desktop, resources keywords: run, cloud, docker desktop, resources
sitemap: false sitemap: false
params:
sidebar:
group: Products
aliases: aliases:
- /run-cloud/ - /run-cloud/
--- ---

View File

@ -2,6 +2,9 @@
title: Registry title: Registry
description: The Docker Hub registry implementation description: The Docker Hub registry implementation
keywords: registry, distribution, docker hub, spec, schema, api, manifest, auth keywords: registry, distribution, docker hub, spec, schema, api, manifest, auth
params:
sidebar:
group: Open source
aliases: aliases:
- /registry/compatibility/ - /registry/compatibility/
- /registry/configuration/ - /registry/configuration/

View File

@ -4,6 +4,9 @@ linkTitle: Release lifecycle
description: Describes the various stages of feature lifecycle from beta description: Describes the various stages of feature lifecycle from beta
to GA. to GA.
keywords: beta, GA, Early Access, keywords: beta, GA, Early Access,
params:
sidebar:
group: Products
--- ---
This page details Docker's product release lifecycle and how Docker defines each stage. It also provides information on the product retirement process. Features and products may progress through some or all of these phases. This page details Docker's product release lifecycle and how Docker defines each stage. It also provides information on the product retirement process. Features and products may progress through some or all of these phases.

View File

@ -1,11 +1,14 @@
--- ---
title: Docker Scout title: Docker Scout
weight: 100 weight: 40
keywords: scout, supply chain, vulnerabilities, packages, cves, scan, analysis, analyze keywords: scout, supply chain, vulnerabilities, packages, cves, scan, analysis, analyze
description: description:
Get an overview on Docker Scout to proactively enhance your software supply chain security Get an overview on Docker Scout to proactively enhance your software supply chain security
aliases: aliases:
- /engine/scan/ - /engine/scan/
params:
sidebar:
group: Products
grid: grid:
- title: Quickstart - title: Quickstart
link: /scout/quickstart/ link: /scout/quickstart/

View File

@ -1,8 +1,10 @@
--- ---
title: Security title: Security
weight: 200
description: Learn about security features Docker has to offer and explore best practices description: Learn about security features Docker has to offer and explore best practices
keywords: docker, docker hub, docker desktop, security keywords: docker, docker hub, docker desktop, security
params:
sidebar:
group: Platform
grid_admins: grid_admins:
- title: Settings Management - title: Settings Management
description: Learn how Settings Management can secure your developers' workflows. description: Learn how Settings Management can secure your developers' workflows.

View File

@ -1,8 +1,10 @@
--- ---
title: Subscription title: Subscription
weight: 200
description: Learn about subscription features and how to manage your subscription description: Learn about subscription features and how to manage your subscription
keywords: Docker, pricing, billing, Pro, Team, business, subscription, tier, plan keywords: Docker, pricing, billing, Pro, Team, business, subscription, tier, plan
params:
sidebar:
group: Platform
grid_subscriptions: grid_subscriptions:
- title: Docker Core subscriptions and features - title: Docker Core subscriptions and features
description: Explore what you can do with your Docker subscription. description: Explore what you can do with your Docker subscription.

View File

@ -1,7 +1,8 @@
--- ---
title: Testcontainers Cloud title: Testcontainers Cloud
weight: 200 weight: 70
params: params:
sidebar: sidebar:
group: Products
goto: "https://testcontainers.com/cloud/docs/" goto: "https://testcontainers.com/cloud/docs/"
--- ---

View File

@ -1,8 +1,10 @@
--- ---
title: Trusted content title: Trusted content
weight: 200
description: Optimize your development workflow with secure base images from our selection of trusted content description: Optimize your development workflow with secure base images from our selection of trusted content
keywords: doi, dvp, dsos, open source, security, base images keywords: doi, dvp, dsos, open source, security, base images
params:
sidebar:
group: Platform
grid: grid:
- title: Docker Official Images - title: Docker Official Images
description: A curated set of Docker repositories hosted on Docker Hub. description: A curated set of Docker repositories hosted on Docker Hub.

View File

@ -515,6 +515,7 @@
"transition", "transition",
"truncate", "truncate",
"underline-offset-2", "underline-offset-2",
"uppercase",
"w-2", "w-2",
"w-8", "w-8",
"w-[1200px]", "w-[1200px]",

View File

@ -2,7 +2,6 @@
<nav class="md:text-sm flex flex-col"> <nav class="md:text-sm flex flex-col">
<div <div
class="block py-4 md:hidden text-gray-light dark:text-gray-dark">This section</div> class="block py-4 md:hidden text-gray-light dark:text-gray-dark">This section</div>
{{/* The current page is in the table of contents */}}
<ul> <ul>
{{ template "renderChildren" .FirstSection }} {{ template "renderChildren" .FirstSection }}
</ul> </ul>
@ -13,16 +12,26 @@
{{- if .Params.sidebar.reverse }} {{- if .Params.sidebar.reverse }}
{{ $pages = .Pages.Reverse }} {{ $pages = .Pages.Reverse }}
{{- end }} {{- end }}
{{- range $pages }} {{- $pages = where .Pages "Params.sitemap" "ne" "false" }}
{{- if eq .Params.sitemap false }} {{- $ungrouped := where $pages "Params.sidebar.group" "==" nil }}
{{- continue }} {{- range $ungrouped }}
{{- end }}
{{- if .IsSection }} {{- if .IsSection }}
{{- template "renderList" . }} {{- template "renderList" . }}
{{- else }} {{- else }}
{{- template "renderSingle" . }} {{- template "renderSingle" . }}
{{- end }} {{- end }}
{{- end }} {{- end }}
{{- range .Params.sidebar.groups }}
<li class="px-2 py-2 pb-2 text-gray-light dark:text-gray-dark uppercase
text-xs font-semibold">{{ . }}</li>
{{- range where $pages "Params.sidebar.group" . }}
{{- if .IsSection }}
{{- template "renderList" . }}
{{- else }}
{{- template "renderSingle" . }}
{{- end }}
{{- end }}
{{- end }}
{{ end }} {{ end }}
{{/* Recursive template for sidebar items */}} {{/* Recursive template for sidebar items */}}