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

Commit 11efb39

Browse files
authored
consolidated deployment docs (#2018)
1 parent 04ecbe5 commit 11efb39

File tree

4 files changed

+33
-101
lines changed

4 files changed

+33
-101
lines changed

docs/howto/assistant/customizedeployment.md

Lines changed: 0 additions & 68 deletions
This file was deleted.

docs/howto/assistant/updatedeploymentscripts.md

Lines changed: 0 additions & 30 deletions
This file was deleted.

docs/readme.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,6 @@
5050
| How-To: Migrate from the Enterprise Template <br/><br/><p align="center">[![Migrating from the Enterprise Template with C#](./media/csharp_icon.png)](/docs/howto/assistant/csharp/ettovamigration.md)</p> | Guidance on how to move from an Enterprise Template based Bot to the new Template |
5151
| How-to: Migrate the Virtual Assistant (Beta Release 0.3) solution to the Virtual Assistant Template <br/><br/> <p align="center">[![Migrating from the beta Virtual Assistant solution with C#](./media/csharp_icon.png)](/docs/howto/assistant/csharp/oldvatovamigration.md)</p> |Guidance on how to move from the original Virtual Assistant solution to the new Template |
5252
| [How-To: Send activities from your assistant to users proactively](/docs/howto/assistant/csharp/proactivemessaging.md) | Adding proactive experiences to your Assistant |
53-
| [How-To: Customize Azure Resource Deployment](/docs/howto/assistant/customizedeployment.md) | How to customise the provided ARM template for different deployment scenarios. |
54-
| [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. |
5553

5654

5755
## Skills
@@ -75,7 +73,7 @@
7573
|[Architecture](/docs/reference/assistant/underthecovers.md)|Detailed documentation covering what the template provides and how it works|
7674
|[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|
7775
|[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.|
78-
|[Deployment scripts](/docs/reference/assistant/deploymentscripts.md) | Reference for deployment scripts provided in the Virtual Assistant Template |
76+
|[Deployment](/docs/reference/assistant/deploymentscripts.md) | Reference for deployment provided in the Virtual Assistant Template |
7977

8078
## Skills
8179

docs/reference/assistant/deploymentscripts.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@
1414
- [How do I customize my Azure resource deployment?](#how-do-i-customize-my-azure-resource-deployment)
1515
- [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)
1616
- [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)
17+
- [How do I update my local deployment scripts with the latest?](#how-do-i-update-my-local-deployment-scripts-with-the-latest)
1718

1819
## Intro
1920

@@ -216,3 +217,34 @@ If you want to use an existing resource from a different resource group, follow
216217
#### Other services
217218
1. Remove the resource from the `resources` array in `template.json`.
218219
2. Provide the appropriate configuration in `appsettings.json` from the [Azure Portal](https://portal.azure.com).
220+
221+
### How do I update my local deployment scripts with the latest?
222+
223+
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.
224+
225+
#### Sample Project
226+
227+
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.
228+
229+
See the table below for a direct link to the appropriate sample project for your scenario:
230+
231+
Name | Language | Sample Project Location | Deployment Scripts Folder |
232+
-------- | ---- | ----- | -----
233+
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)
234+
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)
235+
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)
236+
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)
237+
238+
#### Updating your deployment scripts
239+
240+
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.
241+
242+
1. Clone the repo locally onto your machine
243+
2. Browse to the appropriate deployment scripts folder using the table above as a reference to the location
244+
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.
245+
246+
You now have the latest scripts for Assistant/Skill deployment and updating of cognitive models.
247+
248+
#### Skills
249+
250+
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.

0 commit comments

Comments
 (0)