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

Commit

Permalink
[Documentation] Update botskills documentation (#3346)
Browse files Browse the repository at this point in the history
* Update botskills documentation

* Replicate changes to TS doc
  • Loading branch information
Batta32 authored May 15, 2020
1 parent 2232ed6 commit 6d0d116
Show file tree
Hide file tree
Showing 3 changed files with 45 additions and 12 deletions.
10 changes: 5 additions & 5 deletions docs/_docs/skills/handbook/botskills.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Once the connect command finish successfully, you can see under the `botFramewor
"skillHostEndpoint": "<VA-SKILL_ENDPOINT>"
```
For further information, see the [Connect command documentation]({{site.repo}}/tree/master/tools/botskills/docs/connect.md).
For further information, see the [Connect command documentation]({{site.repo}}/tree/master/tools/botskills/docs/commands/connect.md).
### Disconnect Skills
{:.no_toc}
Expand All @@ -71,7 +71,7 @@ Here is an example:
botskills disconnect --skillId <YOUR_SKILL_ID> --cs
```
For further information, see the [Disconnect command documentation]({{site.repo}}/tree/master/tools/botskills/docs/disconnect.md).
For further information, see the [Disconnect command documentation]({{site.repo}}/tree/master/tools/botskills/docs/commands/disconnect.md).
> Note: The id of the Skill can also be aquired using the `botskills list` command. You can check the [List command documentation]({{site.repo}}/tree/master/tools/botskills/docs/list.md).
Expand All @@ -85,7 +85,7 @@ Here is an example:
botskills update --remoteManifest "{{site.data.urls.SkillManifest}}" --cs
```

For further information, see the [Update command documentation]({{site.repo}}/tree/master/tools/botskills/docs/update.md).
For further information, see the [Update command documentation]({{site.repo}}/tree/master/tools/botskills/docs/commands/update.md).

### Refresh connected Skills
{:.no_toc}
Expand All @@ -97,7 +97,7 @@ Here is an example:
botskills refresh --cs
```
For further information, see the [Refresh command documentation]({{site.repo}}/tree/master/tools/botskills/docs/refresh.md).
For further information, see the [Refresh command documentation]({{site.repo}}/tree/master/tools/botskills/docs/commands/refresh.md).
### List connected Skills
{:.no_toc}
Expand All @@ -109,4 +109,4 @@ Here is an example:
botskills list
```
For further information, see the [List command documentation]({{site.repo}}/tree/master/tools/botskills/docs/list.md).
For further information, see the [List command documentation]({{site.repo}}/tree/master/tools/botskills/docs/commands/list.md).
Original file line number Diff line number Diff line change
Expand Up @@ -13,16 +13,32 @@ 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:3978/manifest/manifest-1.1.json`

## Adding your skill to an assistant

To add your new Skill to your assistant we provide the `botskills` command line tool to automate the process of adding the skill to your dispatch model and creating authentication connections where needed.
To add your new Skill to your assistant we provide the [botskills](https://www.npmjs.com/package/botskills) command line tool to automate the process of adding the skill to your dispatch model and creating authentication connections where needed.

Run the following command from a command prompt **within the directory of your assistant/Bot**.

```bash
botskills connect --remoteManifest "http://<YOUR_SKILL_MANIFEST>.azurewebsites.net/manifest/manifest-1.1.json" --cs
botskills connect --remoteManifest "https://<YOUR_SKILL_NAME>.azurewebsites.net/manifest/manifest-1.1.json" --cs
```
Remember to re-publish your assistant to Azure after you’ve added a Skill unless you plan on testing locally only.

See [Adding Skills]({{site.baseurl}}/skills/handbook/add-skills-to-a-virtual-assistant/) for more details.
Once the connect command finish successfully, you can see under the `botFrameworkSkills` property of your assistant’s appsettings.json file that the following structure was added with the information provided in the Skill manifest.

```
"botFrameworkSkills": {
"id": "<SKILL_ID>",
"appId": "<SKILL_APPID>",
"skillEndpoint": "<SKILL_ENDPOINT>",
"name": "<SKILL_NAME>",
"description": "<SKILL_DESCRIPTION>"
},
"skillHostEndpoint": "<VA-SKILL_ENDPOINT>"
```

For further documentation, please check the following links:
- [Adding Skills]({{site.baseurl}}/skills/handbook/add-skills-to-a-virtual-assistant/)
- [Connect command]({{site.repo}}/tree/master/tools/botskills/docs/commands/connect.md)
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ order: 6

## 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 (`/api/skill/manifest endpoint`). e.g. `http://localhost:3978/api/skill/manifest`
To validate your Skill is deployed and working open up a browser window and navigate to your deployed Skill manifest (`/api/skill/manifest endpoint`). e.g. `http://localhost:3978/api/skill/manifest`

## Adding your skill to an assistant

Expand All @@ -22,7 +22,24 @@ To add your new Skill to your assistant we provide the [botskills](https://www.n
Run the following command from a command prompt **within the directory of your assistant/Bot**.

```bash
botskills connect --remoteManifest "http://<YOUR_SKILL_NAME>.azurewebsites.net/api/skill/manifest" --ts
botskills connect --remoteManifest "https://<YOUR_SKILL_NAME>.azurewebsites.net/manifest/manifest-1.1.json" --ts
```

See [Adding Skills]({{site.baseurl}}/skills/handbook/add-skills-to-a-virtual-assistant/) for more details.
Remember to re-publish your assistant to Azure after you’ve added a Skill unless you plan on testing locally only.

Once the connect command finish successfully, you can see under the `botFrameworkSkills` property of your assistant’s appsettings.json file that the following structure was added with the information provided in the Skill manifest.

```
"botFrameworkSkills": {
"id": "<SKILL_ID>",
"appId": "<SKILL_APPID>",
"skillEndpoint": "<SKILL_ENDPOINT>",
"name": "<SKILL_NAME>",
"description": "<SKILL_DESCRIPTION>"
},
"skillHostEndpoint": "<VA-SKILL_ENDPOINT>"
```

For further documentation, please check the following links:
- [Adding Skills]({{site.baseurl}}/skills/handbook/add-skills-to-a-virtual-assistant/)
- [Connect command]({{site.repo}}/tree/master/tools/botskills/docs/commands/connect.md)

0 comments on commit 6d0d116

Please sign in to comment.