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

Commit 2a0162d

Browse files
xieofxiedarrenj
authored andcommitted
[Docs][Master]fix proactive notifications and new line in code block (#2885)
* [Docs]fix proactive notifications and new line in code block leads to error * fix more links via html-proofer
1 parent 7f6b555 commit 2a0162d

File tree

21 files changed

+45
-47
lines changed

21 files changed

+45
-47
lines changed

docs/_docs/help/faq.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Follow a guided tutorial to customize a Virtual Assistant (available in [C#]({{s
3030

3131
### How do I deploy a Virtual Assistant?
3232
{:.no_toc}
33-
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).
33+
Learn how to deploy a Virtual Assistant by [automated scripts]({{site.baseurl}}/virtual-assistant/handbook/deployment-scripts) or [manual configuration]({{site.baseurl}}/virtual-assistant/tutorials/deploy-assistant/cli/1-intro).
3434

3535
### How do I test a Virtual Assistant?
3636
{:.no_toc}
@@ -109,7 +109,7 @@ A Skill needs to be able to authenticate the request from a Virtual Assistant, [
109109

110110
### What is the Botskills Command Line (CLI) tool?
111111
{:.no_toc}
112-
[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.
112+
[Botskills command line tool]({{site.baseurl}}/skills/handbook/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.
113113

114114
### How do I enable Bot Framework Skills on an existing v4 Bot?
115115
{:.no_toc}
@@ -127,7 +127,7 @@ Learn how to [convert an existing v4 Bot to a Bot Framework Skill]({{site.baseur
127127

128128
[Power BI](https://powerbi.microsoft.com/) is a business analytics services that lets you visualize your data and share insights across your organization. You can ingest data from Application Insights into live dashboards and reports.
129129

130-
[Learn more]({{site.baseurl}}/overview/analytics/)
130+
[Learn more]({{site.baseurl}}/solution-accelerators/tutorials/view-analytics/1-intro/)
131131

132132
### How do I configure Application Insights for a bot or Virtual Assistant?
133133
{:.no_toc}

docs/_docs/help/known-issues.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -62,16 +62,15 @@ QnAMaker has a central Cognitive Service resource that must be deployed in `west
6262
If you try to use the PowerBI analytics dashboard with your Virtual Assistant / Skills and experience a `Errors in FlowAggregates` issue or experience some telemetry not being collected this likely relates to a bug experienced in the initial version of the Virtual Assistant template and Skills which has now been addressed.
6363

6464
1. Change `appInsights` in appSettings.config to `ApplicationInsights`
65-
6665
```
6766
"ApplicationInsights": {
6867
"InstrumentationKey": ""
69-
}
68+
}
7069
```
7170

72-
2. Update your `BotServices.cs` file with the changes [here]({{site.baseurl}}/blob/master/templates/Virtual-Assistant-Template/csharp/Sample/VirtualAssistantSample/Services/BotServices.cs).
71+
2. Update your `BotServices.cs` file with the changes [here]({{site.repo}}/blob/master/templates/Virtual-Assistant-Template/csharp/Sample/VirtualAssistantSample/Services/BotServices.cs).
7372

74-
3. Update your `Startup.cs` file with the changes [here]({{site.baseurl}}/blob/master/templates/Virtual-Assistant-Template/csharp/Sample/VirtualAssistantSample/Startup.cs)
73+
3. Update your `Startup.cs` file with the changes [here]({{site.repo}}/blob/master/templates/Virtual-Assistant-Template/csharp/Sample/VirtualAssistantSample/Startup.cs)
7574

7675
4. Existing data in your Application Insights may cause the error to persist. You can either drop and re-create your Application insights resource updating the appSettings.config file with the new Instrumentation key or follow these [purge instructions](https://docs.microsoft.com/en-us/rest/api/application-insights/components/purge).
7776

@@ -82,7 +81,7 @@ Due to a limitation with the LUIS authoring APIs the original deployment scripts
8281

8382
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.
8483

85-
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:
84+
This has now been resolved in the latest deployment scripts which you can update to following [these instructions]({{site.baseurl}}/virtual-assistant/handbook/deployment-scripts/#updating-your-deployment-scripts). If you have an existing deployment you'll have to manually perform the following steps:
8685

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

docs/_docs/overview/virtual-assistant-solution.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Further skills can be created and made available either through your own assista
2222

2323
Extend a Virtual Assistant experience with reusable [Bot Framework Skills]({{site.baseurl}}/overview/skills), fulfilling common scenarios such as finding a nearby point of interest, checking off an item on a to-do list, or replying to an email. Skills can be fully customized and samples are available, enabling you to get started with multiple languages, dialogs, and code.
2424

25-
Review analytics captured from the out-of-the-box Application Insights telemetry using the [Virtual Assistant Analytics Power BI template]({{site.baseurl}}/virtual-assistant/tutorials/create-assistant/csharp/1-intro/).
25+
Review analytics captured from the out-of-the-box Application Insights telemetry using the [Virtual Assistant Analytics Power BI template]({{site.baseurl}}/solution-accelerators/tutorials/view-analytics/1-intro).
2626

2727

2828
## Key Principles
@@ -37,7 +37,7 @@ Your Virtual Assistant will be deployed within your Azure subscription. Therefor
3737
### Write once, embed anywhere
3838
{:.no_toc}
3939

40-
The Virtual Assistant Solution Accelerator leverages Azure Cognitive Services and can be embedded on any [Bot Framework channel](https://docs.microsoft.com/en-us/azure/bot-service/bot-service-manage-channels?view=azure-bot-service-4.0) such as Web Chat, Facebook Messenger, or [Microsoft Teams]({{site.baseurl}}/virtual-assistant/tutorials/enable-teams/1-intro/). You can use the [Direct Line](https://docs.microsoft.com/en-us/azure/bot-service/bot-service-channel-directline?view=azure-bot-service-4.0) channel to integrate a Virtual Assistant into your mobile app, webpage, or device. Focus on voice-first experiences using the [Direct Line Speech]({{site.baseurl}}/virtual-assistant/tutorials/enable-speech/1-intro/) channel.
40+
The Virtual Assistant Solution Accelerator leverages Azure Cognitive Services and can be embedded on any [Bot Framework channel](https://docs.microsoft.com/en-us/azure/bot-service/bot-service-manage-channels?view=azure-bot-service-4.0) such as Web Chat, Facebook Messenger, or [Microsoft Teams]({{site.baseurl}}/clients-and-channels/tutorials/enable-teams/1-intro/). You can use the [Direct Line](https://docs.microsoft.com/en-us/azure/bot-service/bot-service-channel-directline?view=azure-bot-service-4.0) channel to integrate a Virtual Assistant into your mobile app, webpage, or device. Focus on voice-first experiences using the [Direct Line Speech]({{site.baseurl}}/clients-and-channels/tutorials/enable-speech/1-intro/) channel.
4141

4242
### Enterprise-grade solutions
4343
{:.no_toc}
@@ -89,7 +89,7 @@ Clients and Channels are the ways that users can interact with the Virtual Assis
8989
Microsoft offers a variety of channels such as Facebook Messenger, Teams, Slack, WeChat, and many others. You can find many details around available channels in the [Bot Framework Channels documentation](https://docs.microsoft.com/en-us/azure/bot-service/bot-service-channels-reference?view=azure-bot-service-4.0).
9090

9191
Sample client applications are implementations of clients that will integrate seamlessly with your Assistant and enable Speech scenarios.
92-
- [Virtual Assistant Client for Android]({site.baseurl}}/clients-and-channels/clients/virtual-assistant-client/)
92+
- [Virtual Assistant Client for Android]({{site.baseurl}}/clients-and-channels/clients/virtual-assistant-client/)
9393
- Virtual Assistant Client for PowerApps *(Coming Soon)*
9494

9595
## Next steps

docs/_docs/overview/virtual-assistant-template.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ To learn more about project structure, see the [Create Project]({{site.baseurl}}
1818

1919
## Azure resource deployment
2020

21-
The comprehensive experience requires the following Azure resources to function properly, detailed [here]({{site.baseurl}}/help/reference/deployment-scripts/).
21+
The comprehensive experience requires the following Azure resources to function properly, detailed [here]({{site.baseurl}}/virtual-assistant/handbook/deployment-scripts/).
2222

2323
Resource | Description |
2424
-------- | ----- |
@@ -105,7 +105,7 @@ Most conversational experiences need to serve users in a variety of languages wh
105105

106106
The Virtual Assistant addresses all of the above capabilities and assists with the deployment considerations for multi-language Dispatch, LUIS, and QNAMaker resources. Localized responses for built-in capabilities are also provided.
107107

108-
To learn more about how multi-locale support is added, see the [localization documentation]({{site.baseurl}}/virtual-assistant/handbook/localization.md).
108+
To learn more about how multi-locale support is added, see the [localization documentation]({{site.baseurl}}/virtual-assistant/handbook/localization/).
109109

110110
### Language generation and responses
111111

@@ -159,7 +159,7 @@ Within **Startup.cs** you can optionally choose to disable use of CosmosDB and s
159159
services.AddSingleton<IStorage>(new CosmosDbStorage(settings.CosmosDb));
160160
```
161161

162-
Deployment can be customized to omit deployment of CosmosDB and is covered in the [deployment documentation]({{site.baseurl}}/help/reference/deploymentscripts.md).
162+
Deployment can be customized to omit deployment of CosmosDB and is covered in the [deployment documentation]({{site.baseurl}}/virtual-assistant/handbook/deployment-scripts/).
163163

164164
## Handling activities
165165
### Activity processing
@@ -239,7 +239,7 @@ The [**Feedback Middleware**]() provides a way to collect feedback leveraging su
239239

240240
By default, the middleware activates at the end of every dialog but you can customize this further to suit your scenario, for example only asking for feedback when LUIS or QnA prediction scores are low or perhaps at random or a limited number of times in a time period.
241241

242-
To learn more about the Feedback capability, see the [Feedback documentation]({{site.baseurl}}/virtual-assistant/handbook/feedback.md).
242+
To learn more about the Feedback capability, see the [Feedback documentation]({{site.baseurl}}/virtual-assistant/handbook/feedback/).
243243

244244

245245
### Interruptions
@@ -301,19 +301,19 @@ The Virtual Assistant has all of the pre-requisites required for a high-quality
301301

302302
### Microsoft Teams
303303

304-
The Virtual Assistant is configured out-of-the-box to integrate with [Microsoft Teams](({{site.baseurl}}/clients-and-channels/tutorials/enable-speech/1-intro/)).
304+
The Virtual Assistant is configured out-of-the-box to integrate with [Microsoft Teams]({{site.baseurl}}/clients-and-channels/tutorials/enable-teams/1-intro/).
305305

306306
## Telemetry
307307

308308
Providing insights into the user engagement of your Bot has proven to be highly valuable. This insight can help you understand the levels of user engagement, what features of the Bot they are using (intents) along with questions people are asking that the Bot isn't able to answer - highlighting gaps in the Bot's knowledge that could be addressed through new QnA Maker articles for instance.
309309

310310
Integration of Application Insights provides significant operational/technical insight out of the box but this can also be used to capture specific Bot related events - messages sent and received along with LUIS and QnA Maker operations. Bot level telemetry is intrinsically linked to technical and operational telemetry enabling you to inspect how a given user question was answered and vice versa.
311311

312-
A middleware component combined with a wrapper class around the QnA Maker and LuisRecognizer SDK classes provides an elegant way to collect a consistent set of events. These consistent events can then be used by the Application Insights tooling along with tools like PowerBI. An example PowerBI dashboard is as part of the Bot Framework Solutions Github repo and works right out of the box with every Virtual Assistant template. See the [Analytics]({{site.baseurl}}/overview/analytics) section for more information.
312+
A middleware component combined with a wrapper class around the QnA Maker and LuisRecognizer SDK classes provides an elegant way to collect a consistent set of events. These consistent events can then be used by the Application Insights tooling along with tools like PowerBI. An example PowerBI dashboard is as part of the Bot Framework Solutions Github repo and works right out of the box with every Virtual Assistant template. See the [Analytics]({{site.baseurl}}/solution-accelerators/tutorials/view-analytics/1-intro/) section for more information.
313313

314314
![Analytics Example]({{site.baseurl}}/assets/images/analytics/virtual-assistant-analytics-powerbi-1.png)
315315

316-
To learn more about Telemetry, see the [Analytics tutorial]({{site.baseurl}}/virtual-assistant/tutorials/view-analytics).
316+
To learn more about Telemetry, see the [Analytics tutorial]({{site.baseurl}}/solution-accelerators/tutorials/view-analytics/1-intro/).
317317

318318

319319
## Testing
@@ -327,5 +327,5 @@ You can find these tests in a companion project to your assistant or [here]({{si
327327

328328
A [Azure DevOps](https://azure.microsoft.com/en-us/solutions/devops/) [YAML](https://docs.microsoft.com/en-us/azure/devops/pipelines/yaml-schema?view=azure-devops&tabs=schema) file for Continuous Integration is included within the `pipeline` folder of your assistant and provides all the steps required to build your assistant project and generate code coverage results. This can be imported into your Azure DevOps environment to create a build.
329329

330-
In addition, documentation to create a [release pipeline]({{site.baseurl}}/howto/virtual-assistant/continuousdeployment/) is also provided enabling you to continuously deploy updates to your project to your Azure test environment and also update Dispatch, LUIS and QnAMaker resources with any changes to the LU files within source control.
330+
In addition, documentation to create a [release pipeline]({{site.baseurl}}/solution-accelerators/tutorials/enable-continuous-deployment/1-intro/) is also provided enabling you to continuously deploy updates to your project to your Azure test environment and also update Dispatch, LUIS and QnAMaker resources with any changes to the LU files within source control.
331331

docs/_docs/skills/handbook/architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ A key design goal for Skills was to maintain the consistent Activity protocol an
2626
### Dispatcher
2727
{:.no_toc}
2828

29-
The Dispatcher plays a central role to enabling a Bot to understand how to best process a given utterance. The Dispatch through use of the [Skill CLI]({{site.baseurl}}/reference/skills/botskills) is updated with triggering utterances for a given Skill and a new Dispatch intent is created for a given Skill. An example of a Dispatch model with a point of interest skill having been added is shown below.
29+
The Dispatcher plays a central role to enabling a Bot to understand how to best process a given utterance. The Dispatch through use of the [Skill CLI]({{site.baseurl}}/skills/handbook/botskills) is updated with triggering utterances for a given Skill and a new Dispatch intent is created for a given Skill. An example of a Dispatch model with a point of interest skill having been added is shown below.
3030

3131
![Dispatch with Skill Example]({{site.baseurl}}/assets/images/skillarchitecturedispatchexample.png)
3232

docs/_docs/skills/handbook/best-practices.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -457,7 +457,7 @@ If you need a more complex prompt you can implement it by inheriting **Microsoft
457457
### Enable long running tasks
458458
{:.no_toc}
459459

460-
[Proactive scenarios]({{site.baseurl}}/howto/virtual-assistant/proactivemessaging) are a key part of ensuring a Skill Assistant can provide more intelligent and helpful capabilities to end users.
460+
[Proactive scenarios]({{site.baseurl}}/solution-accelerators/tutorials/enable-proactive-notifications/1-intro/) are a key part of ensuring a Skill Assistant can provide more intelligent and helpful capabilities to end users.
461461
This enables a Skill to have more intelligent interactions with a user, triggered by external events.
462462

463463
### Handle and log errors

docs/_docs/skills/samples/phone.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ If you plan to use the skill as part of a Virtual Assistant, the process of regi
9999

100100
**However**, if you wish to use the Skill directly without using a Virtual Assistant, please use the following steps to manually configure Authentication for the Phone Skill. This is **not** required when using the Skill with a Virtual Assistant.
101101

102-
Follow the general instructions [here]({{site.baseurl}}/howto/skills/manualauthsteps.md) to configure this using the scopes shown above.
102+
Follow the general instructions [here]({{site.baseurl}}/skills/handbook/authentication/#manual-authentication) to configure this using the scopes shown above.
103103

104104
## Events
105105

docs/_docs/skills/tutorials/add-prebuilt-skill/6-next-steps.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Now that you've connected a pre-built skill to your assitant, try out these othe
2828
<p class="card-text">Enable the Microsoft Speech Channel for your assistant.</p>
2929
</div>
3030
<div class="card-footer" style="display: flex; justify-content: center;">
31-
<a href="{{site.baseurl}}/tutorials/enable-speech/1_intro" class="btn btn-primary">Get Started</a>
31+
<a href="{{site.baseurl}}/clients-and-channels/tutorials/enable-speech/1-intro" class="btn btn-primary">Get Started</a>
3232
</div>
3333
</div>
3434
<div class="card">
@@ -37,7 +37,7 @@ Now that you've connected a pre-built skill to your assitant, try out these othe
3737
<p class="card-text">Enable the Microsoft Teams Channel for your assistant.</p>
3838
</div>
3939
<div class="card-footer" style="display: flex; justify-content: center;">
40-
<a href="{{site.baseurl}}/tutorials/enable-teams/1_intro" class="btn btn-primary">Get Started</a>
40+
<a href="{{site.baseurl}}/clients-and-channels/tutorials/enable-teams/1-intro" class="btn btn-primary">Get Started</a>
4141
</div>
4242
</div>
4343
</div>

docs/_docs/skills/tutorials/create-skill/csharp/8-next-steps.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Now that you've created your skill, try the one of these tutorials:
2424
<div class="btn btn-primary">Get started</div>
2525
</div>
2626
</a>
27-
<a href="{{site.baseurl}}/virtual-assistant/tutorials/enable-speech/1-intro/" class="card">
27+
<a href="{{site.baseurl}}/clients-and-channels/tutorials/enable-speech/1-intro/" class="card">
2828
<div class="card-body">
2929
<img src="{{site.baseurl}}/assets/images/icons/speech.png" alt="Speech icon" width="48px">
3030
<h4 class="card-title">Enable Speech</h4>
@@ -34,7 +34,7 @@ Now that you've created your skill, try the one of these tutorials:
3434
<div class="btn btn-primary">Get started</div>
3535
</div>
3636
</a>
37-
<a href="{{site.baseurl}}/virtual-assistant/tutorials/enable-teams/1-intro/" class="card">
37+
<a href="{{site.baseurl}}/clients-and-channels/tutorials/enable-teams/1-intro/" class="card">
3838
<div class="card-body">
3939
<img src="{{site.baseurl}}/assets/images/icons/teams.png" alt="Microsoft Teams icon" width="48px">
4040
<h4 class="card-title">Extend to Microsoft Teams</h4>

0 commit comments

Comments
 (0)