Skip to content

Commit 55b57be

Browse files
authored
docs: Added details on plugin name and plugin alias standards in guide (#353)
* docs: Added details on plugin name and plugin alias standards in guide * docs(guide): Fixed wording and spelling * docs: Fixed grammer
1 parent 45fe098 commit 55b57be

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

docs/plugin_developer_guide.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,9 @@ IBM Cloud CLI SDK provides a set of APIs to register and manage plug-ins. It als
7474

7575
**Understanding the fields in this `plugin.PluginMetadata` struct:**
7676
- _Name_: The name of plug-in. It will be displayed when using `ibmcloud plugin list` command or can be used to uninstall the plug-in through `ibmcloud plugin uninstall` command.
77+
- It is **strongly** encouraged to use a name that best describes the service the plug-in provides.
78+
- _Aliases_: A list of short names of the plug-in that can be used as a stand-in for installing, updating, uninstalling and using the plug-in.
79+
- It is strongly recommended that you have at least one alias to improve the usability of the plug-in.
7780
- _Version_: The version of plug-in.
7881
- _MinCliVersion_: The minimal version of IBM Cloud CLI required by the plug-in.
7982
- _PrivateEndpointSupported_: Indicates if the plug-in is designed to also be used over the private network.

0 commit comments

Comments
 (0)