Skip to content

Commit 425741b

Browse files
Merging changes synced from https://github.com/MicrosoftDocs/bot-docs-pr (branch live)
2 parents 4138162 + cf3786c commit 425741b

20 files changed

+401
-125
lines changed

.openpublishing.publish.config.json

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -78,20 +78,26 @@
7878
"skip_source_output_uploading": false,
7979
"need_preview_pull_request": true,
8080
"contribution_branch_mappings": {},
81-
"dependent_repositories": [
82-
{
83-
"path_to_root": "_themes",
84-
"url": "https://github.com/Microsoft/templates.docs.msft",
85-
"branch": "master",
86-
"branch_mapping": {}
87-
},
88-
{
89-
"path_to_root": "_themes.pdf",
90-
"url": "https://github.com/Microsoft/templates.docs.msft.pdf",
91-
"branch": "master",
92-
"branch_mapping": {}
93-
}
94-
],
81+
"dependent_repositories": [
82+
{
83+
"path_to_root": "_themes",
84+
"url": "https://github.com/Microsoft/templates.docs.msft",
85+
"branch": "master",
86+
"branch_mapping": {}
87+
},
88+
{
89+
"path_to_root": "_themes.pdf",
90+
"url": "https://github.com/Microsoft/templates.docs.msft.pdf",
91+
"branch": "master",
92+
"branch_mapping": {}
93+
},
94+
{
95+
"path_to_root": "botbuilder-samples",
96+
"url": "https://github.com/Microsoft/BotBuilder-Samples",
97+
"branch": "samples-work-in-progress",
98+
"branch_mapping": {}
99+
}
100+
],
95101
"branch_target_mapping": {
96102
"live": [
97103
"Publish",

articles/TOC.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@
3939
### [Prompt users for input](v4sdk/bot-builder-primitive-prompts.md)
4040
### [Send welcome message to users](v4sdk/bot-builder-send-welcome-message.md)
4141
<!-- ## [Add input hints to messages](v4sdk/bot-builder-howto-add-input-hints.md) -->
42-
### [Get notification from bots](v4sdk/bot-builder-howto-proactive-message.md)
42+
### [Send proactive notifications to users](v4sdk/bot-builder-howto-proactive-message.md)
4343
### [Add natural language understanding to your bot](v4sdk/bot-builder-howto-v4-luis.md)
4444
### [Answer user's questions using QnA Maker](v4sdk/bot-builder-howto-qna.md)
4545
### [Use multiple LUIS and QnA models](v4sdk/bot-builder-tutorial-dispatch.md)

articles/bot-builder-deploy-az-cli.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,11 @@ The source code you downloaded from the Azure portal includes an encrypted .bot
5959
1. Open the bot's **Application Settings**.
6060
1. In the **Application Settings** window, scroll down to **Application settings**.
6161
1. Locate the **botFileSecret** and copy its value.
62+
1. Use `msbot cli` to decrypt the file.
6263

63-
Use `msbot cli` to decrypt the file.
64-
65-
```cmd
66-
msbot secret --bot <name-of-bot-file> --secret "<bot-file-secret>" --clear
67-
```
64+
```cmd
65+
msbot secret --bot <name-of-bot-file> --secret "<bot-file-secret>" --clear
66+
```
6867
6968
### Update your local .bot file
7069
@@ -123,18 +122,24 @@ Open the .bot file you decrypted. Copy **all** entries listed under the `service
123122

124123
Save the file.
125124

125+
You can use the msbot tool to generate a new secret and encrypt the .bot file before you publish. If you re-encrypt your .bot file, update the bot's **botFileSecret** in the Azure portal to contain the new secret.
126+
127+
```cmd
128+
msbot secret --bot <name-of-bot-file> --new
129+
```
130+
126131
### Setup a repository
127132

128-
To support continuous deployment, create a git repository using your favorite git source control provider. Commit your code into the repository.
133+
To support continuous deployment, create a git repository using your favorite git source control provider. Commit your code into the repository.
129134

130135
Make sure that your repository root has the correct files, as described under [prepare your repository](https://docs.microsoft.com/azure/app-service/deploy-continuous-deployment#prepare-your-repository).
131136

132137
### Update App Settings in Azure
133-
The local bot does not use an encrypted .bot file, but the Azure portal has an that you are deploying doesn't
138+
The local bot does not use an encrypted .bot file, but the Azure portal is configured to use an encrypted .bot file. You can resolve this by removing the **botFileSecret** stored in the Azure bot settings.
134139
1. In the Azure portal, open the **Web App Bot** resource for your bot.
135140
1. Open the bot's **Application Settings**.
136141
1. In the **Application Settings** window, scroll down to **Application settings**.
137-
1. Locate the **botFileSecret** and delete it.
142+
1. Locate the **botFileSecret** and delete it. (If you re-encrypted your .bot file, make sure the **botFileSecret** contains the new secret and **do not** delete the setting.)
138143
1. Update the name of the bot file to match the file you checked into the repo.
139144
1. Save changes.
140145

articles/bot-service-channels-reference.md

Lines changed: 249 additions & 0 deletions
Large diffs are not rendered by default.

articles/bot-service-debug-bot.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ manager: kamrani
88
ms.topic: article
99
ms.service: bot-service
1010
ms.subservice: sdk
11-
ms.date: 2/09/2019
11+
ms.date: 2/26/2019
1212
---
1313

1414
# Debug a bot
@@ -133,8 +133,10 @@ Additionally, you can view log details in the console window.
133133

134134
## Additional resources
135135

136-
To learn about debugging bots in production, refer to [Debug any channel locally using ngrok](https://blog.botframework.com/2017/10/19/debug-channel-locally-using-ngrok/) blogpost.
136+
- See [troubleshoot general problems](bot-service-troubleshoot-bot-configuration.md) and the other troubleshooting articles in that section.
137+
- See the how to [debug any channel locally using ngrok](https://blog.botframework.com/2017/10/19/debug-channel-locally-using-ngrok/) blog post.
137138

138139
## Next steps
140+
139141
> [!div class="nextstepaction"]
140-
> [Debug your bot using transcript files](~/v4sdk/bot-builder-debug-transcript.md).
142+
> [Debug your bot using transcript files](v4sdk/bot-builder-debug-transcript.md).

articles/bot-service-debug-emulator.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ ms.author: v-demak
77
manager: kamrani
88
ms.topic: article
99
ms.service: bot-service
10-
ms.date: 11/13/2018
10+
ms.date: 2/26/2019
1111
---
1212

1313
# Debug with the emulator
@@ -76,7 +76,9 @@ Open the **Emulator Settings**, enter the path to ngrok, select whether or not t
7676

7777
The Bot Framework Emulator is open source. You can [contribute][EmulatorGithubContribute] to the development and [submit bugs and suggestions][EmulatorGithubBugs].
7878

79+
For troubleshooting, see [troubleshoot general problems](bot-service-troubleshoot-bot-configuration.md) and the other troubleshooting articles in that section.
7980

81+
<!-- Footnote-style URLs -->
8082

8183
[EmulatorGithubContribute]: https://github.com/Microsoft/BotFramework-Emulator/wiki/How-to-Contribute
8284
[EmulatorGithubBugs]: https://github.com/Microsoft/BotFramework-Emulator/wiki/Submitting-Bugs-%26-Suggestions

articles/bot-service-troubleshoot-authentication-problems.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ms.author: v-demak
66
manager: kamrani
77
ms.topic: article
88
ms.service: bot-service
9-
ms.date: 12/13/17
9+
ms.date: 02/26/2019
1010
---
1111

1212
# Troubleshooting Bot Framework authentication
@@ -222,6 +222,7 @@ If the bot responds appropriately to the input, you have verified that your bot
222222

223223
If you are still experiencing issues after completing the steps above, you can:
224224

225+
* Review how-to [debug a bot](bot-service-debug-bot.md) and the other debugging articles in that section.
225226
* [Debug your bot in the cloud](~/bot-service-debug-emulator.md) using the Bot Framework Emulator and <a href="https://ngrok.com/" target="_blank">ngrok</a>.
226227
* Use a proxying tool like [Fiddler](https://www.telerik.com/fiddler) to inspect HTTPS traffic to and from your bot. *Fiddler is not a Microsoft product.*
227228
* Review the [Bot Connector authentication guide][BotConnectorAuthGuide] to learn about the authentication technologies that the Bot Framework uses.

articles/bot-service-troubleshoot-bot-configuration.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ manager: kamrani
88
ms.topic: article
99
ms.service: bot-service
1010
ms.subservice: sdk
11-
ms.date: 12/20/2018
11+
ms.date: 2/26/2019
1212
---
1313

1414
# Troubleshoot bot configuration issues
@@ -82,3 +82,7 @@ Below are some additional links that can help with individual channels:
8282
Occasionally, some channels might have an interruption of service. Usually, such outages don't last long. However, if you suspect an outage, consult a channel web site or social media.
8383

8484
Another way to determine if a channel has an outage is to create a test bot (such as a simple Echo Bot) and add a channel. If the test bot works with some channels but not others, that would indicate that the problem is not in your production bot.
85+
86+
## Additional resources
87+
88+
See how-to [debug a bot](bot-service-debug-bot.md) and the other debugging articles in that section.

articles/bot-service-troubleshoot-general-problems.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ms.author: v-demak
66
manager: kamrani
77
ms.topic: article
88
ms.service: bot-service
9-
ms.date: 09/26/2018
9+
ms.date: 02/26/2019
1010
---
1111

1212
# Troubleshooting general problems
@@ -15,11 +15,12 @@ These frequently asked questions can help you to troubleshoot common bot develop
1515
## How can I troubleshoot issues with my bot?
1616

1717
1. Debug your bot's source code with [Visual Studio Code](debug-bots-locally-vscode.md) or [Visual Studio](https://docs.microsoft.com/en-us/visualstudio/debugger/navigating-through-code-with-the-debugger?view=vs-2017).
18-
2. Test your bot using the [emulator](bot-service-debug-emulator.md) before you deploy it to the cloud.
19-
3. Deploy your bot to a cloud hosting platform such as Azure and then test connectivity to your bot by using the built-in web chat control on your bot's dashboard in the <a href="https://dev.botframework.com" target="_blank">Bot Framework Portal</a>. If you encounter issues with your bot after you deploy it to Azure, you might consider using this blog article: [Understanding Azure troubleshooting and support](https://azure.microsoft.com/en-us/blog/understanding-azure-troubleshooting-and-support/).
20-
4. Rule out [authentication][TroubleshootingAuth] as a possible issue.
21-
5. Test your bot on Skype. This will help you to validate the end-to-end user experience.
22-
6. Consider testing your bot on channels that have additional authentication requirements such as Direct Line or Web Chat.
18+
1. Test your bot using the [emulator](bot-service-debug-emulator.md) before you deploy it to the cloud.
19+
1. Deploy your bot to a cloud hosting platform such as Azure and then test connectivity to your bot by using the built-in web chat control on your bot's dashboard in the <a href="https://dev.botframework.com" target="_blank">Bot Framework Portal</a>. If you encounter issues with your bot after you deploy it to Azure, you might consider using this blog article: [Understanding Azure troubleshooting and support](https://azure.microsoft.com/en-us/blog/understanding-azure-troubleshooting-and-support/).
20+
1. Rule out [authentication][TroubleshootingAuth] as a possible issue.
21+
1. Test your bot on Skype. This will help you to validate the end-to-end user experience.
22+
1. Consider testing your bot on channels that have additional authentication requirements such as Direct Line or Web Chat.
23+
1. Review the how-to [debug a bot](bot-service-debug-bot.md) and the other debugging articles in that section.
2324

2425
## How can I troubleshoot authentication issues?
2526

articles/docfx.json

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -91,14 +91,13 @@
9191
"globalMetadata": {
9292
"uhfHeaderId": "MSDocsHeader-BotFramework",
9393
"breadcrumb_path": "/bot-framework/breadcrumb/TOC.json",
94-
"author": "RobStand",
95-
"ms.prod": "bot-framework",
94+
"author": "kaiqb",
9695
"brand": "azure",
9796
"searchScope": [
9897
"Azure",
9998
"BotService"
10099
],
101-
"ms.date": "12/13/2017",
100+
"ms.date": "12/13/2018",
102101
"titleSuffix": "Bot Service",
103102
"feedback_system": "GitHub",
104103
"feedback_github_repo": "MicrosoftDocs/bot-docs"
@@ -110,11 +109,8 @@
110109
"manager": {
111110
"**/**.md": "kaiqb"
112111
},
113-
"ms.technology": {
114-
"**/**.md": "bf-bot-builder"
115-
},
116112
"ms.date": {
117-
"**/**.md": "12/13/2017"
113+
"**/**.md": "12/13/2018"
118114
},
119115
"monikerRange": {
120116
"v4sdk/**.md": "azure-bot-service-4.0"

0 commit comments

Comments
 (0)