Skip to content
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.

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

Removing CLI plugins API documentation #2534

Merged
merged 1 commit into from
May 19, 2020

Conversation

silvin-lubecki
Copy link
Contributor

- What I did
Adding depreciation notice for the CLI Plugins API.

- A picture of a cute animal (not mandatory but encouraged)

image

… it is now deprecated.

Adding depreciation notice.

Signed-off-by: Silvin Lubecki <[email protected]>
@silvin-lubecki silvin-lubecki requested a review from thaJeztah May 19, 2020 08:43
Copy link
Member

@chris-crone chris-crone left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@thaJeztah thaJeztah left a comment

Choose a reason for hiding this comment

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

LGTM

@@ -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

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

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.

@SvenDowideit
Copy link
Contributor

Can someone please provide more context for this? - if you're going to deprecate something we use (and we do), we'd like to know a reason, if there's a plan to replace it, or whatever....

I was working towards simplifying internal use of more complicated workflows using cli plugins, but this kinda comes out of the blue for me.

I presume there is more context :)

@chris-crone
Copy link
Member

Hi @SvenDowideit,

I gave some context here and there is discussion there.

Essentially we do not want to fragment the Docker CLI UX and plugins as they are currently structured will cause that. Paths forward are to upstream features that make sense to be upstreamed or build standalone tools for things that are too niche. We are looking at how to make our platform more extendable and this feedback helps us do so.

@SvenDowideit
Copy link
Contributor

mmm, I guess the saddest thing is that there wasn't a GitHub discussion about this - I felt that the CLI plugins were the best step to allow users to prototype ideas to make sure they were worth the work to upstream - and a great place for site specific tooling.

Removing the documentation when the API is deprecated is also not really right - the process (er, used to be) to not remove until after the deprecation period was up - as it makes it hard to debug and fix existing and working plugins - it basically mind-wipes the docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants