mirror of https://github.com/docker/docs.git
ENGDOCS-2214 (#20843)
* ENGDOCS-2214 * add more weights * weights and linktitles
This commit is contained in:
parent
b769446e2e
commit
5f45287df6
|
@ -1,9 +1,11 @@
|
||||||
---
|
---
|
||||||
title: Extension architecture
|
title: Extension architecture
|
||||||
|
linkTitle: Architecture
|
||||||
description: Docker extension architecture
|
description: Docker extension architecture
|
||||||
keywords: Docker, extensions, sdk, metadata
|
keywords: Docker, extensions, sdk, metadata
|
||||||
aliases:
|
aliases:
|
||||||
- /desktop/extensions-sdk/architecture/
|
- /desktop/extensions-sdk/architecture/
|
||||||
|
weight: 50
|
||||||
---
|
---
|
||||||
|
|
||||||
Extensions are applications that run inside the Docker Desktop. They're packaged as Docker images, distributed
|
Extensions are applications that run inside the Docker Desktop. They're packaged as Docker images, distributed
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Extension metadata
|
title: Extension metadata
|
||||||
|
linkTitle: Metadata
|
||||||
description: Docker extension metadata
|
description: Docker extension metadata
|
||||||
keywords: Docker, extensions, sdk, metadata
|
keywords: Docker, extensions, sdk, metadata
|
||||||
aliases:
|
aliases:
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Extension security
|
title: Extension security
|
||||||
|
linkTitle: Security
|
||||||
description: Aspects of the security model of extensions
|
description: Aspects of the security model of extensions
|
||||||
keywords: Docker, extensions, sdk, security
|
keywords: Docker, extensions, sdk, security
|
||||||
aliases:
|
aliases:
|
||||||
|
|
|
@ -2,4 +2,5 @@
|
||||||
build:
|
build:
|
||||||
render: never
|
render: never
|
||||||
title: "Part one: Build"
|
title: "Part one: Build"
|
||||||
|
weight: 30
|
||||||
---
|
---
|
||||||
|
|
|
@ -8,6 +8,7 @@ aliases:
|
||||||
- /desktop/extensions-sdk/build/set-up/minimal-frontend-using-docker-cli/
|
- /desktop/extensions-sdk/build/set-up/minimal-frontend-using-docker-cli/
|
||||||
- /desktop/extensions-sdk/build/set-up/frontend-extension-tutorial/
|
- /desktop/extensions-sdk/build/set-up/frontend-extension-tutorial/
|
||||||
- /desktop/extensions-sdk/build/frontend-extension-tutorial/
|
- /desktop/extensions-sdk/build/frontend-extension-tutorial/
|
||||||
|
weight: 20
|
||||||
---
|
---
|
||||||
|
|
||||||
To start creating your extension, you first need a directory with files which range from the extension’s source code to the required extension-specific files. This page provides information on how to set up an extension with a more advanced frontend.
|
To start creating your extension, you first need a directory with files which range from the extension’s source code to the required extension-specific files. This page provides information on how to set up an extension with a more advanced frontend.
|
||||||
|
|
|
@ -6,6 +6,7 @@ aliases:
|
||||||
- /desktop/extensions-sdk/tutorials/minimal-frontend-extension/
|
- /desktop/extensions-sdk/tutorials/minimal-frontend-extension/
|
||||||
- /desktop/extensions-sdk/build/set-up/minimal-frontend-extension/
|
- /desktop/extensions-sdk/build/set-up/minimal-frontend-extension/
|
||||||
- /desktop/extensions-sdk/build/minimal-frontend-extension/
|
- /desktop/extensions-sdk/build/minimal-frontend-extension/
|
||||||
|
weight: 10
|
||||||
---
|
---
|
||||||
|
|
||||||
To start creating your extension, you first need a directory with files which range from the extension’s source code to the required extension-specific files. This page provides information on how to set up a minimal frontend extension based on plain HTML.
|
To start creating your extension, you first need a directory with files which range from the extension’s source code to the required extension-specific files. This page provides information on how to set up a minimal frontend extension based on plain HTML.
|
||||||
|
|
|
@ -1,11 +1,13 @@
|
||||||
---
|
---
|
||||||
title: UI styling overview for Docker extensions
|
title: UI styling overview for Docker extensions
|
||||||
|
linkTitle: Design and UI styling
|
||||||
description: Docker extension design
|
description: Docker extension design
|
||||||
keywords: Docker, extensions, design
|
keywords: Docker, extensions, design
|
||||||
aliases:
|
aliases:
|
||||||
- /desktop/extensions-sdk/design/design-overview/
|
- /desktop/extensions-sdk/design/design-overview/
|
||||||
- /desktop/extensions-sdk/design/overview/
|
- /desktop/extensions-sdk/design/overview/
|
||||||
- /desktop/extensions-sdk/design/
|
- /desktop/extensions-sdk/design/
|
||||||
|
weight: 60
|
||||||
---
|
---
|
||||||
|
|
||||||
Our Design System is a constantly evolving set of specifications that aim to ensure visual consistency across Docker products, and meet [level AA accessibility standards](https://www.w3.org/WAI/WCAG2AA-Conformance). We've opened parts of it to extension authors, documenting basic styles (color, typography) and components. See: [Docker Extensions Styleguide](https://www.figma.com/file/U7pLWfEf6IQKUHLhdateBI/Docker-Design-Guidelines?node-id=1%3A28771).
|
Our Design System is a constantly evolving set of specifications that aim to ensure visual consistency across Docker products, and meet [level AA accessibility standards](https://www.w3.org/WAI/WCAG2AA-Conformance). We've opened parts of it to extension authors, documenting basic styles (color, typography) and components. See: [Docker Extensions Styleguide](https://www.figma.com/file/U7pLWfEf6IQKUHLhdateBI/Docker-Design-Guidelines?node-id=1%3A28771).
|
||||||
|
|
|
@ -1,9 +1,11 @@
|
||||||
---
|
---
|
||||||
title: Design guidelines for Docker extensions
|
title: Design guidelines for Docker extensions
|
||||||
|
linkTitle: Guidelines
|
||||||
description: Docker extension design
|
description: Docker extension design
|
||||||
keywords: Docker, extensions, design
|
keywords: Docker, extensions, design
|
||||||
aliases:
|
aliases:
|
||||||
- /desktop/extensions-sdk/design/design-guidelines/
|
- /desktop/extensions-sdk/design/design-guidelines/
|
||||||
|
weight: 10
|
||||||
---
|
---
|
||||||
|
|
||||||
At Docker, we aim to build tools that integrate into a user's existing workflows rather than requiring them to adopt new ones. We strongly recommend that you follow these guidelines when creating extensions. We review and approve your Marketplace publication based on these requirements.
|
At Docker, we aim to build tools that integrate into a user's existing workflows rather than requiring them to adopt new ones. We strongly recommend that you follow these guidelines when creating extensions. We review and approve your Marketplace publication based on these requirements.
|
||||||
|
|
|
@ -4,6 +4,7 @@ description: Docker extension design
|
||||||
keywords: Docker, extensions, design
|
keywords: Docker, extensions, design
|
||||||
aliases:
|
aliases:
|
||||||
- /desktop/extensions-sdk/design/design-principles/
|
- /desktop/extensions-sdk/design/design-principles/
|
||||||
|
weight: 20
|
||||||
---
|
---
|
||||||
|
|
||||||
## Provide actionable guidance
|
## Provide actionable guidance
|
||||||
|
|
|
@ -4,6 +4,7 @@ description: Automatically test and validate your extension.
|
||||||
keywords: Docker, Extensions, sdk, CI, test, regression
|
keywords: Docker, Extensions, sdk, CI, test, regression
|
||||||
aliases:
|
aliases:
|
||||||
- /desktop/extensions-sdk/dev/continuous-integration/
|
- /desktop/extensions-sdk/dev/continuous-integration/
|
||||||
|
weight: 20
|
||||||
---
|
---
|
||||||
|
|
||||||
In order to help validate your extension and ensure it's functional, the Extension SDK provides tools to help you setup continuous integration for your extension.
|
In order to help validate your extension and ensure it's functional, the Extension SDK provides tools to help you setup continuous integration for your extension.
|
||||||
|
|
|
@ -5,6 +5,7 @@ keywords: Docker, Extensions, sdk, preview, update, Chrome DevTools
|
||||||
aliases:
|
aliases:
|
||||||
- /desktop/extensions-sdk/build/test-debug/
|
- /desktop/extensions-sdk/build/test-debug/
|
||||||
- /desktop/extensions-sdk/dev/test-debug/
|
- /desktop/extensions-sdk/dev/test-debug/
|
||||||
|
weight: 10
|
||||||
---
|
---
|
||||||
|
|
||||||
In order to improve the developer experience, Docker Desktop provides a set of tools to help you test and debug your extension.
|
In order to improve the developer experience, Docker Desktop provides a set of tools to help you test and debug your extension.
|
||||||
|
|
|
@ -1,10 +1,11 @@
|
||||||
---
|
---
|
||||||
title: Usage overview
|
title: CLI reference
|
||||||
description: Docker extension CLI
|
description: Docker extension CLI
|
||||||
keywords: Docker, extensions, sdk, CLI
|
keywords: Docker, extensions, sdk, CLI
|
||||||
aliases:
|
aliases:
|
||||||
- /desktop/extensions-sdk/dev/cli/usage/
|
- /desktop/extensions-sdk/dev/cli/usage/
|
||||||
- /desktop/extensions-sdk/dev/usage/
|
- /desktop/extensions-sdk/dev/usage/
|
||||||
|
weight: 30
|
||||||
---
|
---
|
||||||
|
|
||||||
The Extensions CLI is an extension development tool that is used to manage Docker extensions. Actions include install, list, remove, and validate extensions.
|
The Extensions CLI is an extension development tool that is used to manage Docker extensions. Actions include install, list, remove, and validate extensions.
|
||||||
|
|
|
@ -4,6 +4,7 @@ description: Docker extension disctribution
|
||||||
keywords: Docker, extensions, sdk, distribution
|
keywords: Docker, extensions, sdk, distribution
|
||||||
aliases:
|
aliases:
|
||||||
- /desktop/extensions-sdk/extensions/DISTRIBUTION/
|
- /desktop/extensions-sdk/extensions/DISTRIBUTION/
|
||||||
|
weight: 30
|
||||||
---
|
---
|
||||||
|
|
||||||
This page contains additional information on how to package and distribute extensions.
|
This page contains additional information on how to package and distribute extensions.
|
||||||
|
|
|
@ -1,9 +1,10 @@
|
||||||
---
|
---
|
||||||
title: Extension release process
|
title: "Part two: Publish"
|
||||||
description: General steps in how to publish an extension
|
description: General steps in how to publish an extension
|
||||||
keywords: Docker, Extensions, sdk, publish
|
keywords: Docker, Extensions, sdk, publish
|
||||||
aliases:
|
aliases:
|
||||||
- /desktop/extensions-sdk/extensions/
|
- /desktop/extensions-sdk/extensions/
|
||||||
|
weight: 40
|
||||||
---
|
---
|
||||||
|
|
||||||
This section describes how to make your extension available and more visible, so users can discover it and install it with a single click.
|
This section describes how to make your extension available and more visible, so users can discover it and install it with a single click.
|
||||||
|
|
|
@ -1,9 +1,11 @@
|
||||||
---
|
---
|
||||||
title: Extension image labels
|
title: Extension image labels
|
||||||
|
linkTitle: Add labels
|
||||||
description: Docker extension labels
|
description: Docker extension labels
|
||||||
keywords: Docker, extensions, sdk, labels
|
keywords: Docker, extensions, sdk, labels
|
||||||
aliases:
|
aliases:
|
||||||
- /desktop/extensions-sdk/extensions/labels/
|
- /desktop/extensions-sdk/extensions/labels/
|
||||||
|
weight: 10
|
||||||
---
|
---
|
||||||
|
|
||||||
Extensions use image labels to provide additional information such as a title, description, screenshots, and more.
|
Extensions use image labels to provide additional information such as a title, description, screenshots, and more.
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
---
|
---
|
||||||
title: Build the extensions for multiple architectures
|
title: Build multi-arch extensions
|
||||||
description: Step three in creating an extension.
|
description: Step three in creating an extension.
|
||||||
keywords: Docker, Extensions, sdk, build, multi-arch
|
keywords: Docker, Extensions, sdk, build, multi-arch
|
||||||
aliases:
|
aliases:
|
||||||
|
|
|
@ -1,9 +1,10 @@
|
||||||
---
|
---
|
||||||
title: Publish your extension in the Marketplace
|
title: Publish in the Marketplace
|
||||||
description: Docker extension distribution
|
description: Docker extension distribution
|
||||||
keywords: Docker, extensions, publish
|
keywords: Docker, extensions, publish
|
||||||
aliases:
|
aliases:
|
||||||
- /desktop/extensions-sdk/extensions/publish/
|
- /desktop/extensions-sdk/extensions/publish/
|
||||||
|
weight: 50
|
||||||
---
|
---
|
||||||
|
|
||||||
## Submit your extension to the Marketplace
|
## Submit your extension to the Marketplace
|
||||||
|
|
|
@ -4,6 +4,7 @@ description: Share your extension with a share link
|
||||||
keywords: Docker, extensions, share
|
keywords: Docker, extensions, share
|
||||||
aliases:
|
aliases:
|
||||||
- /desktop/extensions-sdk/extensions/share/
|
- /desktop/extensions-sdk/extensions/share/
|
||||||
|
weight: 40
|
||||||
---
|
---
|
||||||
|
|
||||||
Once your extension image is accessible on Docker Hub, anyone with access to the image can install the extension.
|
Once your extension image is accessible on Docker Hub, anyone with access to the image can install the extension.
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Validate your extension
|
title: Validate your extension
|
||||||
|
linkTitle: Validate
|
||||||
description: Step three in the extension creation process
|
description: Step three in the extension creation process
|
||||||
keywords: Docker, Extensions, sdk, validate, install
|
keywords: Docker, Extensions, sdk, validate, install
|
||||||
aliases:
|
aliases:
|
||||||
|
@ -7,6 +8,7 @@ aliases:
|
||||||
- /desktop/extensions-sdk/build/build-install/
|
- /desktop/extensions-sdk/build/build-install/
|
||||||
- /desktop/extensions-sdk/dev/cli/build-test-install-extension/
|
- /desktop/extensions-sdk/dev/cli/build-test-install-extension/
|
||||||
- /desktop/extensions-sdk/extensions/validate/
|
- /desktop/extensions-sdk/extensions/validate/
|
||||||
|
weight: 20
|
||||||
---
|
---
|
||||||
|
|
||||||
Validate your extension before you share or publish it. Validating the extension ensures that the extension:
|
Validate your extension before you share or publish it. Validating the extension ensures that the extension:
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Interacting with Kubernetes from an extension
|
title: Interacting with Kubernetes from an extension
|
||||||
|
linkTitle: Interacting with Kubernetes
|
||||||
description: How to connect to a Kubernetes cluster from an extension
|
description: How to connect to a Kubernetes cluster from an extension
|
||||||
keywords: Docker, Extensions, sdk, Kubernetes
|
keywords: Docker, Extensions, sdk, Kubernetes
|
||||||
aliases:
|
aliases:
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
---
|
---
|
||||||
title: OAuth 2.0 flow
|
title: Authentication
|
||||||
description: Docker extension OAuth 2.0 flow
|
description: Docker extension OAuth 2.0 flow
|
||||||
keywords: Docker, extensions, sdk, OAuth 2.0
|
keywords: Docker, extensions, sdk, OAuth 2.0
|
||||||
aliases:
|
aliases:
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
---
|
---
|
||||||
title: Use the Docker socket from the extension backend
|
title: Use the Docker socket from the extension backend
|
||||||
|
linkTitle: Use the Docker socket
|
||||||
description: Docker extension metadata
|
description: Docker extension metadata
|
||||||
keywords: Docker, extensions, sdk, metadata
|
keywords: Docker, extensions, sdk, metadata
|
||||||
aliases:
|
aliases:
|
||||||
|
|
|
@ -4,6 +4,7 @@ title: The build and publish process
|
||||||
keyword: Docker Extensions, sdk, build, create, publish
|
keyword: Docker Extensions, sdk, build, create, publish
|
||||||
aliases:
|
aliases:
|
||||||
- /desktop/extensions-sdk/process/
|
- /desktop/extensions-sdk/process/
|
||||||
|
weight: 10
|
||||||
---
|
---
|
||||||
|
|
||||||
This documentation is structured so that it matches the steps you need to take when creating your extension.
|
This documentation is structured so that it matches the steps you need to take when creating your extension.
|
||||||
|
|
|
@ -5,6 +5,7 @@ keywords: quickstart, extensions
|
||||||
aliases:
|
aliases:
|
||||||
- desktop/extensions-sdk/tutorials/initialize/
|
- desktop/extensions-sdk/tutorials/initialize/
|
||||||
- /desktop/extensions-sdk/quickstart/
|
- /desktop/extensions-sdk/quickstart/
|
||||||
|
weight: 20
|
||||||
---
|
---
|
||||||
|
|
||||||
Follow this guide to get started with creating a basic Docker extension. The Quickstart guide automatically generates boilerplate files for you.
|
Follow this guide to get started with creating a basic Docker extension. The Quickstart guide automatically generates boilerplate files for you.
|
||||||
|
|
|
@ -2,7 +2,7 @@
|
||||||
description: Extensions
|
description: Extensions
|
||||||
keywords: Docker Extensions, Docker Desktop, Linux, Mac, Windows, Marketplace
|
keywords: Docker Extensions, Docker Desktop, Linux, Mac, Windows, Marketplace
|
||||||
title: Marketplace extensions
|
title: Marketplace extensions
|
||||||
weight: 100
|
weight: 10
|
||||||
aliases:
|
aliases:
|
||||||
- /desktop/extensions/marketplace/
|
- /desktop/extensions/marketplace/
|
||||||
---
|
---
|
||||||
|
|
|
@ -1,8 +1,8 @@
|
||||||
---
|
---
|
||||||
description: Extensions
|
description: Extensions
|
||||||
keywords: Docker Extensions, Docker Desktop, Linux, Mac, Windows,
|
keywords: Docker Extensions, Docker Desktop, Linux, Mac, Windows,
|
||||||
title: Non-Marketplace extensions
|
title: Non-marketplace extensions
|
||||||
weight: 100
|
weight: 20
|
||||||
aliases:
|
aliases:
|
||||||
- /desktop/extensions/non-marketplace/
|
- /desktop/extensions/non-marketplace/
|
||||||
---
|
---
|
||||||
|
|
|
@ -2,7 +2,8 @@
|
||||||
description: How to configure and use Docker Extensions' private marketplace
|
description: How to configure and use Docker Extensions' private marketplace
|
||||||
keywords: Docker Extensions, Docker Desktop, Linux, Mac, Windows, Marketplace, private, security
|
keywords: Docker Extensions, Docker Desktop, Linux, Mac, Windows, Marketplace, private, security
|
||||||
title: Configure a private marketplace for extensions
|
title: Configure a private marketplace for extensions
|
||||||
weight: 100
|
linkTitle: Configure a private marketplace
|
||||||
|
weight: 30
|
||||||
aliases:
|
aliases:
|
||||||
- /desktop/extensions/private-marketplace/
|
- /desktop/extensions/private-marketplace/
|
||||||
---
|
---
|
||||||
|
|
|
@ -2,7 +2,8 @@
|
||||||
description: Extensions
|
description: Extensions
|
||||||
keywords: Docker Extensions, Docker Desktop, Linux, Mac, Windows, feedback
|
keywords: Docker Extensions, Docker Desktop, Linux, Mac, Windows, feedback
|
||||||
title: Settings and feedback for Docker Extensions
|
title: Settings and feedback for Docker Extensions
|
||||||
weight: 100
|
linkTitle: Settings and feedback
|
||||||
|
weight: 40
|
||||||
aliases:
|
aliases:
|
||||||
- /desktop/extensions/settings-feedback/
|
- /desktop/extensions/settings-feedback/
|
||||||
---
|
---
|
||||||
|
|
Loading…
Reference in New Issue