Skip to content

Commit

Permalink
Resolve syncing conflicts from live-sync-work to live (#705)
Browse files Browse the repository at this point in the history
  • Loading branch information
openpublishbuild authored and Kaiqb committed Jan 14, 2019
1 parent 37b5d4a commit 2f832d3
Show file tree
Hide file tree
Showing 142 changed files with 447 additions and 438 deletions.
14 changes: 7 additions & 7 deletions articles/bot-builder-reference-overview.md
Expand Up @@ -14,17 +14,17 @@ monikerRange: 'azure-bot-service-3.0'

[!INCLUDE [pre-release-label](./includes/pre-release-label-v3.md)]

The Bot Framework includes comprehensive reference documentation for the Bot Builder SDK for .NET, the Bot Builder SDK for Node.js, and the Bot Framework REST APIs.
The Bot Framework includes comprehensive reference documentation for the Bot Framework SDK for .NET, the Bot Framework SDK for Node.js, and the Bot Framework REST APIs.

## Bot Builder SDK for .NET
To learn about the structure of the Bot Builder SDK for .NET, see the [Bot Builder SDK for .NET reference documentation](/dotnet/api/).
## Bot Framework SDK for .NET
To learn about the structure of the Bot Framework SDK for .NET, see the [Bot Framework SDK for .NET reference documentation](/dotnet/api/).

You can also explore the Bot Builder SDK for .NET [source code](https://github.com/Microsoft/BotBuilder/tree/master/CSharp) on GitHub.
You can also explore the Bot Framework SDK for .NET [source code](https://github.com/Microsoft/BotBuilder/tree/master/CSharp) on GitHub.

## Bot Builder SDK for Node.js
To learn about the structure of the Bot Builder SDK for Node.js, see the [Bot Builder SDK for Node.js reference documentation](https://docs.botframework.com/en-us/node/builder/calling-reference/modules/_botbuilder_d_.html).
## Bot Framework SDK for Node.js
To learn about the structure of the Bot Framework SDK for Node.js, see the [Bot Framework SDK for Node.js reference documentation](https://docs.botframework.com/en-us/node/builder/calling-reference/modules/_botbuilder_d_.html).

You can also explore the Bot Builder SDK for Node.js [source code](https://github.com/Microsoft/BotBuilder/tree/master/Node) on GitHub.
You can also explore the Bot Framework SDK for Node.js [source code](https://github.com/Microsoft/BotBuilder/tree/master/Node) on GitHub.

## Bot Framework REST APIs
To learn about the Bot Connector service, see the [Bot Framework REST API reference documentation](~/rest-api/bot-framework-rest-connector-api-reference.md).
Expand Down
6 changes: 3 additions & 3 deletions articles/bot-builder-samples.md
@@ -1,6 +1,6 @@
---
title: Sample bots for Bot Builder SDK | Microsoft Docs
description: Explore a large selection of sample bots that can help kickstart your bot development with the Bot Builder SDK.
title: Sample bots for Bot Framework SDK | Microsoft Docs
description: Explore a large selection of sample bots that can help kickstart your bot development with the Bot Framework SDK.
author: jonathanfingold
ms.author: jonathanfingold
manager: kamrani
Expand All @@ -11,7 +11,7 @@ ms.date: 09/19/2018
monikerRange: 'azure-bot-service-4.0'
---

# Bot Builder SDK samples repo
# Bot Framework SDK samples repo
[!INCLUDE [pre-release-label](includes/pre-release-label.md)]

Samples in the Bot Builder Samples repo demonstrate task-focused bots that show how to take advantage of features provided in
Expand Down
8 changes: 4 additions & 4 deletions articles/bot-builder-tools-az-cli.md
Expand Up @@ -30,7 +30,7 @@ To use these tools from the command line, you will need Node.js installed to you

## 1. Install tools
1. [Install](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest) latest version of the Azure CLI.
2. [Install](https://aka.ms/botbuilder-tools-readme) Bot Builder tools.
2. [Install](https://aka.ms/botbuilder-tools-readme) Bot Framework Tools.

You can now manage bots using Azure CLI like any other Azure resource.

Expand Down Expand Up @@ -155,10 +155,10 @@ This will take current endpoint, MSA appID and password from the target resource

## 5. Manage, Update or Create LUIS and QnA services with new botbuilder-tools

[Bot builder tools](https://aka.ms/botbuilder-tools) is a new toolset which allows you to manage and interact with your bot resources directly from the command line.
[Bot Framework Tools](https://aka.ms/botbuilder-tools) is a new toolset which allows you to manage and interact with your bot resources directly from the command line.

>[!TIP]
> Every bot builder tool includes a global help command, accessible from the command line by entering **-h** or **--help**. This command is available at any time from any action, which will provide a helpful display of the options available to you along with their descriptions.
> Every Bot Framework Tool includes a global help command, accessible from the command line by entering **-h** or **--help**. This command is available at any time from any action, which will provide a helpful display of the options available to you along with their descriptions.
### LUDown

Expand Down Expand Up @@ -328,5 +328,5 @@ az bot publish --name "my-bot-name" --resource-group "my-resource-group"
```

## References
- [Bot Builder Tools](https://aka.ms/botbuilder-tools-readme)
- [Bot Framework Tools](https://aka.ms/botbuilder-tools-readme)
- [Azure CLI](https://docs.microsoft.com/en-us/cli/azure/install-azure-cli?view=azure-cli-latest)
6 changes: 3 additions & 3 deletions articles/bot-builder-tools.md
@@ -1,6 +1,6 @@
---
title: Manage bots using CLI tools
description: Bot builder tools allows you to manage your bot resources directly from the command line
description: Bot Framework Tools allows you to manage your bot resources directly from the command line
keywords: botbuilder templates, ludown, qna, luis, msbot, manage, cli, .bot, bot
author: ivorb
ms.author: v-ivorb
Expand All @@ -14,7 +14,7 @@ monikerRange: 'azure-bot-service-4.0'

# Manage bots using CLI tools

Bot Builder tools cover end-to-end bot development workflow that includes planning, building, testing, publishing, connecting, and evaluation phase. Let's see how these tools can help you with each phase of the development cycle.
Bot Framework Tools cover end-to-end bot development workflow that includes planning, building, testing, publishing, connecting, and evaluation phase. Let's see how these tools can help you with each phase of the development cycle.

## Plan

Expand Down Expand Up @@ -316,7 +316,7 @@ Group
```

## Additional information
- [Bot Builder tools on GitHub][cliTools]
- [Bot Framework Tools on GitHub][cliTools]

<!-- Footnote links -->

Expand Down
5 changes: 3 additions & 2 deletions articles/bot-builder-tutorial-authentication.md
Expand Up @@ -6,6 +6,7 @@ ms.author: JonathanFingold
manager: kamrani
ms.topic: article
ms.service: bot-service
ROBOTS: NOINDEX
ms.date: 10/04/2018
monikerRange: 'azure-bot-service-3.0'
---
Expand All @@ -27,7 +28,7 @@ The features include:
- Improvements to the channels to support new authentication features, such as new WebChat and DirectLineJS libraries to eliminate the need for the 6-digit magic code verification.
- Improvements to the Azure Portal to add, delete, and configure connection settings to various OAuth identity providers.
- Support for a variety of out-of-the-box identity providers including Azure AD (both v1 and v2 endpoints), GitHub, and others.
- Updates to the C# and Node.js Bot Builder SDKs to be able to retrieve tokens, create OAuthCards and handle TokenResponse events.
- Updates to the C# and Node.js Bot Framework SDKs to be able to retrieve tokens, create OAuthCards and handle TokenResponse events.
- Samples for how to make a bot that authenticates to Azure AD (v1 and v2 endpoints) and to GitHub.

You can extrapolate from the steps in this article to add such features to an existing bot. The following are sample bots that demonstrate the new authentication features
Expand Down Expand Up @@ -360,4 +361,4 @@ else if(message.Type == ActivityTypes.Event)
}
```
## Additional resources
[Bot Builder SDK](https://github.com/microsoft/botbuilder)
[Bot Framework SDK](https://github.com/microsoft/botbuilder)
4 changes: 2 additions & 2 deletions articles/bot-service-channel-connect-email.md
Expand Up @@ -71,11 +71,11 @@ see [how to implement channel-specific functionality](~/v4sdk/bot-builder-channe
<!-- Put whole list in monikers, even though it's just the second item that needs to be different. -->
::: moniker range="azure-bot-service-3.0"
* Connect a bot to [channels](~/bot-service-manage-channels.md)
* [Implement channel-specific functionality](dotnet/bot-builder-dotnet-channeldata.md) with the Bot Builder SDK for .NET
* [Implement channel-specific functionality](dotnet/bot-builder-dotnet-channeldata.md) with the Bot Framework SDK for .NET
* Use the [Channel Inspector](bot-service-channel-inspector.md) to see how a channel renders a particular feature of your bot application
::: moniker-end
::: moniker range="azure-bot-service-4.0"
* Connect a bot to [channels](~/bot-service-manage-channels.md)
* [Implement channel-specific functionality](~/v4sdk/bot-builder-channeldata.md) with the Bot Builder SDK for .NET
* [Implement channel-specific functionality](~/v4sdk/bot-builder-channeldata.md) with the Bot Framework SDK for .NET
* Use the [Channel Inspector](bot-service-channel-inspector.md) to see how a channel renders a particular feature of your bot application
::: moniker-end
75 changes: 28 additions & 47 deletions articles/bot-service-debug-bot.md
@@ -1,54 +1,49 @@
---
title: Debug a bot built using Bot Service | Microsoft Docs
title: Debug a bot | Microsoft Docs
description: Learn how to debug a bot built using Bot Service.
author: v-ducvo
ms.author: v-ducvo
keywords: Bot Builder SDK, continuous deployment, app service, emulator
keywords: Bot Framework SDK, debug bot, test bot, bot emulator, emulator
manager: kamrani
ms.topic: article
ms.service: bot-service
ms.subservice: sdk
ms.date: 07/13/2018
ms.date: 11/13/2018
---

# Debug a Bot Service bot
# Debug a bot

This article describes how to debug your bot using an integrated development environment (IDE) such as Visual Studio or Visual Studio Code and the Bot Framework Emulator. While you can use these methods to debug any bot locally, this article uses the **EchoBot** created through the article [Create a bot with Bot Service](bot-service-quickstart.md).
This article describes how to debug your bot using an integrated development environment (IDE) such as Visual Studio or Visual Studio Code and the Bot Framework Emulator. While you can use these methods to debug any bot locally, this article uses a [C#](~/dotnet/bot-builder-dotnet-sdk-quickstart.md) and [JS](~/javascript/bot-builder-javascript-quickstart.md) bot created in the quickstart.

## Debug a JavaScript bot
## Prerequisites
- Download and install the [Bot Framework Emulator](https://aka.ms/Emulator-wiki-getting-started).
- Download and install [Visual Studio Code](https://code.visualstudio.com) or [Visual Studio](https://www.visualstudio.com/downloads) (Community Edition or above).

Follow the steps in this section to debug a bot written in JavaScript.

### Prerequisites

Before you can debug your JavaScript bot, you must complete these tasks.

- Download the source code for your bot (from Azure), as described in [download bot source code](bot-service-build-download-source-code.md).
- Download and install the [Bot Framework Emulator](https://github.com/Microsoft/BotFramework-Emulator/releases).
- Download and install a code editor such as <a href="https://code.visualstudio.com" target="_blank">Visual Studio Code</a>.

### Debug a JavaScript bot using command line and emulator
### Debug a JavaScript bot using command-line and emulator

To run a JavaScript bot using the command line and testing the bot with the emulator, do the following:
1. From the command line, change directory to your bot project directory.
2. Start the bot by running the command **node app.js**.
3. Start the emulator and connect to the bot's endpoint (e.g.: **http://localhost:3978/api/messages**). If this is the first time you are running the bot then click **File > New Bot** and follow the instructions on screen. Otherwise, click **File > Open Bot** to open an existing bot. Since this bot is running locally on your computer, you can leave the **MSA app ID** and **MSA app password** fileds blank. For more information, see [Debug with the Emulator](bot-service-debug-emulator.md).
4. From the emulator, send your bot a message (e.g.: send the message "Hi").
5. Use the **Inspector** and **Log** panels on the right side of the emulator window to debug your bot. For example, clicking on any of the messages bubble (e.g.: the "Hi" message bubble in the screenshot below) will show you the detail of that message in the **Inspector** panel. You can use it to view requests and responses as messages are exchanged between the emulator and the bot. Alternatively, you can click on any of the linked text in the **Log** panel to view the details in the **Inspector** panel.
1. Start the bot by running the command **node app.js**.
1. Start the emulator and connect to the bot's endpoint (e.g.: **http://localhost:3978/api/messages**). If this is the first time you are running
the bot then click **File > New Bot** and follow the instructions on screen. Otherwise, click **File > Open Bot** to open an existing bot.
Since this bot is running locally on your computer, you can leave the **MSA app ID** and **MSA app password** fileds blank.
For more information, see [Debug with the Emulator](bot-service-debug-emulator.md).
1. From the emulator, send your bot a message (e.g.: send the message "Hi").
1. Use the **Inspector** and **Log** panels on the right side of the emulator window to debug your bot. For example, clicking on any of the messages bubble (e.g.: the "Hi" message bubble in the screenshot below) will show you the detail of that message in the **Inspector** panel. You can use it to view requests and responses as messages are exchanged between the emulator and the bot. Alternatively, you can click on any of the linked text in the **Log** panel to view the details in the **Inspector** panel.

![Inspector panel on the Emulator](~/media/bot-service-debug-bot/emulator_inspector.png)

### Debug a JavaScript bot using breakpoints in Visual Studio Code

Using an IDE like Visual Studio Code, you can set breakpoints and run the bot in debug mode to step through your code. To set breakpoints in VS Code, do the following:
In Visual Studio Code, you can set breakpoints and run the bot in debug mode to step through your code. To set breakpoints in VS Code, do the following:

1. Launch VS Code and open your bot project folder.
2. From the menu bar, click **Debug** and click **Start Debugging**. If you are prompted to select a runtime engine to run your code, select **Node.js**. At this point, the bot is running locally.

<!--
> [!NOTE]
> If you get the "Value cannot be null" error, check to make sure your **Table Storage** setting is valid.
> The **EchoBot** is default to using **Table Storage**. To use Table Storage in your bot, you need the table *name* and *key*. If you do not have a Table Storage instance ready, you can create one or for testing purposes, you can comment out the code that uses **TableBotDataStore** and uncomment the line of code that uses **InMemoryDataStore**. The **InMemoryDataStore** is intended for testing and prototyping only.
-->
3. Set breakpoint as necesary. In VS Code, you can set breakpoints by hovering your mouse over the column to the left of the line numbers. A small red dot will appear. If you click on the dot, the breakpoint is set. If you click the dot again, the breakpoint is removed.

![Set breakpoint in VS Code](~/media/bot-service-debug-bot/breakpoint-set.png)
Expand All @@ -58,39 +53,25 @@ Using an IDE like Visual Studio Code, you can set breakpoints and run the bot in

![Debug in VS Code](~/media/bot-service-debug-bot/breakpoint-caught.png)


## Debug a C# bot

Follow the steps in this section to debug a bot written in C#.


### Prerequisites

Before you can debug your web app C# bot, you must complete these tasks.

- Download the source code for your bot (from Azure), as described in [download bot source code](bot-service-build-download-source-code.md).
- Download and install the [Bot Framework Emulator](https://github.com/Microsoft/BotFramework-Emulator/releases).
- Download and install <a href="https://www.visualstudio.com/downloads/" target="_blank">Visual Studio 2017</a> (Community Edition or above).

### Debug a C# bot using breakpoints in Visual Studio

Using an IDE like Visual Studio (VS), you can set breakpoints and run the bot in debug mode to step through your code. To set breakpoints in VS, do the following:
In Visual Studio (VS), you can set breakpoints and run the bot in debug mode to step through your code. To set breakpoints in VS, do the following:

1. Navigate to your bot folder and open the **.sln** file. This will open the solution in VS.
2. From the menu bar, click **Build** and click **Build Solution**.
3. From the **Solution Explorer**, expand the **Dialogs** folder and click **EchoDialog.cs**. This file defines your main bot logic.
4. From the menu bar, click **Debug** and click **Start Debugging**. At this point, the bot is running locally.
3. In the **Solution Explorer**, click **EchoWithCounterBot.cs**. This file defines your main bot logic.Set breakpoint as necesary. In VS, you can set breakpoints by hovering your mouse over the column to the left of the line numbers. A small red dot will appear. If you click on the dot, the breakpoint is set. If you click the dot again, the breakpoint is removed.
5. From the menu bar, click **Debug** and click **Start Debugging**. At this point, the bot is running locally.

<!--
> [!NOTE]
> If you get the "Value cannot be null" error, check to make sure your **Table Storage** setting is valid.
> The **EchoBot** is default to using **Table Storage**. To use Table Storage in your bot, you need the table *name* and *key*. If you do not have a Table Storage instance ready, you can create one or for testing purposes, you can comment out the code that uses **TableBotDataStore** and uncomment the line of code that uses **InMemoryDataStore**. The **InMemoryDataStore** is intended for testing and prototyping only.
5. Set breakpoint as necesary. In VS, you can set breakpoints by hovering your mouse over the column to the left of the line numbers. A small red dot will appear. If you click on the dot, the breakpoint is set. If you click the dot again, the breakpoint is removed.
-->

![Set breakpoint in VS](~/media/bot-service-debug-bot/breakpoint-set-vs.png)

6. Start the Bot Framework Emulator and connect to your bot as described in the section above.
7. From the emulator, send your bot a message (e.g.: send the message "Hi"). Execution will stop at the line where you place the breakpoint.
7. Start the Bot Framework Emulator and connect to your bot as described in the section above.
8. From the emulator, send your bot a message (e.g.: send the message "Hi"). Execution will stop at the line where you place the breakpoint.

![Debug in VS](~/media/bot-service-debug-bot/breakpoint-caught-vs.png)

Expand All @@ -105,7 +86,7 @@ The Consumption plan serverless C\# environment in Bot Service has more in commo
Before you can debug your Consumption plan C# bot, you must complete these tasks.

- Download the source code for your bot (from Azure), as described in [Set up continuous deployment](bot-service-continuous-deployment.md).
- Download and install the [Bot Framework Emulator](https://github.com/Microsoft/BotFramework-Emulator/releases).
- Download and install the [Bot Framework Emulator](https://aka.ms/Emulator-wiki-getting-started).
- Install the <a href="https://www.npmjs.com/package/azure-functions-cli" target="_blank">Azure Functions CLI</a>.
- Install the <a href="https://github.com/dotnet/cli" target="_blank">DotNet CLI</a>.

Expand Down Expand Up @@ -152,4 +133,4 @@ Additionally, you can view log details in the console window.
## Next steps

> [!div class="nextstepaction"]
> [Debug with the Emulator](bot-service-debug-emulator.md).
> [Debug your bot using transcript files](~/v4sdk/bot-builder-debug-transcript.md).

0 comments on commit 2f832d3

Please sign in to comment.