From b1e50eea9275f5906b077b6d6d43b1278e8c3034 Mon Sep 17 00:00:00 2001 From: David Karlsson <35727626+dvdksn@users.noreply.github.com> Date: Wed, 4 Sep 2024 11:19:55 +0200 Subject: [PATCH] docs: rename plugins index file and add linkTitle We publish this page on docs.docker.com, and hugo expects index pages for sections to be named _index.md. We currently rename the page when we mount it to the docs repo but might as well change the filename in the source. Also adds a linkTitle to the page, which is a shorter title that will be used in the sidebar navigation and breadcrumbs. Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> (cherry picked from commit 071f6f939197b29dee3e17baf5498a8fdadcf0b5) Signed-off-by: David Karlsson <35727626+dvdksn@users.noreply.github.com> --- docs/extend/{index.md => _index.md} | 1 + docs/extend/legacy_plugins.md | 4 ++-- docs/extend/plugin_api.md | 2 +- docs/extend/plugins_authorization.md | 2 +- docs/extend/plugins_network.md | 6 +++--- 5 files changed, 8 insertions(+), 7 deletions(-) rename docs/extend/{index.md => _index.md} (99%) diff --git a/docs/extend/index.md b/docs/extend/_index.md similarity index 99% rename from docs/extend/index.md rename to docs/extend/_index.md index 8a4f9885d7..57528444d1 100644 --- a/docs/extend/index.md +++ b/docs/extend/_index.md @@ -1,5 +1,6 @@ --- title: Docker Engine managed plugin system +linkTitle: Docker Engine plugins description: Develop and use a plugin with the managed plugin system keywords: "API, Usage, plugins, documentation, developer" aliases: diff --git a/docs/extend/legacy_plugins.md b/docs/extend/legacy_plugins.md index 830a7dce9c..2c6ba4bc1a 100644 --- a/docs/extend/legacy_plugins.md +++ b/docs/extend/legacy_plugins.md @@ -8,7 +8,7 @@ keywords: "Examples, Usage, plugins, docker, documentation, user guide" This document describes the Docker Engine plugins generally available in Docker Engine. To view information on plugins managed by Docker, -refer to [Docker Engine plugin system](index.md). +refer to [Docker Engine plugin system](_index.md). You can extend the capabilities of the Docker Engine by loading third-party plugins. This page explains the types of plugins and provides links to several @@ -16,7 +16,7 @@ volume and network plugins for Docker. ## Types of plugins -Plugins extend Docker's functionality. They come in specific types. For +Plugins extend Docker's functionality. They come in specific types. For example, a [volume plugin](plugins_volume.md) might enable Docker volumes to persist across multiple Docker hosts and a [network plugin](plugins_network.md) might provide network plumbing. diff --git a/docs/extend/plugin_api.md b/docs/extend/plugin_api.md index 4600992c4e..a0b0a73675 100644 --- a/docs/extend/plugin_api.md +++ b/docs/extend/plugin_api.md @@ -8,7 +8,7 @@ Docker plugins are out-of-process extensions which add capabilities to the Docker Engine. This document describes the Docker Engine plugin API. To view information on -plugins managed by Docker Engine, refer to [Docker Engine plugin system](index.md). +plugins managed by Docker Engine, refer to [Docker Engine plugin system](_index.md). This page is intended for people who want to develop their own Docker plugin. If you just want to learn about or use Docker plugins, look diff --git a/docs/extend/plugins_authorization.md b/docs/extend/plugins_authorization.md index 1fc6f78441..b8678debd5 100644 --- a/docs/extend/plugins_authorization.md +++ b/docs/extend/plugins_authorization.md @@ -8,7 +8,7 @@ aliases: This document describes the Docker Engine plugins available in Docker Engine. To view information on plugins managed by Docker Engine, -refer to [Docker Engine plugin system](index.md). +refer to [Docker Engine plugin system](_index.md). Docker's out-of-the-box authorization model is all or nothing. Any user with permission to access the Docker daemon can run any Docker client command. The diff --git a/docs/extend/plugins_network.md b/docs/extend/plugins_network.md index e24fd26257..8f94546b01 100644 --- a/docs/extend/plugins_network.md +++ b/docs/extend/plugins_network.md @@ -6,12 +6,12 @@ keywords: "Examples, Usage, plugins, docker, documentation, user guide" This document describes Docker Engine network driver plugins generally available in Docker Engine. To view information on plugins -managed by Docker Engine, refer to [Docker Engine plugin system](index.md). +managed by Docker Engine, refer to [Docker Engine plugin system](_index.md). Docker Engine network plugins enable Engine deployments to be extended to support a wide range of networking technologies, such as VXLAN, IPVLAN, MACVLAN or something completely different. Network driver plugins are supported via the -LibNetwork project. Each plugin is implemented as a "remote driver" for +LibNetwork project. Each plugin is implemented as a "remote driver" for LibNetwork, which shares plugin infrastructure with Engine. Effectively, network driver plugins are activated in the same way as other plugins, and use the same kind of protocol. @@ -19,7 +19,7 @@ kind of protocol. ## Network plugins and Swarm mode [Legacy plugins](legacy_plugins.md) do not work in Swarm mode. However, -plugins written using the [v2 plugin system](index.md) do work in Swarm mode, as +plugins written using the [v2 plugin system](_index.md) do work in Swarm mode, as long as they are installed on each Swarm worker node. ## Use network driver plugins