docker plugin upgrade is not explained well
Open
Nobody has claimed this yet.
area/plugins
kind/docs
- Dominant language
- Go
- Stars
- 6.1k
- Forks
- 2.2k
- Avg merge
- 1d 15h
- Merged PRs (30d)
- 43
Description
@cjellick commented on Tue Sep 05 2017
I think this doc could be improved by doing the following:
- Explaining how is the version of the plugin picked when the plugin is first installed
- Not using the same version that is already installed in the upgrade command
There also seems to be an inconsistency:
The install command doesnt mention version:
docker plugin install vieux/sshfs DEBUG=1
but everything else does:
docker plugin disable -f vieux/sshfs:next
docker plugin upgrade vieux/sshfs:next vieux/sshfs:next
docker plugin enable vieux/sshfs:next
File: engine/reference/commandline/plugin_upgrade.md, CC @mstanleyjones
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with engine/reference/commandline/plugin_upgrade.md and compare its install, disable, upgrade, and enable examples. Clarify how Docker selects a plugin version on first install and make the upgrade example use an appropriate version rather than repeating the installed one. Done means the version behavior and command examples are consistent and understandable.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker
- Domain
- cli, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 55/100