diff --git a/docs/howto/assistant/customizedeployment.md b/docs/howto/assistant/customizedeployment.md deleted file mode 100644 index a40e996416..0000000000 --- a/docs/howto/assistant/customizedeployment.md +++ /dev/null @@ -1,68 +0,0 @@ -# How To: Customize Deployment - -The Virtual Assistant Template relies on a number of Azure resources to run. The included deployment scripts and ARM template use the following default configurations for these services: - -Resource | Tier | Notes | --------- | ---- | ----- | -Azure Bot Service | S1 | The Azure Bot Service resource stores configuration information that allows your Virtual Assistant to be accessed on the supported Channels and provide OAuth authentication. | -Azure Blob Storage | Standard LRS | Used to store conversation transcripts. -Azure Cosmos DB | Standard | Used to store conversation state. | -Azure App Service Plan | S1 | Used to host your Bot Web App and QnA Maker Web App. | -Azure Application Insights | N/A | Used to capture conversation and application telemetry. [Available regions](https://azure.microsoft.com/en-us/global-infrastructure/services/?products=monitor) -Bot Web App | N/A | Hosts your Bot application. -Language Understanding | S0 | Subscription keys for Language Understanding Cognitive Service. -QnA Maker | S0 | Subscription keys for QnA Maker Cognitive Service. [Available regions](https://azure.microsoft.com/en-us/global-infrastructure/services/?products=cognitive-services) -QnA Maker Web App | N/A | Hosts your QnA Maker knowledgebases. -QnA Maker Azure Search Service | Standard | Search index for your QnA Maker knowledgebases. [Available regions](https://azure.microsoft.com/en-us/global-infrastructure/services/?products=search) -Content Moderator | S0 | Subscription keys for Content Moderator Cognitive Service. - -Any of the following parameters in the ARM template can be overridden with your preferred values using the `parameters.template.json` file provided in the `Deployment\Resources` folder: - -- name -- location -- microsoftAppId -- microsoftAppPassword -- cosmosDbName -- storageAccountName -- appServicePlanName -- appServicePlanSku -- appInsightsName -- appInsightsLocation -- botWebAppName -- botServiceName -- botServiceSku -- contentModeratorName -- contentModeratorSku -- contentModeratorLocation -- luisServiceName -- luisServiceSku -- luisServiceLocation -- qnaMakerServiceName -- qnaMakerServiceSku -- qnaServiceLocation -- qnaMakerSearchName -- qnaMakerSearchSku -- qnaMakerWebAppName - -Simply update the parameters.template.json file with your preferred values, like so: - -```json -{ - "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentParameters.json#", - "contentVersion": "1.0.0.0", - "parameters": { - "appInsightsLocation": { - "value": "westus2" - }, - "qnaMakerSearchSku": { - "value": "basic" - } - } -} -``` - -Then provide the path to the file as an argument on the `deploy.ps1` script: - -``` -.\Deployment\Scripts\deploy.ps1 -parametersFile .\Deployment\Resources\parameters.template.json -``` diff --git a/docs/howto/assistant/updatedeploymentscripts.md b/docs/howto/assistant/updatedeploymentscripts.md deleted file mode 100644 index 3dc8e2a2c1..0000000000 --- a/docs/howto/assistant/updatedeploymentscripts.md +++ /dev/null @@ -1,30 +0,0 @@ -# How To: Update deployment scripts - -Once you have created your Virtual Assistant or Skill projects using the various templates and generators, you may need to update the deployment scripts to reflect ongoing changes to these scripts over time. - -## Sample Project - -For each of the template types we provide a sample project which is generated by the most recent template. This enables you to easily retrieve changes such as the deployment scripts. Alternatively you can clone the repro and use this sample project as your starting point. - -See the table below for a direct link to the appropriate sample project for your scenario: - -Name | Language | Sample Project Location | Deployment Scripts Folder | --------- | ---- | ----- | ----- -Virtual Assistant | csharp | [Sample Project Location](https://github.com/microsoft/botframework-solutions/tree/master/templates/Virtual-Assistant-Template/csharp/Sample) | [Deployment Scripts](https://github.com/microsoft/botframework-solutions/tree/master/templates/Virtual-Assistant-Template/csharp/Sample/VirtualAssistantSample/Deployment) -Virtual Assistant | typescript | [Sample Project Location](https://github.com/microsoft/botframework-solutions/tree/master/templates/Virtual-Assistant-Template/typescript/samples/sample-assistant) | [Deployment Scripts](https://github.com/microsoft/botframework-solutions/tree/master/templates/Virtual-Assistant-Template/typescript/samples/sample-assistant/deployment) -Skill Template | csharp | [Sample Project Location](https://github.com/microsoft/botframework-solutions/tree/master/templates/Skill-Template/csharp/Sample) | [Deployment Scripts](https://github.com/microsoft/botframework-solutions/tree/master/templates/Skill-Template/csharp/Sample/SkillSample/Deployment) -Skill Template | typescript | [Sample Project Location](https://github.com/microsoft/botframework-solutions/tree/master/templates/Virtual-Assistant-Template/typescript/samples/sample-skill) | [Deployment Scripts](https://github.com/microsoft/botframework-solutions/tree/master/templates/Virtual-Assistant-Template/typescript/samples/sample-skill/deployment) - -## Updating your deployment scripts - -GitHub doesn't provide the ability to download folders or files interactively in the Web Browser. You must therefore clone the [Bot Framework Solutions repo](https://github.com/microsoft/botframework-solutions) onto your machine. - -1. Clone the repo locally onto your machine -2. Browse to the appropriate deployment scripts folder using the table above as a reference to the location -3. Copy the entire contents of the `Deployment` folder (resources and script subdirectories) over the files in the `Deployment` folder of your Assistant or Skill project. - -You now have the latest scripts for Assistant/Skill deployment and updating of cognitive models. - -## Skills - -Skills are part of the above GitHub repo so any changes to the deployment scripts will be reflected automatically when you pull the latest changes. diff --git a/docs/readme.md b/docs/readme.md index 513eace12a..1e3ba21bdf 100644 --- a/docs/readme.md +++ b/docs/readme.md @@ -50,8 +50,6 @@ | How-To: Migrate from the Enterprise Template

