Skip to content

Removing CLI plugins API documentation #2534

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
thaJeztah merged 1 commit into from
May 19, 2020
Merged

Removing CLI plugins API documentation #2534

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion cli-plugins/manager/metadata.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ const (
MetadataSubcommandName = "docker-cli-plugin-metadata"
)

// Metadata provided by the plugin. See docs/extend/cli_plugins.md for canonical information.
// Metadata provided by the plugin.
type Metadata struct {
// SchemaVersion describes the version of this struct. Mandatory, must be "0.1.0"
SchemaVersion string `json:",omitempty"`
Expand Down
6 changes: 6 additions & 0 deletions docs/deprecated.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ The table below provides an overview of the current status of deprecated feature

Status | Feature | Deprecated | Remove
-----------|------------------------------------------------------------------------------------------------------------------------------------|------------|------------
Deprecated | [CLI plugins support](#cli-plugins-support) | v20.03.0 | -
Copy link
Contributor

@tao12345666333 tao12345666333 Jun 28, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sorry for disturbing you.

Does the deprecated CLI plugins support mean not to open this function to users (it is not recommended that users develop their own plugins), or does it mean that its function will be completely removed? For example docker buildx?

Copy link
Member

@thaJeztah thaJeztah Jun 28, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It won't be removed (at least not in the short term) so that (e.g.) buildx can continue to work.

Deprecated | [Pushing and pulling with image manifest v2 schema 1](#pushing-and-pulling-with-image-manifest-v2-schema-1) | v19.03.0 | v20.03.0
Removed | [`docker engine` subcommands](#docker-engine-subcommands) | v19.03.0 | v20.03.0
Removed | [Top-level `docker deploy` subcommand (experimental)](#top-level-docker-deploy-subcommand-experimental) | v19.03.0 | v20.03.0
Expand Down Expand Up @@ -87,6 +88,11 @@ Removed | [`--api-enable-cors` flag on `dockerd`](#--api-enable-cors-flag-on-
Removed | [`--run` flag on `docker commit`](#--run-flag-on-docker-commit) | v0.10.0 | v1.13.0
Removed | [Three arguments form in `docker import`](#three-arguments-form-in-docker-import) | v0.6.7 | v1.12.0

### CLI plugins support

**Deprecated in Release: v20.03.0**

CLI Plugin API is now marked as deprecated.

### Pushing and pulling with image manifest v2 schema 1

Expand Down
124 changes: 0 additions & 124 deletions docs/extend/cli_plugins.md
View file
Open in desktop

This file was deleted.