Skip to content
This repository has been archived by the owner on Jun 30, 2022. It is now read-only.

Commit

Permalink
Merge pull request #3643 from southworks/feature/southworks/documenta…
Browse files Browse the repository at this point in the history
…tion/fix-ambiguities

[Documentation] Fix ambiguities of TypeScript and C# documentation for manifests
  • Loading branch information
peterinnesmsft committed Oct 16, 2020
2 parents e6b4351 + 19b19cb commit 0522b04
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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`)
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 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.
Original file line number Diff line number Diff line change
Expand Up @@ -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`)
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 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.
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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:3980/manifest/manifest-1.1.json`

## Adding your skill to an assistant

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit 0522b04

Please sign in to comment.