瀏覽代碼

[docs] Update Slack section with new url and minor markdown fixes (#2100)

Harsh Gupta 4 年之前
父節點
當前提交
bdf7544205
共有 1 個文件被更改,包括 18 次插入18 次删除
  1. 18 18
      docs/docs-site/content/administrator/configuration/server/_index.md

+ 18 - 18
docs/docs-site/content/administrator/configuration/server/_index.md

@@ -766,46 +766,46 @@ By default Hue stores the [saved documents](/user/concept/#documents) in its dat
 ## Slack
 Currently in **Beta**
 
-This [integration](/user/concept/#share-to-slack) increases the collaboration with other users via Slack.
+This [integration](/user/concept/#share-to-slack) helps users to have better collaboration with others via Slack.
 
 ### Architectural View
 ![Share to Slack Architecture](https://cdn.gethue.com/uploads/2021/04/share_to_slack_architecture.png)
 
-One of the flows for sharing query/gist links, the main bot logic lies on top of the Hue server listening to the events posted by the Hue App from Slack to an endpoint, processing those events sending a greeting message when someone says 'Hello Hue' such as generating a rich preview to unfurl for the links shared in the Slack channels and using Slack API methods for sending these responses back to Slack.
+One of the flows for sharing query/gist links, the main bot logic lies on top of the Hue server listening to the events posted by the Hue App from Slack to an endpoint, processing those events such as generating a rich preview to unfurl for the links shared in the Slack channels and using Slack API methods for sending these responses back to Slack.
 
 The 'Smart Quering Assistance' block on top of Hue server which driving the other flow for SQL Assistance is currently a work in progress for replying to users asking questions on how to find certain data tables or to query them.
 
 ### Manual Slack App Installation
-Steps/flow to be followed by the upstream Hue user to set up their own Hue Slack app for their workspace.
+Steps/flow to be followed by the Hue user to set up their own Hue Slack app for their workspace.
 
 #### Creating your app
-1. Go to https://api.slack.com/apps and click **"Create New App"**.
-2. Pick an app name, i.e. **"Hue App"** and a workspace that you'll be installing it to.
-3. Click **"Create App"**. This will leave you on the **"Basic Information"** screen for your new app.
-4. Scroll down to **"Display Information"** and fill it out.
+1. Go to https://api.slack.com/apps and click **Create New App**.
+2. Pick an app name, i.e. **Hue App** and a workspace that you'll be installing it to.
+3. Click **Create App**. This will leave you on the **Basic Information** screen for your new app.
+4. Scroll down to **Display Information** and fill it out.
 
 #### Subscribe to Events
-5. Scroll back up to **"Add features and functionality"**.
-6. Click **Event Subscription** and turn on **Enable Events** 
-7. Add an **Events Request URL** where Slack will POST events when triggered <br/> `https://<hue-instance-domain>/slack/events/`
+5. Scroll back up to **Add features and functionality**.
+6. Click **Event Subscription** and turn on **Enable Events** 
+7. Add an **Events Request URL** where Slack will POST events when triggered <br/> `https://<your-hue-domain>/desktop/slack/events/`
 8. Subscribe to the following **bot events**:
 
 | **Bot Events** | **Why do we need it?** |
 |    :---:     |     :---     |
-| link_shared   | Add link previews for your specified Hue instance domain (eg. demo.gethue.com) in Slack messages.<br/><br/>\*Requires and itself adds **link:read** OAuth scope
-| message.channels     | Send a simple “ Hi \<@user id\>” greeting message to user messaging “Hello Hue”.<br/><br/>\*Requires and itself adds **channels:history** OAuth scope
+| link_shared   | Add link previews for your specified Hue instance domain (eg. demo.gethue.com) in Slack messages. <br/><br/> \*Requires and itself adds **link:read** OAuth scope
+| message.channels     | Send a simple “Hi \<@user id\>” greeting message to user messaging “Hello Hue”. <br/><br/> \*Requires and itself adds **channels:history** OAuth scope
 
-9. Go to “App Unfurl Domains” and add your Hue instance domain (eg. demo.gethue.com). More info about [registering a domain here.](https://api.slack.com/reference/messaging/link-unfurling#configuring_domains)
+9. Go to **App Unfurl Domains** and add your Hue instance domain (eg. demo.gethue.com). More info about [registering a domain here.](https://api.slack.com/reference/messaging/link-unfurling#configuring_domains)
 
 #### Add OAuth Scopes
-10. Navigate to the **"OAuth & Permissions"** page and scroll down to **"Scopes"**
-11. Under **"Bot Token Scopes"**, subscribe to the following:
+10. Navigate to the **OAuth & Permissions** page and scroll down to **Scopes**
+11. Under **Bot Token Scopes**, subscribe to the following:
 
 | **Permission Scopes** | **Why do we need it?** |
 |    :---:     |     :---     |
 | channels:history   | \*Required by **message.channels** bot event
 | channels:read   | Get list of channels where bot is present
-| chat:write     | Sending messages as Hue App such as greeting message
+| chat:write     | Sending messages as Hue App
 | files:write   | Uploading the query result file in link message thread
 | links:read  | \*Required by **link_shared** bot event
 | links:write   | To show link preview in Slack messages from registered domains
@@ -823,7 +823,7 @@ slack_bot_user_token=<your-slack-bot-user-token>
 ```
 
 12. Set Slack API endpoint flag to true
-13. Go to the **"OAuth & Permissions"** page, copy the **Bot User OAuth Token** and update **slack_bot_user_token**
-14. Similarly, go to the **"Basic Information"** page, copy the **Verification Token** and update **slack_verification_token**
+13. Go to the **OAuth & Permissions** page, copy the **Bot User OAuth Token** and update **slack_bot_user_token**
+14. Similarly, go to the **Basic Information** page, copy the **Verification Token** and update **slack_verification_token**
 
 Now add the Slack app in your desired channels and send some query/gist links!