feat: Add help documentation in the gh wiki

.github/workflows/wiki.yaml

@@ -0,0 +1,18 @@
+name: Publish wiki
+on:
+  push:
+    branches: [main]
+concurrency:
+  group: publish-wiki
+  cancel-in-progress: true
+permissions:
+  contents: write
+jobs:
+  publish-wiki:
+    name: Publish wiki
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: Andrew-Chen-Wang/github-wiki-action@v4
+        with:
+          WIKI_PATH: docs/

docs/auth/access_token/help.md

@@ -0,0 +1,23 @@
+# Retrieve the access token used in the APIs
+
+## Usage:
+```bash
+Usage:
+  ./mgc auth access-token [flags]
+```
+
+## Product catalog:
+- Aliases:
+- access-token, access_token
+
+## Other commands:
+- Flags:
+- -h, --help       help for access-token
+- --validate   Validate the token, refreshing if needed
+
+## Flags:
+```bash
+Global Flags:
+      --cli.show-cli-globals   Show all CLI global flags on usage text
+```
+

docs/auth/clients/create/help.md

@@ -0,0 +1,37 @@
+# Create new client (Oauth Application)
+
+## Usage:
+```bash
+Usage:
+  ./mgc auth clients create [name] [description] [redirect-uris] [icon] [access-token-expiration] [always-require-login] [client-privacy-term-url] [terms-of-use] [audiences] [backchannel-logout-session-enabled] [backchannel-logout-uri] [oidc-audiences] [refresh-token-custom-expires-enabled] [refresh-token-expiration] [reason] [flags]
+```
+
+## Product catalog:
+- Examples:
+- ./mgc auth clients create --access-token-expiration=7200 --audiences="public" --description="Client description" --name="Client Name" --refresh-token-expiration=15778476
+
+## Other commands:
+- Flags:
+- --access-token-expiration integer        Access token expiration (in seconds)
+- --always-require-login                   Must ignore active Magalu ID session and always require login
+- --audiences string                       Client audiences (separated by space)
+- --backchannel-logout-session-enabled     Client requires backchannel logout session
+- --backchannel-logout-uri string          Backchannel logout URI
+- --client-privacy-term-url string         URL to privacy term (required)
+- --description string                     Description of new client (required)
+- -h, --help                                   help for create
+- --icon string                            URL for client icon
+- --name string                            Name of new client (required)
+- --oidc-audiences string                  Audiences for ID token
+- --reason string                          Note to inform the reason for creating the client. Will help with the application approval process (required)
+- --redirect-uris string                   Redirect URIs (separated by space) (required)
+- --refresh-token-custom-expires-enabled   Use custom value for refresh token expiration
+- --refresh-token-expiration integer       Custom refresh token expiration value (in seconds)
+- --terms-of-use string                    URL to terms of use (required)
+
+## Flags:
+```bash
+Global Flags:
+      --cli.show-cli-globals   Show all CLI global flags on usage text
+```
+

docs/auth/clients/help.md

@@ -0,0 +1,25 @@
+# Manage Clients (Oauth Applications) to use ID Magalu
+
+## Usage:
+```bash
+Usage:
+  ./mgc auth clients [flags]
+  ./mgc auth clients [command]
+```
+
+## Product catalog:
+- Commands:
+- create      Create new client (Oauth Application)
+- list        List user clients
+- update      Update a client (Oauth Application)
+
+## Other commands:
+- Flags:
+- -h, --help   help for clients
+
+## Flags:
+```bash
+Global Flags:
+      --cli.show-cli-globals   Show all CLI global flags on usage text
+```
+

docs/auth/clients/list/help.md

@@ -0,0 +1,21 @@
+# List user clients
+
+## Usage:
+```bash
+Usage:
+  ./mgc auth clients list [flags]
+```
+
+## Product catalog:
+- Flags:
+- -h, --help   help for list
+
+## Other commands:
+- Global Flags:
+- --cli.show-cli-globals   Show all CLI global flags on usage text
+
+## Flags:
+```bash
+
+```
+

docs/auth/clients/update/help.md

@@ -0,0 +1,38 @@
+# Update a client (Oauth Application)
+
+## Usage:
+```bash
+Usage:
+  ./mgc auth clients update [id] [name] [description] [redirect-uris] [icon] [access-token-expiration] [always-require-login] [client-privacy-term-url] [terms-of-use] [audiences] [backchannel-logout-session-enabled] [backchannel-logout-uri] [oidc-audiences] [refresh-token-custom-expires-enabled] [refresh-token-expiration] [reason] [flags]
+```
+
+## Product catalog:
+- Examples:
+- ./mgc auth clients update --access-token-expiration=7200 --audiences="public" --description="Client description" --name="Client Name" --refresh-token-expiration=15778476
+
+## Other commands:
+- Flags:
+- --access-token-expiration integer        Access token expiration (in seconds)
+- --always-require-login                   Must ignore active Magalu ID session and always require login
+- --audiences string                       Client audiences (separated by space)
+- --backchannel-logout-session-enabled     Client requires backchannel logout session
+- --backchannel-logout-uri string          Backchannel logout URI
+- --client-privacy-term-url string         URL to privacy term
+- --description string                     Description of new client
+- -h, --help                                   help for update
+- --icon string                            URL for client icon
+- --id string                              UUID of client (required)
+- --name string                            Name of new client
+- --oidc-audiences string                  Audiences for ID token
+- --reason string                          Note to inform the reason for creating the client. Will help with the application approval process
+- --redirect-uris string                   Redirect URIs (separated by space)
+- --refresh-token-custom-expires-enabled   Use custom value for refresh token expiration
+- --refresh-token-expiration integer       Custom refresh token expiration value (in seconds)
+- --terms-of-use string                    URL to terms of use
+
+## Flags:
+```bash
+Global Flags:
+      --cli.show-cli-globals   Show all CLI global flags on usage text
+```
+

