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

[PORT #3138][Botskills] Update tool documentation explaining new manifest schema changes #3533

Merged
merged 1 commit into from
Jul 8, 2020
Merged

[PORT #3138][Botskills] Update tool documentation explaining new manifest schema changes #3533

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions docs/_docs/skills/handbook/botskills.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,19 @@ botskills connect --remoteManifest "{{site.data.urls.SkillManifest}}" --cs

*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 Virtual Assistant's appsettings.json file that the following structure was added with the information provided in the Skill manifest.

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

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

### Disconnect Skills
Expand Down
2 changes: 1 addition & 1 deletion docs/_docs/skills/tutorials/create-skill/csharp/7-add-your-skill.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ 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 "https://<YOUR_SKILL_NAME>.azurewebsites.net/manifest/manifest-1.1.json" --cs --luisFolder "path-to-lu-folder"
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.

Expand Down
1 change: 0 additions & 1 deletion docs/_docs/skills/tutorials/create-skill/typescript/7-add-your-skill.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@ Run the following command from a command prompt **within the directory of your a
```bash
botskills connect --remoteManifest "https://<YOUR_SKILL_NAME>.azurewebsites.net/manifest/manifest-1.1.json" --ts
```

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.
Expand Down
12 changes: 6 additions & 6 deletions tools/botskills/docs/commands/connect.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,19 +44,19 @@ For Skills that require other Authentication connection configuration please fol

| Option | Description |
|-------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| -l, --localManifest \<path> | Path to local Skill Manifest file |
| -r, --remoteManifest \<url> | URL to remote Skill Manifest |
| -l, --localManifest [path] | Path to local Skill Manifest file |
| -r, --remoteManifest [url] | URL to remote Skill Manifest |
| --cs | Determine your Virtual Assistant project structure to be a csharp-like structure |
| --ts | Determine your Virtual Assistant project structure to be a TypeScript-like structure |
| --noRefresh [true\|FALSE] | (OPTIONAL) Determine whether the model of your skills connected are not going to be refreshed (by default they are refreshed) |
| -e, --endpointName \<name> | (OPTIONAL) Name of the endpoint to connect to your assistant (case sensitive) (default to using the first endpoint) |
| --noRefresh [true\|FALSE] | (OPTIONAL) Determine whether the model of your skills connected are not going to be trained (by default they are trained) |
| -e, --endpointName [name] | (OPTIONAL) Name of the endpoint to connect to your assistant (case sensitive) (default to using the first endpoint) |
| --languages [languages] | (OPTIONAL) Comma separated list of locales used for LUIS culture (defaults to `en-us`) |
| --luisFolder [path] | (OPTIONAL) Path to the folder containing your Skills' '.lu' files (defaults to './deployment/resources/skills/en' inside your Virtual Assistant folder) |
| --luisFolder [path] | (OPTIONAL) Path to the folder containing your Skills' '.lu' files (defaults to './deployment/resources/skills/en-us' inside your Virtual Assistant folder) |
| --dispatchFolder [path] | (OPTIONAL) Path to the folder containing your Virtual Assistant's `.dispatch` file (defaults to `./deployment/resources/dispatch` inside your Virtual Assistant folder) |
| --outFolder [path] | (OPTIONAL) Path for any output file that may be generated (defaults to your Virtual Assistant's root folder) |
| --lgOutFolder [path] | (OPTIONAL) Path for the Luis Generate output (defaults to a 'service' folder inside your Virtual Assistant's folder) |
| --resourceGroup [name] | (OPTIONAL) Name of your Virtual Assistant's resource group in Azure (defaults to your Virtual Assistant's bot name) |
| --appSettingsFile [path] | (OPTIONAL) Path to your appsettings file (defaults to `appsettings.json` inside your Virtual Assistant's folder) |
| --appSettingsFile [path] | (OPTIONAL) Path to your appsettings file where the skills are stored (defaults to `appsettings.json` inside your Virtual Assistant's folder) |
| --cognitiveModelsFile [path] | (OPTIONAL) Path to your Cognitive Models file (defaults to `cognitivemodels.json` inside your Virtual Assistant's folder) |
| --verbose | (OPTIONAL) Output detailed information about the processing of the tool |
| -h, --help | Output usage information |
Expand Down
6 changes: 2 additions & 4 deletions tools/botskills/docs/commands/disconnect.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ botskills disconnect [options]
| --dispatchFolder [path] | (OPTIONAL) Path to the folder containing your Virtual Assistant's `.dispatch` file (defaults to `./deployment/resources/dispatch` inside your Virtual Assistant folder) |
| --outFolder [path] | (OPTIONAL) Path for any output file that may be generated (defaults to your Virtual Assistant's root folder) |
| --lgOutFolder [path] | (OPTIONAL) Path for the Luis Generate output (defaults to a `service` folder inside your Virtual Assistant's folder) |
| --appSettingsFile [path] | (OPTIONAL) Path to your app settings file (defaults to `appsettings.json` inside your assistant's folder) |
| --appSettingsFile [path] | (OPTIONAL) Path to your appsettings file where the skills are stored (defaults to `appsettings.json` inside your Virtual Assistant's folder) |
| --cognitiveModelsFile [path] | (OPTIONAL) Path to your Cognitive Models file (defaults to `cognitivemodels.json` inside your Virtual Assistant's folder) |
| --verbose | (OPTIONAL) Output detailed information about the processing of the tool |
| -h, --help | Output usage information |
Expand All @@ -31,6 +31,4 @@ An example on how to use it:

```bash
botskills disconnect --skillId "customSkill" --cs
```

> **Note:** The path to the Virtual Assistant Skills configuration file can be relative or absolute path, and should be explicitly a `.json` file.
```
10 changes: 5 additions & 5 deletions tools/botskills/docs/commands/update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,19 +14,19 @@ botskills update [options]

| Option | Description |
|-------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| -l, --localManifest \<path> | Path to local Skill Manifest file |
| -r, --remoteManifest \<url> | URL to remote Skill Manifest |
| -l, --localManifest [path] | Path to local Skill Manifest file |
| -r, --remoteManifest [url] | URL to remote Skill Manifest |
| --cs | Determine your Virtual Assistant project structure to be a csharp-like structure |
| --ts | Determine your Virtual Assistant project structure to be a TypeScript-like structure |
| --noRefresh [true\|FALSE] | (OPTIONAL) Determine whether the model of your skills connected are not going to be trained (by default they are trained) |
| -e, --endpointName \<name> | (OPTIONAL) Name of the endpoint to connect to your assistant (case sensitive) (default to using the first endpoint) |
| -e, --endpointName [name] | (OPTIONAL) Name of the endpoint to connect to your assistant (case sensitive) (default to using the first endpoint) |
| --languages [languages] | (OPTIONAL) Comma separated list of locales used for LUIS culture (defaults to `en-us`) |
| --luisFolder [path] | (OPTIONAL) Path to the folder containing your Skills' `.lu` files (defaults to `./deployment/resources/skills/en` inside your Virtual Assistant folder) |
| --luisFolder [path] | (OPTIONAL) Path to the folder containing your Skills' `.lu` files (defaults to `./deployment/resources/skills/en-us` inside your Virtual Assistant folder) |
| --dispatchFolder [path] | (OPTIONAL) Path to the folder containing your Virtual Assistant's `.dispatch` file (defaults to `./deployment/resources/dispatch` inside your Virtual Assistant folder) |
| --outFolder [path] | (OPTIONAL) Path for any output file that may be generated (defaults to your Virtual Assistant's root folder) |
| --lgOutFolder [path] | (OPTIONAL) Path for the Luis Generate output (defaults to a 'service' folder inside your Virtual Assistant's folder) |
| --resourceGroup [name] | (OPTIONAL) Name of your Virtual Assistant's resource group in Azure (defaults to your Virtual Assistant's bot name) |
| --appSettingsFile [path] | (OPTIONAL) Path to your appsettings file (defaults to `appsettings.json` inside your Virtual Assistant's folder) |
| --appSettingsFile [path] | (OPTIONAL) Path to your appsettings file where the skills are stored (defaults to `appsettings.json` inside your Virtual Assistant's folder) |
| --cognitiveModelsFile [path] | (OPTIONAL) Path to your Cognitive Models file (defaults to `cognitivemodels.json` inside your Virtual Assistant's folder) |
| --verbose | (OPTIONAL) Output detailed information about the processing of the tool |
| -h, --help | Output usage information |
Expand Down