[Documentation] Removing inconsistencies in botskills documentation#3567
Conversation
|
For this part here, docs/_docs/skills/handbook/add-skills-to-a-virtual-assistant.md (or relevant place, Im not sure if its documented)
Can you please mention how the skill's LU file end up in the folder |
|
@saikumaru - thanks for your feedback! We will be reviewing this and we will back to you as soon as possible 😊. |
|
@saikumaru - we updated the documentation explaining how the Skill's LU ends up in the Skills folder of the Virtual Assistant.
As soon as the TypeScript 1.0 is released, using the generator-bot-virtualassistant, you will be able to create your TypeScript Virtual Assistant which will contain the Skill folder inside it. Related to the C#, you can find it in the master branch. We will be attentive to your answer 😊. |
| The `--luisFolder` parameter can be used to point the Skill CLI at the source LU files for trigger utterances. For Skills provided within this repo these can be found in the `Deployment/Resources/LU` folder of each Skill. The CLI will automatically traverse locale folder hierarchies. This can be omitted for any of the skills we provide as the LU files are provided locally. Also, you have to specify the `--cs` (for C#) or `--ts` (for TypeScript) argument for determining the coding language of your assistant, since each language takes different folder structures that need to be taken into consideration. | ||
| The `--luisFolder` parameter can be used to point the Skill CLI at the source LU files for trigger utterances (defaults to `deployment/resources/skills/` inside your assistant folder). The CLI will automatically traverse locale folder hierarchies. This can be omitted for any of the skills we provide as the LU files are provided locally. Also, you have to specify the `--cs` (for C#) or `--ts` (for TypeScript) argument for determining the coding language of your assistant, since each language takes different folder structures that need to be taken into consideration. | ||
|
|
||
| > Note: The Bot Framework Team added the Skill's LU inside the Skill folder of the Virtual Assistant just to simplify the botskills execution as by default the tool search in the Skills folder. The Skills can be found in the [botframework-skills](https://github.com/microsoft/botframework-skills) repository. |
There was a problem hiding this comment.
We should probably remove this, per the conversation around the fact that this was to support automation pipelines. Think the right guidance is to direct to the LU files in the botframework-skills repo.
| ``` | ||
|
|
||
| The `--luisFolder` parameter can be used to point the Skill CLI at the source LU files for trigger utterances. For Skills provided within this repo these can be found in the `Deployment/Resources/LU` folder of each Skill. The CLI will automatically traverse locale folder hierarchies. This can be omitted for any of the skills we provide as the LU files are provided locally. Also, you have to specify the `--cs` (for C#) or `--ts` (for TypeScript) argument for determining the coding language of your assistant, since each language takes different folder structures that need to be taken into consideration. | ||
| The `--luisFolder` parameter can be used to point the Skill CLI at the source LU files for trigger utterances (defaults to `deployment/resources/skills/` inside your assistant folder). The CLI will automatically traverse locale folder hierarchies. This can be omitted for any of the skills we provide as the LU files are provided locally. Also, you have to specify the `--cs` (for C#) or `--ts` (for TypeScript) argument for determining the coding language of your assistant, since each language takes different folder structures that need to be taken into consideration. |
There was a problem hiding this comment.
'This can be omitted for any of the skills we provide as the LU files are provided locally.' - This feels a little confusing to me, on the basis that I think they are now intended to be used from botframework-skills.
|
|
||
| The `--luisFolder` parameter can be used to point the Skill CLI at the source LU files for trigger utterances. For Skills provided within this repo these can be found in the `Deployment/Resources/LU` folder of each Skill. The CLI will automatically traverse locale folder hierarchies. This can be omitted for any of the skills we provide as the LU files are provided locally. Also, you have to specify the `--cs` (for C#) or `--ts` (for TypeScript) argument for determining the coding language of your assistant, since each language takes different folder structures that need to be taken into consideration. | ||
|
|
||
| > Note: The Bot Framework Team added the Skill's LU inside the Skill folder of the Virtual Assistant just to simplify the botskills execution as by default the tool search in the Skills folder. The Skills can be found in the [botframework-skills](https://github.com/microsoft/botframework-skills) repository. |
There was a problem hiding this comment.
Same comment here as above.
| ``` | ||
| npm install -g botdispatch @microsoft/botframework-cli | ||
| ``` | ||
| 1. [.NET Core runtime](https://dotnet.microsoft.com/download/dotnet-core/2.1#runtime-2.1.0) 2.1.0 or higher but lower than 3.0.0 |
There was a problem hiding this comment.
I would consider using semver range representation - it should be pretty readable and standard to most people looking at this documentation I believe.
tools/botskills/README.md
Outdated
| ```shell | ||
| npm install -g botdispatch @microsoft/botframework-cli | ||
| ``` | ||
| - [.NET Core runtime](https://dotnet.microsoft.com/download/dotnet-core/2.1#runtime-2.1.0) 2.1.0 or higher but lower than 3.0.0 |
| npm install -g botdispatch @microsoft/botframework-cli | ||
| ``` | ||
|
|
||
| 1. [.NET Core runtime](https://dotnet.microsoft.com/download/dotnet-core/2.1#runtime-2.1.0) 2.1.0 or higher but lower than 3.0.0 |
peterinnesmsft
left a comment
There was a problem hiding this comment.
Looks good - couple of minor things per recent discussion on the Skills LU files that are still under the deployment resources folder.
|
Thanks @peterinnesmsft! We will be applying the feedback 😊. |
|
@peterinnesmsft - we already incorporated the requested changes! We will be attentive to your answer 😊. |
Fix #3489
Purpose
What is the context of this pull request? Why is it being done?
There were some inconsistences between documentation and the argument's explanation of botskills.
Changes
Are there any changes that need to be called out as significant or particularly difficult to grasp? (Include illustrative screenshots for context if applicable.)
We fixed the inconsistencies in the documentation and updated some outdated docs.
Tests
Is this covered by existing tests or new ones? If no, why not?
-
Feature Plan
Are there any remaining steps or dependencies before this issue can be fully resolved? If so, describe and link to any relevant pull requests or issues.
-
Checklist
General