Improve text

casdoor · Dec 17, 2023 · e9268a6 · e9268a6
1 parent 76cc8fc
commit e9268a6
Show file tree

Hide file tree

Showing 11 changed files with 58 additions and 54 deletions.
diff --git a/docs/basic/core-concepts.md b/docs/basic/core-concepts.md
@@ -37,15 +37,19 @@ flowchart LR;
     end;
     
     subgraph SMS;
-        AWS\\nAliyunCloud;
+        Twilio\nAmazon-SNS\n...;
     end;
     
     subgraph OAuth;
-        Github\\nGoogle\\nFacebook\\nWeChat;
+        Google\nGithub\nFacebook\nAzureAD\nCustomOAuth\n...;
     end;
     
     subgraph SAML;
-        Keycloak\\nAliyunIDaaS;
+        CustomSAML\nKeycloak\n...;
+    end;
+    
+    subgraph Email;
+        Default\nSendGrid\nAzureACS\n...;
     end;
     
     subgraph Applications-1;

diff --git a/docs/provider/captcha/overview.md b/docs/provider/captcha/overview.md
@@ -9,10 +9,10 @@ Casdoor can be configured to support different captchas to verify if the operati
 
 Currently, Casdoor supports multiple captcha providers. The following are the providers supported by Casdoor:
 
-|                         **Default**                          |                     Cloudflare Turnstile                     |                        **reCAPTCHA**                         |                         **hCaptcha**                         |                      **Aliyun Captcha**                      |                                  Geetest                                   |
-| :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: | :----------------------------------------------------------: |:--------------------------------------------------------------------------:|
+|                                **Default**                                 |                             Cloudflare Turnstile                              |                                **reCAPTCHA**                                 |                                **hCaptcha**                                 |                         **Alibaba Cloud Captcha**                         |                                  Geetest                                   |
+|:--------------------------------------------------------------------------:|:-----------------------------------------------------------------------------:|:----------------------------------------------------------------------------:|:---------------------------------------------------------------------------:|:-------------------------------------------------------------------------:|:--------------------------------------------------------------------------:|
 | <img src="https://cdn.casbin.org/img/social_default.png" width="40"></img> | <img src="https://cdn.casbin.org/img/social_cloudflare.png" width="40"></img> | <img src="https://cdn.casbin.org/img/social_recaptcha.png" width="40"></img> | <img src="https://cdn.casbin.org/img/social_hcaptcha.png" width="40"></img> | <img src="https://cdn.casbin.org/img/social_aliyun.png" width="40"></img> | <img src="https://cdn.casbin.org/img/social_geetest.png" width="40"></img> |
-|                            **✅**                             |                            **✅**                             |                            **✅**                             |                            **✅**                             |                            **✅**                             |                                   **✅**                                    |
+|                                   **✅**                                    |                                     **✅**                                     |                                    **✅**                                     |                                    **✅**                                    |                                   **✅**                                   |                                   **✅**                                    |
 
 We will show you how to apply a captcha and add it to Casdoor.
 

diff --git a/docs/provider/email/sendgrid.md b/docs/provider/email/sendgrid.md
@@ -1,13 +1,13 @@
 ---
-title: Sendgrid
-description: Using Sendgrid as the SMTP server
-keywords: [email, Sendgrid]
+title: SendGrid
+description: Using SendGrid as the SMTP server
+keywords: [email, SendGrid]
 authors: [UsherFall]
 ---
 
-In this guide, we will be using Sendgrid as the SMTP server.
+In this guide, we will be using SendGrid as the SMTP server.
 
-### Step 1: Create API key for your Sendgrid account
+### Step 1: Create API key for your SendGrid account
 
 Expand the **Settings** from the left navigation bar, click on the **API Keys** option from this list. Here, you will see all of your API keys if you have generated any in the past. To generate a new one, you need to click on **Create API Key** and pay attention to the permissions.
 
@@ -24,13 +24,13 @@ Now create an email provider in Casdoor. Fill in the required fields below:
 | Required fields | Remark                    |
 |-----------------|---------------------------|
 | Username        | Enter "apikey"            |
