fix: optimization details

Signed-off-by: Xinwei Xiong(cubxxw-openim) <3293172751nss@gmail.com>
1 year ago · f7bd391ed7
parent 6484c32e26
commit f7bd391ed7
4 changed files with 83 additions and 84 deletions
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@ -305,7 +305,6 @@ The documentation for Open-IM-Server includes:

 + [README.md](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/README.md): This file includes the basic information and instructions for getting started with Open-IM-Server.
 + [CONTRIBUTING.md](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/CONTRIBUTING.md): This file contains guidelines for contributing to Open-IM-Server's codebase, such as how to submit issues, pull requests, and code reviews.
-+ [DEVELOPGUIDE.md](https://github.com/OpenIMSDK/.github/blob/main/DEVELOPGUIDE.md): This file provides a more in-depth guide to developing Open-IM-Server, including information on the project's architecture, coding conventions, and testing practices.
 + [Official Documentation](https://doc.rentsoft.cn/): This is the official documentation for Open-IM-Server, which includes comprehensive information on all of its features, configuration options, and troubleshooting tips.

 Please obey the following rules to better format the docs, which would greatly improve the reading experience.
--- a/8
+++ b/8
@ -39,11 +39,11 @@ Options:

  BINS             Binaries to build. Default is all binaries under cmd.
                   This option is available when using: make {build}(.multiarch)
-                   Example: make build BINS="openim_api openim_cms_api".
+                   Example: make build BINS="openim_api openim_cmdutils".

  PLATFORMS        Platform to build for. Default is linux_arm64 and linux_amd64.
                   This option is available when using: make {build}.multiarch
-                   Example: make multiarch PLATFORMS="linux_s390x linux_mips64 
+                   Example: make multiarch PLATFORMS="linux_s390x linux_mips64
                   linux_mips64le darwin_amd64 windows_amd64 linux_amd64 linux_arm64".

  V                Set to 1 enable verbose build. Default is 0.
@ -107,11 +107,11 @@ test:
 cover:
 	@$(MAKE) go.test.cover

-## updates: Check for updates to go.mod dependencies ✨
+## updates: Check for updates to go.mod dependencies. ✨
 .PHONY: updates
 	@$(MAKE) go.updates

-## imports: task to automatically handle import packages in Go files using goimports tool ✨
+## imports: task to automatically handle import packages in Go files using goimports tool. ✨
 .PHONY: imports
 imports:
 	@$(MAKE) go.imports
--- a/docs/.generated_docs
+++ b/docs/.generated_docs
@ -3,82 +3,82 @@ docs/guide/en-US/cmd/iam-apiserver.md
 docs/guide/en-US/cmd/iam-authz-server.md
 docs/guide/en-US/cmd/iam-pump.md
 docs/guide/en-US/cmd/iam-watcher.md
-docs/guide/en-US/cmd/iamctl/iamctl.md
-docs/guide/en-US/cmd/iamctl/iamctl_color.md
-docs/guide/en-US/cmd/iamctl/iamctl_completion.md
-docs/guide/en-US/cmd/iamctl/iamctl_info.md
-docs/guide/en-US/cmd/iamctl/iamctl_jwt.md
-docs/guide/en-US/cmd/iamctl/iamctl_jwt_show.md
-docs/guide/en-US/cmd/iamctl/iamctl_jwt_sign.md
-docs/guide/en-US/cmd/iamctl/iamctl_jwt_verify.md
-docs/guide/en-US/cmd/iamctl/iamctl_new.md
-docs/guide/en-US/cmd/iamctl/iamctl_options.md
-docs/guide/en-US/cmd/iamctl/iamctl_policy.md
-docs/guide/en-US/cmd/iamctl/iamctl_policy_create.md
-docs/guide/en-US/cmd/iamctl/iamctl_policy_delete.md
-docs/guide/en-US/cmd/iamctl/iamctl_policy_get.md
-docs/guide/en-US/cmd/iamctl/iamctl_policy_list.md
-docs/guide/en-US/cmd/iamctl/iamctl_policy_update.md
-docs/guide/en-US/cmd/iamctl/iamctl_secret.md
-docs/guide/en-US/cmd/iamctl/iamctl_secret_create.md
-docs/guide/en-US/cmd/iamctl/iamctl_secret_delete.md
-docs/guide/en-US/cmd/iamctl/iamctl_secret_get.md
-docs/guide/en-US/cmd/iamctl/iamctl_secret_list.md
-docs/guide/en-US/cmd/iamctl/iamctl_secret_update.md
-docs/guide/en-US/cmd/iamctl/iamctl_set.md
-docs/guide/en-US/cmd/iamctl/iamctl_user.md
-docs/guide/en-US/cmd/iamctl/iamctl_user_create.md
-docs/guide/en-US/cmd/iamctl/iamctl_user_delete.md
-docs/guide/en-US/cmd/iamctl/iamctl_user_get.md
-docs/guide/en-US/cmd/iamctl/iamctl_user_list.md
-docs/guide/en-US/cmd/iamctl/iamctl_user_update.md
-docs/guide/en-US/cmd/iamctl/iamctl_validate.md
-docs/guide/en-US/cmd/iamctl/iamctl_version.md
-docs/guide/en-US/yaml/iamctl/iamctl.yaml
-docs/guide/en-US/yaml/iamctl/iamctl_color.yaml
-docs/guide/en-US/yaml/iamctl/iamctl_completion.yaml
-docs/guide/en-US/yaml/iamctl/iamctl_info.yaml
-docs/guide/en-US/yaml/iamctl/iamctl_jwt.yaml
-docs/guide/en-US/yaml/iamctl/iamctl_new.yaml
-docs/guide/en-US/yaml/iamctl/iamctl_options.yaml
-docs/guide/en-US/yaml/iamctl/iamctl_policy.yaml
-docs/guide/en-US/yaml/iamctl/iamctl_secret.yaml
-docs/guide/en-US/yaml/iamctl/iamctl_set.yaml
-docs/guide/en-US/yaml/iamctl/iamctl_user.yaml
-docs/guide/en-US/yaml/iamctl/iamctl_validate.yaml
-docs/guide/en-US/yaml/iamctl/iamctl_version.yaml
+docs/guide/en-US/cmd/openim/openim.md
+docs/guide/en-US/cmd/openim/openim_color.md
+docs/guide/en-US/cmd/openim/openim_completion.md
+docs/guide/en-US/cmd/openim/openim_info.md
+docs/guide/en-US/cmd/openim/openim_jwt.md
+docs/guide/en-US/cmd/openim/openim_jwt_show.md
+docs/guide/en-US/cmd/openim/openim_jwt_sign.md
+docs/guide/en-US/cmd/openim/openim_jwt_verify.md
+docs/guide/en-US/cmd/openim/openim_new.md
+docs/guide/en-US/cmd/openim/openim_options.md
+docs/guide/en-US/cmd/openim/openim_policy.md
+docs/guide/en-US/cmd/openim/openim_policy_create.md
+docs/guide/en-US/cmd/openim/openim_policy_delete.md
+docs/guide/en-US/cmd/openim/openim_policy_get.md
+docs/guide/en-US/cmd/openim/openim_policy_list.md
+docs/guide/en-US/cmd/openim/openim_policy_update.md
+docs/guide/en-US/cmd/openim/openim_secret.md
+docs/guide/en-US/cmd/openim/openim_secret_create.md
+docs/guide/en-US/cmd/openim/openim_secret_delete.md
+docs/guide/en-US/cmd/openim/openim_secret_get.md
+docs/guide/en-US/cmd/openim/openim_secret_list.md
+docs/guide/en-US/cmd/openim/openim_secret_update.md
+docs/guide/en-US/cmd/openim/openim_set.md
+docs/guide/en-US/cmd/openim/openim_user.md
+docs/guide/en-US/cmd/openim/openim_user_create.md
+docs/guide/en-US/cmd/openim/openim_user_delete.md
+docs/guide/en-US/cmd/openim/openim_user_get.md
+docs/guide/en-US/cmd/openim/openim_user_list.md
+docs/guide/en-US/cmd/openim/openim_user_update.md
+docs/guide/en-US/cmd/openim/openim_validate.md
+docs/guide/en-US/cmd/openim/openim_version.md
+docs/guide/en-US/yaml/openim/openim.yaml
+docs/guide/en-US/yaml/openim/openim_color.yaml
+docs/guide/en-US/yaml/openim/openim_completion.yaml
+docs/guide/en-US/yaml/openim/openim_info.yaml
+docs/guide/en-US/yaml/openim/openim_jwt.yaml
+docs/guide/en-US/yaml/openim/openim_new.yaml
+docs/guide/en-US/yaml/openim/openim_options.yaml
+docs/guide/en-US/yaml/openim/openim_policy.yaml
+docs/guide/en-US/yaml/openim/openim_secret.yaml
+docs/guide/en-US/yaml/openim/openim_set.yaml
+docs/guide/en-US/yaml/openim/openim_user.yaml
+docs/guide/en-US/yaml/openim/openim_validate.yaml
+docs/guide/en-US/yaml/openim/openim_version.yaml
 docs/man/man1/iam-apiserver.1
 docs/man/man1/iam-authz-server.1
 docs/man/man1/iam-pump.1
 docs/man/man1/iam-watcher.1
-docs/man/man1/iamctl-color.1
-docs/man/man1/iamctl-completion.1
-docs/man/man1/iamctl-info.1
-docs/man/man1/iamctl-jwt-show.1
-docs/man/man1/iamctl-jwt-sign.1
-docs/man/man1/iamctl-jwt-verify.1
-docs/man/man1/iamctl-jwt.1
-docs/man/man1/iamctl-new.1
-docs/man/man1/iamctl-options.1
-docs/man/man1/iamctl-policy-create.1
-docs/man/man1/iamctl-policy-delete.1
-docs/man/man1/iamctl-policy-get.1
-docs/man/man1/iamctl-policy-list.1
-docs/man/man1/iamctl-policy-update.1
-docs/man/man1/iamctl-policy.1
-docs/man/man1/iamctl-secret-create.1
-docs/man/man1/iamctl-secret-delete.1
-docs/man/man1/iamctl-secret-get.1
-docs/man/man1/iamctl-secret-list.1
-docs/man/man1/iamctl-secret-update.1
-docs/man/man1/iamctl-secret.1
-docs/man/man1/iamctl-set.1
-docs/man/man1/iamctl-user-create.1
-docs/man/man1/iamctl-user-delete.1
-docs/man/man1/iamctl-user-get.1
-docs/man/man1/iamctl-user-list.1
-docs/man/man1/iamctl-user-update.1
-docs/man/man1/iamctl-user.1
-docs/man/man1/iamctl-validate.1
-docs/man/man1/iamctl-version.1
-docs/man/man1/iamctl.1
+docs/man/man1/openim-color.1
+docs/man/man1/openim-completion.1
+docs/man/man1/openim-info.1
+docs/man/man1/openim-jwt-show.1
+docs/man/man1/openim-jwt-sign.1
+docs/man/man1/openim-jwt-verify.1
+docs/man/man1/openim-jwt.1
+docs/man/man1/openim-new.1
+docs/man/man1/openim-options.1
+docs/man/man1/openim-policy-create.1
+docs/man/man1/openim-policy-delete.1
+docs/man/man1/openim-policy-get.1
+docs/man/man1/openim-policy-list.1
+docs/man/man1/openim-policy-update.1
+docs/man/man1/openim-policy.1
+docs/man/man1/openim-secret-create.1
+docs/man/man1/openim-secret-delete.1
+docs/man/man1/openim-secret-get.1
+docs/man/man1/openim-secret-list.1
+docs/man/man1/openim-secret-update.1
+docs/man/man1/openim-secret.1
+docs/man/man1/openim-set.1
+docs/man/man1/openim-user-create.1
+docs/man/man1/openim-user-delete.1
+docs/man/man1/openim-user-get.1
+docs/man/man1/openim-user-list.1
+docs/man/man1/openim-user-update.1
+docs/man/man1/openim-user.1
+docs/man/man1/openim-validate.1
+docs/man/man1/openim-version.1
+docs/man/man1/openim.1
--- a/scripts/lib/color.sh
+++ b/scripts/lib/color.sh
@ -14,18 +14,18 @@
 # limitations under the License.


-#Define color variables
-#Feature
+# Define color variables
+# Feature
 COLOR_NORMAL='\033[0m';COLOR_BOLD='\033[1m';COLOR_DIM='\033[2m';COLOR_UNDER='\033[4m';
 COLOR_ITALIC='\033[3m';COLOR_NOITALIC='\033[23m';COLOR_BLINK='\033[5m';
 COLOR_REVERSE='\033[7m';COLOR_CONCEAL='\033[8m';COLOR_NOBOLD='\033[22m';
 COLOR_NOUNDER='\033[24m';COLOR_NOBLINK='\033[25m';

-#Front color
+# Front color
 COLOR_BLACK='\033[30m';COLOR_RED='\033[31m';COLOR_GREEN='\033[32m';COLOR_YELLOW='\033[33m';
 COLOR_BLUE='\033[34m';COLOR_MAGENTA='\033[35m';COLOR_CYAN='\033[36m';COLOR_WHITE='\033[37m';

-#background color
+# background color
 COLOR_BBLACK='\033[40m';COLOR_BRED='\033[41m';
 COLOR_BGREEN='\033[42m';COLOR_BYELLOW='\033[43m';
 COLOR_BBLUE='\033[44m';COLOR_BMAGENTA='\033[45m';