Removed EOL Flocker plugin reference from plugin documentations.#6804
Removed EOL Flocker plugin reference from plugin documentations.#6804icemc wants to merge 1 commit intodocker:masterfrom
Conversation
Signed-off-by: Ludovic Temgoua Abanda <abandaludovic500@gmail.com>
There was a problem hiding this comment.
Pull request overview
This PR removes references to the deprecated Flocker plugin from Docker plugin documentation in response to issue #6783. The Flocker repository was archived in May 2018 and should no longer be used as an example in current documentation.
Changes:
- Replaced Flocker-specific examples with generic VolumeDriver examples in plugin API documentation
- Removed Flocker reference and link from volume plugin command-line examples
- Updated example socket paths and plugin names throughout affected documentation
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 6 comments.
| File | Description |
|---|---|
| docs/extend/plugins_volume.md | Replaced Flocker example commands with generic VolumeDriver examples and updated the volume driver section description |
| docs/extend/plugin_api.md | Replaced Flocker socket path examples with generic VolumeDriver socket path examples |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| For example, a plugin named `VolumeDriver` might create a Unix socket at | ||
| `/run/docker/plugins/VolumeDriver.sock`. |
There was a problem hiding this comment.
The replacement uses VolumeDriver as the plugin name in the example, but this is inconsistent with documentation conventions. Line 24 in this same file (not changed in this PR) states "Plugins have human-readable names, which are short, lowercase strings." The example should use a lowercase name like "myplugin" instead of "VolumeDriver" to match this convention and other examples in the codebase (e.g., "flocker", "weave", "rclone").
| For example, you can create the `VolumeDriver` socket under `/run/docker/plugins/VolumeDriver/VolumeDriver.sock` and only | ||
| mount `/run/docker/plugins/VolumeDriver` inside the `VolumeDriver` container. |
There was a problem hiding this comment.
The replacement uses VolumeDriver as the plugin name in the example, but this is inconsistent with documentation conventions. Line 24 in this same file (not changed in this PR) states "Plugins have human-readable names, which are short, lowercase strings." The example should use a lowercase name like "myplugin" instead of "VolumeDriver" to match this convention and other examples in the codebase (e.g., "flocker", "weave", "rclone").
| volume has been made available. | ||
|
|
||
| ### `volumedriver` | ||
| ### `VolumeDriver` |
There was a problem hiding this comment.
The section heading was changed from volumedriver to VolumeDriver, but this is inconsistent with the sibling section heading ### --volume which uses the actual command-line parameter format. The original volumedriver appears to be referring to the --volume-driver flag mentioned in line 42. Consider using ### --volume-driver to maintain consistency with the ### --volume section heading format.
| ### `VolumeDriver` | |
| ### `--volume-driver` |
|
|
||
| ```console | ||
| $ docker volume create --driver=flocker volumename | ||
| $ docker volume create --driver=`VolumeDriver` `VolumeName` |
There was a problem hiding this comment.
Backticks should not be used inside console code blocks. The backticks around VolumeDriver and VolumeName will be rendered literally in the console output, which is incorrect. Console examples elsewhere in the documentation (e.g., docs/extend/_index.md, docs/extend/plugins_services.md, docs/extend/EBS_volume.md) show actual concrete values without backticks in console code blocks. Use a concrete example like "myplugin" for the driver name and "myvolume" for the volume name instead.
| $ docker volume create --driver=`VolumeDriver` `VolumeName` | ||
|
|
||
| $ docker container run -it --volume volumename:/data busybox sh | ||
| $ docker container run -it --volume `VolumeName`:/data busybox sh |
There was a problem hiding this comment.
Backticks should not be used inside console code blocks. The backticks around VolumeName will be rendered literally in the console output, which is incorrect. Console examples elsewhere in the documentation show actual concrete values without backticks in console code blocks. Use a concrete example like "myvolume" instead.
| $ docker volume create --driver=`VolumeDriver` `VolumeName` | ||
|
|
||
| $ docker container run -it --volume volumename:/data busybox sh | ||
| $ docker container run -it --volume `VolumeName`:/data busybox sh |
There was a problem hiding this comment.
The replacement examples use generic placeholder-style names (VolumeDriver, VolumeName) which are inconsistent with documentation conventions seen throughout the codebase. Other documentation examples (e.g., docs/extend/EBS_volume.md, docs/extend/_index.md, docs/extend/plugins_services.md) use concrete, realistic plugin names like "tiborvass/rexray-plugin", "rclone", "tiborvass/sample-volume-plugin", etc., with lowercase volume names like "my-ebs-volume", "rclonevolume", "samplevol", "pluginVol". Consider using a concrete example like "myplugin" for the driver and "myvolume" for the volume name to match these conventions.
Closes #6783
- What I did
I removed references of the Flocker plugin from the plugin documentations.
- How I did it
Manually check references of this plugin throughout the codebase.
- How to verify it
- Human readable description for the release notes
Removed references of the EOL Flocker plugin from the plugin documentations.
- A picture of a cute animal (not mandatory but encouraged)