From 50d05dd94d68bc1e531f72015c78587d7fcadc36 Mon Sep 17 00:00:00 2001 From: Martin Battaglino Date: Mon, 31 Aug 2020 12:36:51 -0300 Subject: [PATCH 1/4] Fix ambiguities of TypeScript and C# documentation of Skill Manifest --- .../tutorials/create-skill/csharp/5-update-manifest.md | 7 ++++++- .../create-skill/typescript/5-update-manifest.md | 9 +++++++-- .../create-skill/typescript/7-add-your-skill.md | 2 +- 3 files changed, 14 insertions(+), 4 deletions(-) diff --git a/docs/_docs/skills/tutorials/create-skill/csharp/5-update-manifest.md b/docs/_docs/skills/tutorials/create-skill/csharp/5-update-manifest.md index fb2b4360e0..ff7ec790af 100644 --- a/docs/_docs/skills/tutorials/create-skill/csharp/5-update-manifest.md +++ b/docs/_docs/skills/tutorials/create-skill/csharp/5-update-manifest.md @@ -17,4 +17,9 @@ A default manifest describing your Skill is provided as part of the project, you 1. Update `{YOUR_SKILL_APPID}` with the Active Directory AppID of your deployed Skill, you can find this within your `appSettings.json` file. -1. Publish the changes to your Skill endpoint and validate that you can retrieve the manifest using the browser (`/manifest/manifest-1.1.json`) \ No newline at end of file +1. Publish the changes to your Skill endpoint and validate that you can retrieve the manifest using the browser (`/manifest/manifest-1.1.json`). Check the [deployment scripts](https://microsoft.github.io/botframework-solutions/virtual-assistant/handbook/deployment-scripts/) document. +```powershell +.\Deployment\Scripts\publish.ps1 -botWebAppName {YOUR_SKILL_BOTWEBAPP_NAME} -resourceGroup {YOUR_RESOURCEGROUP_NAME} +``` + +> **Note**: `{YOUR_SKILL_URL}` is the endpoint URL where the Skill will receive the messages (e.g. `http://localhost:3979/api/messages`). Also, `{YOUR_SKILL_APPID}` is the `microsoftAppIp` value, the `{YOUR_SKILL_BOTWEBAPP_NAME}` is the `botWebAppName` and the `{YOUR_RESOURCEGROUP_NAME}` is the `resourceGroupName` that you can find in the `appsettings.json` file populated after the deployment of the Skill. \ No newline at end of file diff --git a/docs/_docs/skills/tutorials/create-skill/typescript/5-update-manifest.md b/docs/_docs/skills/tutorials/create-skill/typescript/5-update-manifest.md index f615673c69..3d28ca7fb0 100644 --- a/docs/_docs/skills/tutorials/create-skill/typescript/5-update-manifest.md +++ b/docs/_docs/skills/tutorials/create-skill/typescript/5-update-manifest.md @@ -11,10 +11,15 @@ order: 5 ## {{ page.title }} -A default manifest describing your Skill is provided as part of the project, you can find this within the `wwwroot\src\manifest` folder. Following deployment this requires updating with the deployment URL and Azure AD Application ID. `manifest-1.0` is provided for Power Virtual Agent support only, you should use `manifest-1.1` for Virtual Assistant scenarios. +A default manifest describing your Skill is provided as part of the project, you can find this within the `src\manifest` folder. Following deployment this requires updating with the deployment URL and Azure AD Application ID. `manifest-1.0` is provided for Power Virtual Agent support only, you should use `manifest-1.1` for Virtual Assistant scenarios. 1. Update `{YOUR_SKILL_URL}` with the URL of your deployed Skill endpoint, this must be prefixed with https. 1. Update `{YOUR_SKILL_APPID}` with the Active Directory AppID of your deployed Skill, you can find this within your `appSettings.json` file. -1. Publish the changes to your Skill endpoint and validate that you can retrieve the manifest using the browser (`/manifest/manifest-1.1.json`) \ No newline at end of file +1. Publish the changes to your Skill endpoint and validate that you can retrieve the manifest using the browser (`/manifest/manifest-1.1.json`). Check the [deployment scripts](https://microsoft.github.io/botframework-solutions/virtual-assistant/handbook/deployment-scripts/) document. +```powershell +.\Deployment\Scripts\publish.ps1 -botWebAppName {YOUR_SKILL_BOTWEBAPP_NAME} -resourceGroup {YOUR_RESOURCEGROUP_NAME} +``` + +> **Note**: `{YOUR_SKILL_URL}` is the endpoint URL where the Skill will receive the messages (e.g. `http://localhost:3979/api/messages`). Also, `{YOUR_SKILL_APPID}` is the `microsoftAppIp` value, the `{YOUR_SKILL_BOTWEBAPP_NAME}` is the `botWebAppName` and the `{YOUR_RESOURCEGROUP_NAME}` is the `resourceGroupName` that you can find in the `appsettings.json` file populated after the deployment of the Skill. \ No newline at end of file diff --git a/docs/_docs/skills/tutorials/create-skill/typescript/7-add-your-skill.md b/docs/_docs/skills/tutorials/create-skill/typescript/7-add-your-skill.md index bc810924ac..d83543be79 100644 --- a/docs/_docs/skills/tutorials/create-skill/typescript/7-add-your-skill.md +++ b/docs/_docs/skills/tutorials/create-skill/typescript/7-add-your-skill.md @@ -13,7 +13,7 @@ order: 7 ## Validate the Skill manifest endpoint -To validate your Skill is deployed and working open up a browser window and navigate to your deployed Skill manifest. e.g. `http://localhost:3978/src/manifest/manifest-1.1.json` +To validate your Skill is deployed and working open up a browser window and navigate to your deployed Skill manifest. e.g. `http://localhost:3978/manifest/manifest-1.1.json` ## Adding your skill to an assistant From 27c44852c00c2f62c4509a6a4de04f7518b69d5b Mon Sep 17 00:00:00 2001 From: Martin Battaglino Date: Wed, 2 Sep 2020 09:49:15 -0300 Subject: [PATCH 2/4] Fix typo of MicrosoftAppId --- .../skills/tutorials/create-skill/csharp/5-update-manifest.md | 2 +- .../tutorials/create-skill/typescript/5-update-manifest.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/_docs/skills/tutorials/create-skill/csharp/5-update-manifest.md b/docs/_docs/skills/tutorials/create-skill/csharp/5-update-manifest.md index ff7ec790af..db33a3c1e3 100644 --- a/docs/_docs/skills/tutorials/create-skill/csharp/5-update-manifest.md +++ b/docs/_docs/skills/tutorials/create-skill/csharp/5-update-manifest.md @@ -22,4 +22,4 @@ A default manifest describing your Skill is provided as part of the project, you .\Deployment\Scripts\publish.ps1 -botWebAppName {YOUR_SKILL_BOTWEBAPP_NAME} -resourceGroup {YOUR_RESOURCEGROUP_NAME} ``` -> **Note**: `{YOUR_SKILL_URL}` is the endpoint URL where the Skill will receive the messages (e.g. `http://localhost:3979/api/messages`). Also, `{YOUR_SKILL_APPID}` is the `microsoftAppIp` value, the `{YOUR_SKILL_BOTWEBAPP_NAME}` is the `botWebAppName` and the `{YOUR_RESOURCEGROUP_NAME}` is the `resourceGroupName` that you can find in the `appsettings.json` file populated after the deployment of the Skill. \ No newline at end of file +> **Note**: `{YOUR_SKILL_URL}` is the endpoint URL where the Skill will receive the messages (e.g. `http://localhost:3979/api/messages`). Also, `{YOUR_SKILL_APPID}` is the `microsoftAppId` value, the `{YOUR_SKILL_BOTWEBAPP_NAME}` is the `botWebAppName` and the `{YOUR_RESOURCEGROUP_NAME}` is the `resourceGroupName` that you can find in the `appsettings.json` file populated after the deployment of the Skill. \ No newline at end of file diff --git a/docs/_docs/skills/tutorials/create-skill/typescript/5-update-manifest.md b/docs/_docs/skills/tutorials/create-skill/typescript/5-update-manifest.md index 3d28ca7fb0..f701530037 100644 --- a/docs/_docs/skills/tutorials/create-skill/typescript/5-update-manifest.md +++ b/docs/_docs/skills/tutorials/create-skill/typescript/5-update-manifest.md @@ -22,4 +22,4 @@ A default manifest describing your Skill is provided as part of the project, you .\Deployment\Scripts\publish.ps1 -botWebAppName {YOUR_SKILL_BOTWEBAPP_NAME} -resourceGroup {YOUR_RESOURCEGROUP_NAME} ``` -> **Note**: `{YOUR_SKILL_URL}` is the endpoint URL where the Skill will receive the messages (e.g. `http://localhost:3979/api/messages`). Also, `{YOUR_SKILL_APPID}` is the `microsoftAppIp` value, the `{YOUR_SKILL_BOTWEBAPP_NAME}` is the `botWebAppName` and the `{YOUR_RESOURCEGROUP_NAME}` is the `resourceGroupName` that you can find in the `appsettings.json` file populated after the deployment of the Skill. \ No newline at end of file +> **Note**: `{YOUR_SKILL_URL}` is the endpoint URL where the Skill will receive the messages (e.g. `http://localhost:3979/api/messages`). Also, `{YOUR_SKILL_APPID}` is the `microsoftAppId` value, the `{YOUR_SKILL_BOTWEBAPP_NAME}` is the `botWebAppName` and the `{YOUR_RESOURCEGROUP_NAME}` is the `resourceGroupName` that you can find in the `appsettings.json` file populated after the deployment of the Skill. \ No newline at end of file From d5c46c3da369e3c3469bafe1fbbcb6788d17617b Mon Sep 17 00:00:00 2001 From: Martin Battaglino Date: Thu, 3 Sep 2020 10:03:04 -0300 Subject: [PATCH 3/4] Update the example of the note relating the SKILL URL to the Messaging Endpoint --- .../skills/tutorials/create-skill/csharp/5-update-manifest.md | 2 +- .../tutorials/create-skill/typescript/5-update-manifest.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/_docs/skills/tutorials/create-skill/csharp/5-update-manifest.md b/docs/_docs/skills/tutorials/create-skill/csharp/5-update-manifest.md index db33a3c1e3..12ce430b76 100644 --- a/docs/_docs/skills/tutorials/create-skill/csharp/5-update-manifest.md +++ b/docs/_docs/skills/tutorials/create-skill/csharp/5-update-manifest.md @@ -22,4 +22,4 @@ A default manifest describing your Skill is provided as part of the project, you .\Deployment\Scripts\publish.ps1 -botWebAppName {YOUR_SKILL_BOTWEBAPP_NAME} -resourceGroup {YOUR_RESOURCEGROUP_NAME} ``` -> **Note**: `{YOUR_SKILL_URL}` is the endpoint URL where the Skill will receive the messages (e.g. `http://localhost:3979/api/messages`). Also, `{YOUR_SKILL_APPID}` is the `microsoftAppId` value, the `{YOUR_SKILL_BOTWEBAPP_NAME}` is the `botWebAppName` and the `{YOUR_RESOURCEGROUP_NAME}` is the `resourceGroupName` that you can find in the `appsettings.json` file populated after the deployment of the Skill. \ No newline at end of file +> **Note**: `{YOUR_SKILL_URL}` is the endpoint URL where the Skill will receive the messages that matches with the "Messaging endpoint" of the Web App Bot resource after deployment (e.g. `https://bf-skill.azurewebsites.net/api/messages`). Also, `{YOUR_SKILL_APPID}` is the `microsoftAppId` value, the `{YOUR_SKILL_BOTWEBAPP_NAME}` is the `botWebAppName` and the `{YOUR_RESOURCEGROUP_NAME}` is the `resourceGroupName` that you can find in the `appsettings.json` file populated after the deployment of the Skill. \ No newline at end of file diff --git a/docs/_docs/skills/tutorials/create-skill/typescript/5-update-manifest.md b/docs/_docs/skills/tutorials/create-skill/typescript/5-update-manifest.md index f701530037..d263caa16a 100644 --- a/docs/_docs/skills/tutorials/create-skill/typescript/5-update-manifest.md +++ b/docs/_docs/skills/tutorials/create-skill/typescript/5-update-manifest.md @@ -22,4 +22,4 @@ A default manifest describing your Skill is provided as part of the project, you .\Deployment\Scripts\publish.ps1 -botWebAppName {YOUR_SKILL_BOTWEBAPP_NAME} -resourceGroup {YOUR_RESOURCEGROUP_NAME} ``` -> **Note**: `{YOUR_SKILL_URL}` is the endpoint URL where the Skill will receive the messages (e.g. `http://localhost:3979/api/messages`). Also, `{YOUR_SKILL_APPID}` is the `microsoftAppId` value, the `{YOUR_SKILL_BOTWEBAPP_NAME}` is the `botWebAppName` and the `{YOUR_RESOURCEGROUP_NAME}` is the `resourceGroupName` that you can find in the `appsettings.json` file populated after the deployment of the Skill. \ No newline at end of file +> **Note**: `{YOUR_SKILL_URL}` is the endpoint URL where the Skill will receive the messages that matches with the "Messaging endpoint" of the Web App Bot resource after deployment (e.g. `https://bf-skill.azurewebsites.net/api/messages`). Also, `{YOUR_SKILL_APPID}` is the `microsoftAppId` value, the `{YOUR_SKILL_BOTWEBAPP_NAME}` is the `botWebAppName` and the `{YOUR_RESOURCEGROUP_NAME}` is the `resourceGroupName` that you can find in the `appsettings.json` file populated after the deployment of the Skill. \ No newline at end of file From e1a35b76b8473fcd96b83be299dbe8278a325d7d Mon Sep 17 00:00:00 2001 From: Martin Battaglino Date: Thu, 3 Sep 2020 10:03:31 -0300 Subject: [PATCH 4/4] Fix port of the TypeScript endpoints --- .../tutorials/create-skill/typescript/6-run-your-skill.md | 2 +- .../tutorials/create-skill/typescript/7-add-your-skill.md | 2 +- .../create-assistant/typescript/5-run-your-assistant.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/_docs/skills/tutorials/create-skill/typescript/6-run-your-skill.md b/docs/_docs/skills/tutorials/create-skill/typescript/6-run-your-skill.md index a10dcb2086..e8dfa4b9f3 100644 --- a/docs/_docs/skills/tutorials/create-skill/typescript/6-run-your-skill.md +++ b/docs/_docs/skills/tutorials/create-skill/typescript/6-run-your-skill.md @@ -20,7 +20,7 @@ After deployment, you can run and test your Skill project using these steps: ![]({{site.baseurl}}/assets/images/quickstart-virtualassistant-openbot.png) -1. Provide the messaging endpoint of your running bot (e.g: http://localhost:3978/api/messages). +1. Provide the messaging endpoint of your running bot (e.g: http://localhost:3980/api/messages). 1. Provide the Microsoft App ID and Microsoft App Password values from your **appsettings.json** file. ![]({{site.baseurl}}/assets/images/quickstart-virtualassistant-openbotmodal.png) diff --git a/docs/_docs/skills/tutorials/create-skill/typescript/7-add-your-skill.md b/docs/_docs/skills/tutorials/create-skill/typescript/7-add-your-skill.md index d83543be79..252c50964f 100644 --- a/docs/_docs/skills/tutorials/create-skill/typescript/7-add-your-skill.md +++ b/docs/_docs/skills/tutorials/create-skill/typescript/7-add-your-skill.md @@ -13,7 +13,7 @@ order: 7 ## Validate the Skill manifest endpoint -To validate your Skill is deployed and working open up a browser window and navigate to your deployed Skill manifest. e.g. `http://localhost:3978/manifest/manifest-1.1.json` +To validate your Skill is deployed and working open up a browser window and navigate to your deployed Skill manifest. e.g. `http://localhost:3980/manifest/manifest-1.1.json` ## Adding your skill to an assistant diff --git a/docs/_docs/virtual-assistant/tutorials/create-assistant/typescript/5-run-your-assistant.md b/docs/_docs/virtual-assistant/tutorials/create-assistant/typescript/5-run-your-assistant.md index 3bd4ce9b99..df75e40348 100644 --- a/docs/_docs/virtual-assistant/tutorials/create-assistant/typescript/5-run-your-assistant.md +++ b/docs/_docs/virtual-assistant/tutorials/create-assistant/typescript/5-run-your-assistant.md @@ -20,7 +20,7 @@ After deployment, you can run and test your Virtual Assistant project using thes ![]({{site.baseurl}}/assets/images/quickstart-virtualassistant-openbot.png) -1. Provide the messaging endpoint of your running bot (e.g: http://localhost:3978/api/messages). +1. Provide the messaging endpoint of your running bot (e.g: http://localhost:3979/api/messages). 1. Provide the Microsoft App ID and Microsoft App Password values from your **appsettings.json** file. ![]({{site.baseurl}}/assets/images/quickstart-virtualassistant-openbotmodal.png)