From 707144d3585391006420174dc9196bc4dfc1f689 Mon Sep 17 00:00:00 2001 From: Ben Schumacher Date: Thu, 24 Oct 2024 14:03:21 +0200 Subject: [PATCH] [MM-61132] Fix example for mmctl permissions role show command (#28816) --- server/cmd/mmctl/commands/channel.go | 16 ++++++++-------- server/cmd/mmctl/commands/command.go | 2 +- server/cmd/mmctl/commands/permissions.go | 2 +- server/cmd/mmctl/commands/permissions_role.go | 2 +- .../mmctl/docs/mmctl_permissions_role_show.rst | 2 +- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/server/cmd/mmctl/commands/channel.go b/server/cmd/mmctl/commands/channel.go index fe02a499cf9..02a73eb3b14 100644 --- a/server/cmd/mmctl/commands/channel.go +++ b/server/cmd/mmctl/commands/channel.go @@ -51,7 +51,7 @@ var RemoveChannelUsersCmd = &cobra.Command{ Long: "Remove some users from channel", Example: ` channel remove myteam:mychannel user@example.com username channel remove myteam:mychannel --all-users`, - Deprecated: "please use \"users remove\" instead", + Deprecated: "please use \"mmctl channel users remove\" instead", RunE: withClient(channelUsersRemoveCmdF), } @@ -60,7 +60,7 @@ var AddChannelUsersCmd = &cobra.Command{ Short: "Add users to channel", Long: "Add some users to channel", Example: " channel add myteam:mychannel user@example.com username", - Deprecated: "please use \"users add\" instead", + Deprecated: "please use \"mmctl channel users add\" instead", RunE: withClient(channelUsersAddCmdF), } @@ -108,13 +108,13 @@ Channel can be specified by [team]:[channel]. ie. myteam:mychannel or by channel } var RestoreChannelsCmd = &cobra.Command{ - Use: "restore [channels]", - Deprecated: "please use \"unarchive\" instead", - Short: "Restore some channels", + Use: "restore [channels]", + Short: "Restore some channels", Long: `Restore a previously deleted channel Channels can be specified by [team]:[channel]. ie. myteam:mychannel or by channel ID.`, - Example: " channel restore myteam:mychannel", - RunE: withClient(unarchiveChannelsCmdF), + Example: " channel restore myteam:mychannel", + Deprecated: "please use \"mmctl channel unarchive\" instead", + RunE: withClient(unarchiveChannelsCmdF), } var UnarchiveChannelCmd = &cobra.Command{ @@ -133,7 +133,7 @@ var MakeChannelPrivateCmd = &cobra.Command{ Long: `Set the type of a channel from Public to Private. Channel can be specified by [team]:[channel]. ie. myteam:mychannel or by channel ID.`, Example: " channel make-private myteam:mychannel", - Deprecated: "please use \"channel modify --private\" instead", + Deprecated: "please use \"mmctl channel modify --private\" instead", RunE: withClient(makeChannelPrivateCmdF), } diff --git a/server/cmd/mmctl/commands/command.go b/server/cmd/mmctl/commands/command.go index fa08b98f5ab..eb157073931 100644 --- a/server/cmd/mmctl/commands/command.go +++ b/server/cmd/mmctl/commands/command.go @@ -45,7 +45,7 @@ var CommandDeleteCmd = &cobra.Command{ Short: "Delete a slash command", Long: `Delete a slash command. Commands can be specified by command ID.`, Example: ` command delete commandID`, - Deprecated: "please use \"archive\" instead", + Deprecated: "please use \"mmctl channel archive\" instead", Args: cobra.ExactArgs(1), RunE: withClient(archiveCommandCmdF), } diff --git a/server/cmd/mmctl/commands/permissions.go b/server/cmd/mmctl/commands/permissions.go index 2f70ed5971f..83d625f98bc 100644 --- a/server/cmd/mmctl/commands/permissions.go +++ b/server/cmd/mmctl/commands/permissions.go @@ -42,7 +42,7 @@ var RemovePermissionsCmd = &cobra.Command{ var ShowRoleCmd = &cobra.Command{ Use: "show ", - Deprecated: "please use \"role show\" instead", + Deprecated: "please use \"mmctl permissions role show\" instead", Short: "Show the role information", Long: "Show all the information about a role.", Example: ` permissions show system_user`, diff --git a/server/cmd/mmctl/commands/permissions_role.go b/server/cmd/mmctl/commands/permissions_role.go index b59c4feefb5..b15a1f6d39a 100644 --- a/server/cmd/mmctl/commands/permissions_role.go +++ b/server/cmd/mmctl/commands/permissions_role.go @@ -28,7 +28,7 @@ var ShowCmd = &cobra.Command{ Use: "show ", Short: "Show the role information", Long: "Show all the information about a role.", - Example: ` permissions show system_user`, + Example: ` permissions role show system_user`, Args: cobra.ExactArgs(1), RunE: withClient(showRoleCmdF), } diff --git a/server/cmd/mmctl/docs/mmctl_permissions_role_show.rst b/server/cmd/mmctl/docs/mmctl_permissions_role_show.rst index c9433e36bcf..865a9752baa 100644 --- a/server/cmd/mmctl/docs/mmctl_permissions_role_show.rst +++ b/server/cmd/mmctl/docs/mmctl_permissions_role_show.rst @@ -20,7 +20,7 @@ Examples :: - permissions show system_user + permissions role show system_user Options ~~~~~~~