docs/auth/help.md

@@ -0,0 +1,28 @@
+# The authentication credentials set here will be used as a basis for a variety
+of HTTP requests using the MgcSDK. Authentication is done via Magalu Cloud account
+(Object Storage requires special keys, refer to it for more info)
+
+## Usage:
+```bash
+Usage:
+  ./mgc auth [flags]
+  ./mgc auth [command]
+```
+
+## Product catalog:
+- Commands:
+- access-token Retrieve the access token used in the APIs
+- clients      Manage Clients (Oauth Applications) to use ID Magalu
+- login        Authenticate with Magalu Cloud
+- tenant       Manage Tenants
+
+## Other commands:
+- Flags:
+- -h, --help   help for auth
+
+## Flags:
+```bash
+Global Flags:
+      --cli.show-cli-globals   Show all CLI global flags on usage text
+```
+

docs/auth/login/help.md

@@ -0,0 +1,27 @@
+# Log in to your Magalu Cloud account. When you login with this command,
+the current Tenant will always be set to the default one. To see more details
+about a successful login, use the '--show' flag when logging in
+
+## Usage:
+```bash
+Usage:
+  ./mgc auth login [flags]
+```
+
+## Product catalog:
+- Flags:
+- --headless               Generate URL for the login at local environment
+- -h, --help                   help for login
+- --qrcode                 Generate a qrcode for the login URL
+- --scopes array(string)   All desired scopes for the resulting access token
+- --show                   Show the access token after the login completes
+
+## Other commands:
+- Global Flags:
+- --cli.show-cli-globals   Show all CLI global flags on usage text
+
+## Flags:
+```bash
+
+```
+

docs/auth/tenant/current/help.md

@@ -0,0 +1,21 @@
+# The current Tenant is used for all Magalu HTTP requests
+
+## Usage:
+```bash
+Usage:
+  ./mgc auth tenant current [flags]
+```
+
+## Product catalog:
+- Flags:
+- -h, --help   help for current
+
+## Other commands:
+- Global Flags:
+- --cli.show-cli-globals   Show all CLI global flags on usage text
+
+## Flags:
+```bash
+
+```
+

docs/auth/tenant/help.md

@@ -0,0 +1,27 @@
+# Tenants work like sub-accounts. You may have more than one Tenant under your
+Magalu Cloud account and they each store their data separately, but are billed
+under the same account
+
+## Usage:
+```bash
+Usage:
+  ./mgc auth tenant [flags]
+  ./mgc auth tenant [command]
+```
+
+## Product catalog:
+- Commands:
+- current     Get the currently active Tenant
+- list        List all available tenants for current login
+- set         Set the active Tenant to be used for all subsequent requests
+
+## Other commands:
+- Additional Commands:
+- select      call "list", prompt selection and then "set"
+
+## Flags:
+```bash
+Flags:
+  -h, --help   help for tenant
+```
+

docs/auth/tenant/list/help.md

@@ -0,0 +1,21 @@
+# List all available tenants for current login
+
+## Usage:
+```bash
+Usage:
+  ./mgc auth tenant list [flags]
+```
+
+## Product catalog:
+- Flags:
+- -h, --help   help for list
+
+## Other commands:
+- Global Flags:
+- --cli.show-cli-globals   Show all CLI global flags on usage text
+
+## Flags:
+```bash
+
+```
+

docs/auth/tenant/set/help.md

@@ -0,0 +1,22 @@
+# Set the active Tenant to be used for all subsequent requests
+
+## Usage:
+```bash
+Usage:
+  ./mgc auth tenant set [uuid] [flags]
+```
+
+## Product catalog:
+- Flags:
+- -h, --help          help for set
+- --uuid string   The UUID of the desired Tenant. To list all possible IDs, run auth tenant list (required)
+
+## Other commands:
+- Global Flags:
+- --cli.show-cli-globals   Show all CLI global flags on usage text
+
+## Flags:
+```bash
+** If you have an API Key set, changing the tenant will unset it.
+```
+

docs/block-storage/help.md

@@ -0,0 +1,26 @@
+# Block Storage API Product Documentation
+
+## Usage:
+```bash
+Usage:
+  ./mgc block-storage [flags]
+  ./mgc block-storage [command]
+```
+
+## Product catalog:
+- Aliases:
+- block-storage, bs, blocks, blst
+
+## Other commands:
+- Commands:
+- snapshots    Operations with snapshots for volumes.
+- volume-types Operations with volume types for volumes.
+- volumes      Operations with volumes, including create, delete, extend, retype, list and other actions.
+
+## Flags:
+```bash
+Flags:
+  -h, --help      help for block-storage
+  -v, --version   version for block-storage
+```
+

docs/block-storage/snapshots/create/help.md

@@ -0,0 +1,27 @@
+# Create a Snapshot for the currently authenticated tenant.
+
+## Usage:
+```bash
+The Snapshot can be used when it reaches the "available" state and the
+ "completed" status.
+```
+
+## Product catalog:
+- #### Rules
+- - The Snapshot name must be unique; otherwise, the creation will be disallowed.
+- - Creating Snapshots from restored Volumes may lead to future conflicts as
+- you can't delete a Volume with an Snapshot and can't delete a Snapshot with a
+- restored Volume, so we recommend avoiding it.
+
+## Other commands:
+- #### Notes
+- - Use the **block-storage volume list** command to retrieve a list of all
+- Volumes and obtain the ID of the Volume that will be used to create the
+- Snapshot.
+
+## Flags:
+```bash
+Usage:
+  ./mgc block-storage snapshots create [flags]
+```
+