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

Commit

Permalink
[Docs] Update links in Overview, VA, Skill, Solution Accelerator sect…
Browse files Browse the repository at this point in the history
…ions (#2640)

* Updated links from reviewing home and overview

* Begin review of solution accelerators section

* Review the rest of solution accelerators

* Updated Skills sections

* Update VA section

* Updated FAQ links
Updated names of create,customize,deploy VA tutorials
  • Loading branch information
ryanisgrig committed Nov 2, 2019
1 parent 8542006 commit c1769cb
Show file tree
Hide file tree
Showing 81 changed files with 240 additions and 537 deletions.
15 changes: 7 additions & 8 deletions docs/_data/toc.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,9 @@
Overview:
Virtual Assistant:
- Create a Virtual Assistant
- Customize a Virtual Assistant
- Deploy a Virtual Assistant
- Create
- Customize
- Deploy
- Handbook
- Samples
Skills:
- Create a Skill
- Customize a Skill
Expand All @@ -14,15 +13,15 @@ Skills:
- Handbook
- Samples
Solution Accelerators:
- Enable proactive notifications
- View analytics using Power BI
- Assistants
- Samples
- Enable proactive notifications
- View analytics using Power BI
Clients and Channels:
- Extend to Direct Line Speech
- Extend to Microsoft Teams
- Clients
- Channels
- Extend to Direct Line Speech
- Extend to Microsoft Teams
Additional resources:
- Analytics
- Deployment
Expand Down
16 changes: 0 additions & 16 deletions docs/_docs/_samples/_howto.md

This file was deleted.

16 changes: 0 additions & 16 deletions docs/_docs/_samples/_reference.md

This file was deleted.

56 changes: 27 additions & 29 deletions docs/_docs/help/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,106 +18,106 @@ This greatly simplifies the creation of a new bot project by providing basic con

### What is the architecture of a Virtual Assistant solution?
{:.no_toc}
Learn more about the [Virtual Assistant solution architecture]().
Learn more about the [Virtual Assistant solution architecture]({{site.baseurl}}/overview/virtual-assistant-solution).

### How do I create a Virtual Assistant?
{:.no_toc}
Follow a guided tutorial to create a Virtual Assistant (available in [C#]() or [Typescript]()).
Follow a guided tutorial to create a Virtual Assistant (available in [C#]({{site.baseurl}}/virtual-assistant/tutorials/create-assistant/csharp/1-intro) or [Typescript]({{site.baseurl}}/virtual-assistant/tutorials/create-assistant/typescript/1-intro)).

### How do I customize a Virtual Assistant?
{:.no_toc}
Follow a guided tutorial to customize a Virtual Assistant (available in [C#]() or [Typescript]()).
Follow a guided tutorial to customize a Virtual Assistant (available in [C#]({{site.baseurl}}/virtual-assistant/tutorials/customize-assistant/csharp/1-intro) or [Typescript]({{site.baseurl}})/virtual-assistant/tutorials/customize-assistant/typescript/1-intro).

### How do I deploy a Virtual Assistant?
{:.no_toc}
Learn how to deploy a Virtual Assistant by [automated scripts]() or [manual configuration]().
Learn how to deploy a Virtual Assistant by [automated scripts]({{site.baseurl}}/help/reference/deployment-scripts) or [manual configuration]({{site.baseurl}}/virtual-assistant/tutorials/deploy-assistant/cli/1-intro).

### How do I test a Virtual Assistant?
{:.no_toc}
Learn how to [test a Virtual Assistant]().
Learn how to [test a Virtual Assistant]({{site.baseurl}}/virtual-assistant/handbook/testing/).

### How do I pass events to a Virtual Assistant?
{:.no_toc}
Event activities are used to pass metadata between a Bot and user without being visible to the user. The data from these activities can be processed by a Virtual Assistant to fulfill scenarios like providing a summary of the day ahead or filling semantic action slots on a Skill.
Learn more on [sample event activities packaged with the Virtual Assistant template]().
Learn more on [sample event activities packaged with the Virtual Assistant template]({{site.baseurl}}/virtual-assistant/handbook/events/).

### How do I link user accounts to a Virtual Assistant?
{:.no_toc}
Learn how to [link user accounts to a Virtual Assistant]().
Learn how to [link user accounts to a Virtual Assistant]({{site.baseurl}}/solution-accelerators/samples/linked-accounts/).

### How do I collect feedback from users for a Virtual Assistant?
{:.no_toc}
Learn more about using the [sample feedback middleware that enables you to capture feedback from a Virtual Assistant's users]() in Application Insights telemetry.
Learn more about using the [sample feedback middleware that enables you to capture feedback from a Virtual Assistant's users]({{site.baseurl}}/virtual-assistant/handbook/feedback/) in Application Insights telemetry.

### How does localization work for a Virtual Assistant?
{:.no_toc}
Learn how to [manage localization across a Virtual Assistant environment]().
Learn how to [manage localization across a Virtual Assistant environment]({{site.baseurl}}/virtual-assistant/handbook/localization/).

### How do I send proactive messages to users?
{:.no_toc}
Learn how to [send proactive messages to users]().
Learn how to [send proactive messages to users]({{site.baseurl}}/solution-accelerators/samples/proactive-notifications/).

### How do I convert from the Enterprise Template to the Virtual Assistant Template?
{:.no_toc}
Learn how to [convert from the Enterprise Template to the Virtual Assistant Template]().
Learn how to [convert from the Enterprise Template to the Virtual Assistant Template]({{site.baseurl}}/virtual-assistant/handbook/migration/).

### What happened to the Virtual Assistant solution (v0.3 and earlier)?
{:.no_toc}
The Virtual Assistant solution from v0.3 and earlier was delivered with multiple sample SKills to support productivty and point of interest scenarios. These are now available as indepdendent [Bot Framework SKills], reusable Skills that can be added to an existing bot.
The Virtual Assistant solution from v0.3 and earlier was delivered with multiple sample Skills to support productivty and point of interest scenarios. These are now available as indepdendent [Bot Framework SKills], reusable Skills that can be added to an existing bot.

## Skills

### What is a Bot Framework Skill?
{:.no_toc}
Bot Framework SKills are re-usable skill building blocks covering conversational use-cases, enabling you to add extensive functionality to a Bot within minutes.
Bot Framework Skills are re-usable skill building blocks covering conversational use-cases, enabling you to add extensive functionality to a Bot within minutes.
Skills include Language Understanding models, dialogs, and integration code, and are delivered in source code - enabling you to customize and extend as required.

### What sample Skills are available?
{:.no_toc}
The following sample Skills are available out of the box, with appropriate steps required to deploy and configure for your own use/
- [Calendar]()
- [Email]()
- [To Do]()
- [Point of Interest]()
- [Experimental]()
- [Calendar]({{site.baseurl}}/skills/samples/calendar)
- [Email]({{site.baseurl}}/skills/samples/email)
- [To Do]({{site.baseurl}}/skills/samples/to-do)
- [Point of Interest]({{site.baseurl}}/skills/samples/point-of-interest)
- [Experimental]({{site.baseurl}}/skills/samples/experimental)

### How do I create a Bot Framework Skill?
{:.no_toc}
Follow a guided tutorial to create a Bot Framework Skill (available in [C#]() or [Typescript]()).
Follow a guided tutorial to create a Bot Framework Skill (available in [C#]({{site.baseurl}}/skills/tutorials/create-skill/csharp/1-intro) or [Typescript]({{site.baseurl}}/skills/tutorials/create-skill/typescript/1-intro)).

### How do I customize a Bot Framework Skill?
{:.no_toc}
Follow a guided tutorial to customize a Bot Framework Skill (available in [C#]() or [Typescript]()).
Follow a guided tutorial to customize a Bot Framework Skill (available in [C#]({{site.baseurl}}/skills/tutorials/customize-skill/csharp/1-intro) or [Typescript]({{site.baseurl}}/skills/tutorials/customize-skill/typescript/1-intro)).

### What are the best practices when developing custom Bot Framework Skills?
{:.no_toc}
Learn the [best practices when developing a custom Bot Framework Skill]().
Learn the [best practices when developing a custom Bot Framework Skill]({{site.baseurl}}/skills/handbook/best-practices).

### How do I add Skills to a Virtual Assistant?
{:.no_toc}
Learn how to [add SKills to a Virtual Assistant]().
Learn how to [add Skills to a Virtual Assistant]({{site.baseurl}}/skills/handbook/add-skills-to-a-virtual-assistant).

### What is a Bot Framework Skill manifest?
{:.no_toc}
The [Bot Framework Skill manifest]() enables Skills to be self-describing in that they communicate the name and sceription of a SKill, it's authentication requirements (if appropriate), along with discrete actions it exposes.
The [Bot Framework Skill manifest]({{site.baseurl}}/skills/handbook/manifest) enables Skills to be self-describing in that they communicate the name and sceription of a SKill, it's authentication requirements (if appropriate), along with discrete actions it exposes.

This manifest provides all of the metadata required for a calling Bot to know when to trigger invoking a Skill and what actions it provides. The manifest is used by the Botskills command line tool to configure a Bot to make use of a SKill.

### How does Bot Framework Skill authentication work?
{:.no_toc}
A Skill needs to be able to authenticate the request from a Virtual Assistant, [learn how a Skill uses JWT and whitelist authentication]().
A Skill needs to be able to authenticate the request from a Virtual Assistant, [learn how a Skill uses JWT and whitelist authentication]({{site.baseurl}}/skills/handbook/authentication).

### What is the Botskills Command Line (CLI) tool?
{:.no_toc}
[Botskills command line tool]() allows you to automate teh connection between a Virtual Assistant and your Skills; this includes the process of updating your dispatch models and creating authentication connections when needed.
[Botskills command line tool]({{site.baseurl}}/help/reference/botskills) allows you to automate the connection between a Virtual Assistant and your Skills; this includes the process of updating your dispatch models and creating authentication connections when needed.

### How do I enable Bot Framework Skills on an existing v4 Bot?
{:.no_toc}
Learn how to [enable Bot Framework Skill support on an existing v4 Bot]().
Learn how to [enable Bot Framework Skill support on an existing v4 Bot]({{site.baseurl}}/skills/tutorials/extend-v4-bot/csharp/1-intro).

### How do I convert an existing v4 Bot to a Bot Framework Skill?
{:.no_toc}
Learn how to [convert an existing v4 Bot to a Bot Framework Skill]().
Learn how to [convert an existing v4 Bot to a Bot Framework Skill]({{site.baseurl}}/skills/tutorials/convert-v4-bot/csharp/1-intro).

## Analytics

Expand All @@ -133,8 +133,6 @@ Learn how to [convert an existing v4 Bot to a Bot Framework Skill]().
{:.no_toc}
Bot Framework can use the Application Insights telemetry to provide information about how your bot is performing, and track key metrics. The Bot Framework SDK ships with several samples that demonstrate how to add telemetry to your bot and produce reports (included).

Common queries for bot analytics are available in [Application Insights Analytics]().

Examples of Power BI dashboards are provided in the [Power BI Analytics sample](https://aka.ms/botPowerBiTemplate), highlighting how to gain insights on your bot's performance and quality.

### Where can I download the sample Power BI for a Virtual Assistant?
Expand Down
2 changes: 1 addition & 1 deletion docs/_docs/help/known-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Due to a limitation with the LUIS authoring APIs the original deployment scripts

This may cause you to also experience `Forbidden` LUIS errors when testing your Bot as you may have exhausted the quota for your starter LUIS key, changing from your starter LUIS subscription key will resolve this.

This has now been resolved in the latest deployment scripts which you can update to following [these instructions]({{site.baseurl}}/reference/virtual-assistant/deploymentscripts#updating-your-deployment-scripts). If you have an existing deployment you'll have to manually perform the following steps:
This has now been resolved in the latest deployment scripts which you can update to following [these instructions]({{site.baseurl}}/help/reference/deployment-scripts/#updating-your-deployment-scripts). If you have an existing deployment you'll have to manually perform the following steps:

1. As shown below go through **each LUIS model including Dispatch**, click Assign Resoucre and locate the appropriate subscription key and then re-publish.

Expand Down
2 changes: 1 addition & 1 deletion docs/_docs/help/reference/botskills.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ The CLI performs the following operations on your behalf:
4. Refresh the dispatch LUIS model with the new utterances.
5. In the case of **Active Directory Authentication Providers**, an authentication connection will be added to your Bot automatically and the associated Scopes added to your Azure AD application that backs your deployed Assistant.

> Your Virtual Assistant must have been deployed using the [deployment tutorial]({{site.baseurl}}/tutorials/csharp/create-assistant/4_provision_your_azure_resources) before using the `botskills` CLI as it relies on the Dispatch models being available and a deployed Bot for authentication connection information.
> Your Virtual Assistant must have been deployed using the [deployment tutorial]({{site.baseurl}}/virtual-assistant/tutorials/create-assistant/csharp/4-provision-your-azure-resources) before using the `botskills` CLI as it relies on the Dispatch models being available and a deployed Bot for authentication connection information.
## Prerequisites
- [Node.js](https://nodejs.org/) version 10.8 or higher
Expand Down
71 changes: 0 additions & 71 deletions docs/_docs/overview/virtual-assistant-skills-pattern.md

This file was deleted.

Loading

0 comments on commit c1769cb

Please sign in to comment.