-| Password        | Your Sendgrid's API key   |
+| Password        | Your SendGrid's API key   |
 | From Address    | Your verified sender      |
 | Host            | Enter "smtp.sendgrid.net" |
 | Port            | Default is 465            |
 
 ![sendgrid_provider](/img/providers/sendgrid_provider.png)
 
-Click on the `Test SMTP Connection` button. If you see `provider: SMTP connected successfully`, it means that your Casdoor service can access the Sendgrid service.
+Click on the `Test SMTP Connection` button. If you see `provider: SMTP connected successfully`, it means that your Casdoor service can access the SendGrid service.
 
 Next, click on the `Send Testing Email` button. If you see `Email sent successfully`, it means that the test email has been sent successfully from the `From` address to the `Test Email`.
diff --git a/docs/provider/oauth/CustomProvider.md b/docs/provider/oauth/CustomProvider.md
@@ -1,5 +1,5 @@
 ---
-title: Custom Provider for Casdoor
+title: Custom OAuth
 description: Add your custom OAuth provider to Casdoor
 keywords: [Custom Provider, OAuth, Casdoor]
 authors: [halozhy]

diff --git a/docs/provider/overview.md b/docs/provider/overview.md
@@ -28,7 +28,7 @@ Currently, we have six types of providers:
   Casdoor can add payment providers, which will be used to add payment methods to products on the product page. Currently, the supported payment providers include Alipay, WeChat Pay, PayPal, and GC.
 - **Captcha Providers**
 
-  Casdoor supports configurable captcha in user flows. Currently, the supported captcha providers include Default Captcha, reCAPTCHA, hCaptcha, Aliyun Captcha, and Cloudflare Turnstile.
+  Casdoor supports configurable captcha in user flows. Currently, the supported captcha providers include Default Captcha, reCAPTCHA, hCaptcha, Alibaba Cloud Captcha, and Cloudflare Turnstile.
 
 ## How to Configure and Use
 

diff --git a/docs/provider/saml/aliyun.md b/docs/provider/saml/aliyun.md
@@ -1,27 +1,27 @@
 ---
-title: Aliyun IDaaS
-description: Using Aliyun IDaaS to authenticate users
-keywords: [Aliyun IDaaS]
+title: Alibaba Cloud IDaaS
+description: Using Alibaba Cloud IDaaS to authenticate users
+keywords: [Alibaba Cloud IDaaS]
 authors: [seriouszyx]
 ---
 
-## Create SAML application in Aliyun IDaaS
+## Create SAML application in Alibaba Cloud IDaaS
 