[![Migrating from the Enterprise Template with C#](./media/csharp_icon.png)](/docs/howto/assistant/csharp/ettovamigration.md)

| Guidance on how to move from an Enterprise Template based Bot to the new Template | | How-to: Migrate the Virtual Assistant (Beta Release 0.3) solution to the Virtual Assistant Template

[![Migrating from the beta Virtual Assistant solution with C#](./media/csharp_icon.png)](/docs/howto/assistant/csharp/oldvatovamigration.md)

|Guidance on how to move from the original Virtual Assistant solution to the new Template | | [How-To: Send activities from your assistant to users proactively](/docs/howto/assistant/csharp/proactivemessaging.md) | Adding proactive experiences to your Assistant | -| [How-To: Customize Azure Resource Deployment](/docs/howto/assistant/customizedeployment.md) | How to customise the provided ARM template for different deployment scenarios. | -| [How-To: Update your deployment scripts to the latest version.](/docs/howto/assistant/updatedeploymentscripts.md) | How to update the deployment scripts for Virtal Assistant and Skill projects that you have already created to ensure you have the latest updates. | ## Skills @@ -75,7 +73,7 @@ |[Architecture](/docs/reference/assistant/underthecovers.md)|Detailed documentation covering what the template provides and how it works| |[Generating bot responses](/docs/reference/assistant/responses.md)|Your Virtual Assistant can respond in a variety of ways, depending on the scenario and the user's active device or conversation canvas| |[Managing backend client events](/docs/reference/assistant/events.md)|Events enable custom apps or device experiences to pass device or contextual user information to an Assistant behind the scenes.| -|[Deployment scripts](/docs/reference/assistant/deploymentscripts.md) | Reference for deployment scripts provided in the Virtual Assistant Template | +|[Deployment](/docs/reference/assistant/deploymentscripts.md) | Reference for deployment provided in the Virtual Assistant Template | ## Skills diff --git a/docs/reference/assistant/deploymentscripts.md b/docs/reference/assistant/deploymentscripts.md index 5e0d341b33..ddc22eebe8 100644 --- a/docs/reference/assistant/deploymentscripts.md +++ b/docs/reference/assistant/deploymentscripts.md @@ -14,6 +14,7 @@ - [How do I customize my Azure resource deployment?](#how-do-i-customize-my-azure-resource-deployment) - [How do I use my existing Azure resources from the same resource group?](#how-do-i-use-my-existing-azure-resources-from-the-same-resource-group) - [How do I use my existing Azure resources from a different resource group?](#how-do-i-use-my-existing-azure-resources-from-a-different-resource-group) + - [How do I update my local deployment scripts with the latest?](#how-do-i-update-my-local-deployment-scripts-with-the-latest) ## Intro @@ -216,3 +217,34 @@ If you want to use an existing resource from a different resource group, follow #### Other services 1. Remove the resource from the `resources` array in `template.json`. 2. Provide the appropriate configuration in `appsettings.json` from the [Azure Portal](https://portal.azure.com). + +### How do I update my local deployment scripts with the latest? + +Once you have created your Virtual Assistant or Skill projects using the various templates and generators, you may need to update the deployment scripts to reflect ongoing changes to these scripts over time. + +#### Sample Project + +For each of the template types we provide a sample project which is generated by the most recent template. This enables you to easily retrieve changes such as the deployment scripts. Alternatively you can clone the repro and use this sample project as your starting point. + +See the table below for a direct link to the appropriate sample project for your scenario: + +Name | Language | Sample Project Location | Deployment Scripts Folder | +-------- | ---- | ----- | ----- +Virtual Assistant | csharp | [Sample Project Location](https://github.com/microsoft/botframework-solutions/tree/master/templates/Virtual-Assistant-Template/csharp/Sample) | [Deployment Scripts](https://github.com/microsoft/botframework-solutions/tree/master/templates/Virtual-Assistant-Template/csharp/Sample/VirtualAssistantSample/Deployment) +Virtual Assistant | typescript | [Sample Project Location](https://github.com/microsoft/botframework-solutions/tree/master/templates/Virtual-Assistant-Template/typescript/samples/sample-assistant) | [Deployment Scripts](https://github.com/microsoft/botframework-solutions/tree/master/templates/Virtual-Assistant-Template/typescript/samples/sample-assistant/deployment) +Skill Template | csharp | [Sample Project Location](https://github.com/microsoft/botframework-solutions/tree/master/templates/Skill-Template/csharp/Sample) | [Deployment Scripts](https://github.com/microsoft/botframework-solutions/tree/master/templates/Skill-Template/csharp/Sample/SkillSample/Deployment) +Skill Template | typescript | [Sample Project Location](https://github.com/microsoft/botframework-solutions/tree/master/templates/Virtual-Assistant-Template/typescript/samples/sample-skill) | [Deployment Scripts](https://github.com/microsoft/botframework-solutions/tree/master/templates/Virtual-Assistant-Template/typescript/samples/sample-skill/deployment) + +#### Updating your deployment scripts + +GitHub doesn't provide the ability to download folders or files interactively in the Web Browser. You must therefore clone the [Bot Framework Solutions repo](https://github.com/microsoft/botframework-solutions) onto your machine. + +1. Clone the repo locally onto your machine +2. Browse to the appropriate deployment scripts folder using the table above as a reference to the location +3. Copy the entire contents of the `Deployment` folder (resources and script subdirectories) over the files in the `Deployment` folder of your Assistant or Skill project. + +You now have the latest scripts for Assistant/Skill deployment and updating of cognitive models. + +#### Skills + +Skills are part of the above GitHub repo so any changes to the deployment scripts will be reflected automatically when you pull the latest changes.