-Login to the [Aliyun management console](https://account.aliyun.com/), search and go to the Application Indentity Service (IDentity-as-a-Service, IDaaS).
+Login to the [Alibaba Cloud management console](https://account.aliyun.com/), search and go to the Application Indentity Service (IDentity-as-a-Service, IDaaS).
 
-![Aliyun IDaaS](/img/providers/SAML/aliyun.png)
+![Alibaba Cloud IDaaS](/img/providers/SAML/aliyun.png)
 
 Click **EIAM Instance List** and open the free version.
 
-![Aliyun EIAM](/img/providers/SAML/aliyun_eiam.png)
+![Alibaba Cloud EIAM](/img/providers/SAML/aliyun_eiam.png)
 
 An instance will be created and run automatically after opening. Click on the instance name or the **Manage** button to enter the IDaaS management console.
 
-![Aliyun EIAM List](/img/providers/SAML/aliyun_eiam_list.png)
+![Alibaba Cloud EIAM List](/img/providers/SAML/aliyun_eiam_list.png)
 
 After entering the IDaaS management console, click **Add Application**, search for **SAML**, and click **Add Application**.
 
-![Add Aliyun SAML](/img/providers/SAML/aliyun_saml_add.png)
+![Add Alibaba Cloud SAML](/img/providers/SAML/aliyun_saml_add.png)
 
 Click **Add SigningKey**.
 
@@ -81,7 +81,7 @@ Go to the **Application List**, click **View Application Details** and click **E
 
 Create a new provider in Casdoor.
 
-Select category as **SAML**, type as **Aliyun IdaaS**. Copy the content of metadata and paste it to the **Metadata** input. The values of **Endpoint**, **IdP** and **Issuer URL** will be generated automatically after clicking the **Parse** button.
+Select category as **SAML**, type as **Alibaba Cloud IdaaS**. Copy the content of metadata and paste it to the **Metadata** input. The values of **Endpoint**, **IdP** and **Issuer URL** will be generated automatically after clicking the **Parse** button.
 
 ![Casdoor provider](/img/providers/SAML/aliyun_casdoor.png)
 
@@ -91,7 +91,7 @@ Edit the application you want to configure in Casdoor. Select the provider just
 
 ![Add provider for app](/img/providers/SAML/aliyun_casdoor_provider.png)
 
-## Modify SAML application in Aliyun IDaaS
+## Modify SAML application in Alibaba Cloud IDaaS
 
 Disable the application and then click **Modify Application**.
 
@@ -105,6 +105,6 @@ Fill in **SP Entity ID** and **SP ACS URL(SSO Location)** with the content copie
 
 Go to the application you just configured and you can find that there is an icon in the login page.
 
-Click the icon and jump to the Aliyun IDaaS login page, and then successfully login to the Casdoor after authentication.
+Click the icon and jump to the Alibaba Cloud IDaaS login page, and then successfully login to the Casdoor after authentication.
 
 ![Casdoor login](/img/providers/SAML/aliyun_casdoor_login.gif)
diff --git a/docs/provider/saml/overview.md b/docs/provider/saml/overview.md
@@ -1,15 +1,15 @@
 ---
 title: Overview
 description: Using identities from external identity providers that support SAML 2.0
-keywords: [SAML, Keycloak, Aliyun IDaaS]
+keywords: [SAML, Keycloak, Alibaba Cloud IDaaS]
 authors: [seriouszyx]
 ---
 
 Casdoor can be configured to support user login to the UI using identities from external identity providers that support SAML 2.0. In this configuration, Casdoor never stores any credentials for the users.
 
 Now, Casdoor supports multiple SAML application providers. Icons of the providers will be displayed on the login page after being added to Casdoor. Here are the providers that Casdoor supports:
 
-| Aliyun IDaaS | Keycloak | Custom |
+| Alibaba Cloud IDaaS | Keycloak | Custom |
 | :----------: | :------: | :-----: |
 | <img src="https://cdn.casbin.org/img/social_aliyun.png" width="40"></img> | <img src="https://cdn.casbin.org/img/social_keycloak.png" width="40"></img> | <img src="https://cdn.casbin.org/img/social_custom.png" width="40"></img> |
 |      ✅      |    ✅    |    ✅    |

diff --git a/docs/provider/sms/alibabaCloud.md b/docs/provider/sms/alibabaCloud.md
@@ -20,7 +20,7 @@ There are four required fields: `Client ID`, `Client secret`, `Sign Name`, and `
 
 - AccessKey ID and AccessKey Secret
 
-After logging into my Aliyun workbench, I click on "AccessKey" to create an ID and Secret.
+After logging into my Alibaba Cloud workbench, I click on "AccessKey" to create an ID and Secret.
 
 ![Alibaba Cloud workbench](/img/providers/sms/aliyunsms.png)
 

diff --git a/docs/provider/sms/twilio.md b/docs/provider/sms/twilio.md
@@ -7,7 +7,7 @@ authors: [UsherFall]
 
 ## Fill in the necessary information in Casdoor
 
-There are four required fields: `Client ID`, `Client secret`, `Sender number`, and `Template code`. The corresponding relationship to the Tencent Cloud COS account is as follows:
+There are four required fields: `Client ID`, `Client secret`, `Sender number`, and `Template code`. The corresponding relationship to the Twilio account is as follows:
 
 | Name          | Name in Twilio      | Required   |
 |---------------|---------------------|------------|

diff --git a/docs/provider/storage/aliyun-oss.md b/docs/provider/storage/aliyun-oss.md
@@ -1,19 +1,19 @@
 ---
-title: Aliyun OSS
-description: Using Aliyun OSS as a storage provider for Casdoor
-keywords: [Aliyun OSS, storage, provider]
+title: Alibaba Cloud OSS
+description: Using Alibaba Cloud OSS as a storage provider for Casdoor
+keywords: [Alibaba Cloud OSS, storage, provider]
 authors: [leo220yuyaodog]
 ---
 
 :::note
 
-This is an example of **Aliyun OSS**.
+This is an example of **Alibaba Cloud OSS**.
 
 :::
 
-The AccessKey is your key to access Aliyun API with full account permissions.
+The AccessKey is your key to access Alibaba Cloud API with full account permissions.
 
-To create an AccessKey, follow the instructions in the [Aliyun workbench](https://help.aliyun.com/document_detail/53045.html).
+To create an AccessKey, follow the instructions in the [Alibaba Cloud workbench](https://help.aliyun.com/document_detail/53045.html).
 
 Next, create the OSS service:
 
@@ -23,4 +23,4 @@ Fill in the necessary information in Casdoor and save:
 
 ![OSS](/img/providers/storage/oss.png)
 
-You can now use Aliyun cloud storage services in your application.
+You can now use Alibaba Cloud cloud storage services in your application.
diff --git a/sidebars.js b/sidebars.js
@@ -153,26 +153,26 @@ module.exports = {
           link: {type: "generated-index"},
           items: [
             "provider/oauth/overview",
+            "provider/oauth/google",
+            "provider/oauth/googleonetap",
+            "provider/oauth/github",
+            "provider/oauth/linkedin",
+            "provider/oauth/facebook",
+            "provider/oauth/adfs",
+            "provider/oauth/azureAD",
+            "provider/oauth/azureADb2c",
             "provider/oauth/CustomProvider",
+            "provider/oauth/okta",
             "provider/oauth/Twitter",
             "provider/oauth/Weibo",
             "provider/oauth/Wechat",
             "provider/oauth/weCom",
             "provider/oauth/Tencent",
             "provider/oauth/DingTalk",
             "provider/oauth/Steam",
-            "provider/oauth/github",
             "provider/oauth/gitee",
-            "provider/oauth/linkedin",
-            "provider/oauth/facebook",
-            "provider/oauth/google",
-            "provider/oauth/googleonetap",
             "provider/oauth/baidu",
-            "provider/oauth/adfs",
-            "provider/oauth/azureAD",
-            "provider/oauth/azureADb2c",
             "provider/oauth/infoflow",
-            "provider/oauth/okta",
             "provider/oauth/lark",
           ],
         },
@@ -183,10 +183,10 @@ module.exports = {
           link: {type: "generated-index"},
           items: [
             "provider/email/overview",
-            "provider/email/mailhog",
-            "provider/email/brevo",
-            "provider/email/azureACS",
             "provider/email/sendgrid",
+            "provider/email/azureACS",
+            "provider/email/brevo",
+            "provider/email/mailhog",
           ],
         },
         {
@@ -197,9 +197,9 @@ module.exports = {
           items: [
             "provider/sms/overview",
             "provider/sms/twilio",
-            "provider/sms/alibabaCloud",
             "provider/sms/amazonSns",
             "provider/sms/acs",
+            "provider/sms/alibabaCloud",
           ],
         },
         {
@@ -239,9 +239,9 @@ module.exports = {
           link: {type: "generated-index"},
           items: [
             "provider/saml/overview",
-            "provider/saml/aliyun",
-            "provider/saml/keycloak",
             "provider/saml/custom",
+            "provider/saml/keycloak",
+            "provider/saml/aliyun",
           ],
         },
         {
@@ -278,8 +278,8 @@ module.exports = {
           collapsed: true,
           link: {type: "generated-index"},
           items: [
-            "provider/web3/web3onboard",
             "provider/web3/metamask",
+            "provider/web3/web3onboard",
           ],
         },
       ],