Skip to content

Commit

Permalink
chore(docs): Update Template Readme with Preview Command Instructions (…
Browse files Browse the repository at this point in the history 
…#1994)

Co-authored-by: Junjie Li <junjieli@LIN46000450.fareast.corp.microsoft.com>
  • Loading branch information
@MuyangAmigo
MuyangAmigo and Junjie Li authored Aug 24, 2021
1 parent 5289737 commit daf6fda
Show file tree
Hide file tree
Showing 10 changed files with 80 additions and 51 deletions.
13 changes: 8 additions & 5 deletions templates/bot-msgext/js/default/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ This is a simple hello world application with both Bot and Message extension cap
## Debug

Start debugging the project by hitting the `F5` key in Visual Studio Code. Alternatively use the `Run and Debug Activity Panel` in Visual Studio Code and click the `Start Debugging` green arrow button.
- From Visual Studio Code: Start debugging the project by hitting the `F5` key in Visual Studio Code. Alternatively use the `Run and Debug Activity Panel` in Visual Studio Code and click the `Start Debugging` green arrow button.
- From TeamsFx CLI: Start debugging the project by executing the command `teamsfx preview --local` in your project directory.

## Edit the manifest

Expand All @@ -32,7 +33,7 @@ You can find the Teams manifest in `.fx/manifest.source.json`. It contains templ

Deploy your project to Azure by following these steps:

| From Visual Studio Code | Using TeamsFx CLI |
| From Visual Studio Code | From TeamsFx CLI |
| :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <ul><li>Open Teams Toolkit, and sign into Azure by clicking the `Sign in to Azure` under the `ACCOUNTS` section from sidebar.</li> <li>After you signed in, select a subscription under your account.</li><li>Open the command palette and select: `Teams: Provision in the Cloud`.</li><li>Open the command palette and select: `Teams: Deploy to the Cloud`.</li></ul> | <ul> <li>Run command `teamsfx account login azure`.</li> <li>Run command `teamsfx account set --subscription <your-subscription-id>`.</li> <li> Run command `teamsfx provision`.</li> <li>Run command: `teamsfx deploy`. </li></ul> |

Expand All @@ -41,10 +42,12 @@ Deploy your project to Azure by following these steps:
## Preview

Once the provisioning and deployment steps are finished, you can preview your app:
- From Visual Studio Code
1. Open the `Run and Debug Activity Panel`.
1. Select `Launch Remote (Edge)` or `Launch Remote (Chrome)` from the launch configuration drop-down.
1. Press the Play (green arrow) button to launch your app - now running remotely from Azure.

1. From Visual Studio Code, open the `Run and Debug Activity Panel`.
1. Select `Launch Remote (Edge)` or `Launch Remote (Chrome)` from the launch configuration drop-down.
1. Press the Play (green arrow) button to launch your app - now running remotely from Azure.
- From TeamsFx CLI: execute `teamsfx preview --remote` in your project directory to launch your application.

## Validate manifest file

Expand Down
13 changes: 8 additions & 5 deletions templates/bot-msgext/ts/default/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ This is a simple hello world application with both Bot and Message extension cap
## Debug

Start debugging the project by hitting the `F5` key in Visual Studio Code. Alternatively use the `Run and Debug Activity Panel` in Visual Studio Code and click the `Start Debugging` green arrow button.
- From Visual Studio Code: Start debugging the project by hitting the `F5` key in Visual Studio Code. Alternatively use the `Run and Debug Activity Panel` in Visual Studio Code and click the `Start Debugging` green arrow button.
- From TeamsFx CLI: Start debugging the project by executing the command `teamsfx preview --local` in your project directory.

## Edit the manifest

Expand All @@ -32,7 +33,7 @@ You can find the Teams manifest in `.fx/manifest.source.json`. It contains templ

Deploy your project to Azure by following these steps:

| From Visual Studio Code | Using TeamsFx CLI |
| From Visual Studio Code | From TeamsFx CLI |
| :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <ul><li>Open Teams Toolkit, and sign into Azure by clicking the `Sign in to Azure` under the `ACCOUNTS` section from sidebar.</li> <li>After you signed in, select a subscription under your account.</li><li>Open the command palette and select: `Teams: Provision in the Cloud`.</li><li>Open the command palette and select: `Teams: Deploy to the Cloud`.</li></ul> | <ul> <li>Run command `teamsfx account login azure`.</li> <li>Run command `teamsfx account set --subscription <your-subscription-id>`.</li> <li> Run command `teamsfx provision`.</li> <li>Run command: `teamsfx deploy`. </li></ul> |

Expand All @@ -41,10 +42,12 @@ Deploy your project to Azure by following these steps:
## Preview

Once the provisioning and deployment steps are finished, you can preview your app:
- From Visual Studio Code
1. Open the `Run and Debug Activity Panel`.
1. Select `Launch Remote (Edge)` or `Launch Remote (Chrome)` from the launch configuration drop-down.
1. Press the Play (green arrow) button to launch your app - now running remotely from Azure.

1. From Visual Studio Code, open the `Run and Debug Activity Panel`.
1. Select `Launch Remote (Edge)` or `Launch Remote (Chrome)` from the launch configuration drop-down.
1. Press the Play (green arrow) button to launch your app - now running remotely from Azure.
- From TeamsFx CLI: execute `teamsfx preview --remote` in your project directory to launch your application.

## Validate manifest file

Expand Down
13 changes: 8 additions & 5 deletions templates/bot/js/default/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ This is a sample chatbot application demonstrating Single Sign-on using `botbuil
## Debug

Start debugging the project by hitting the `F5` key in Visual Studio Code. Alternatively use the `Run and Debug Activity Panel` in Visual Studio Code and click the `Start Debugging` green arrow button.
- From Visual Studio Code: Start debugging the project by hitting the `F5` key in Visual Studio Code. Alternatively use the `Run and Debug Activity Panel` in Visual Studio Code and click the `Start Debugging` green arrow button.
- From TeamsFx CLI: Start debugging the project by executing the command `teamsfx preview --local` in your project directory.

## Edit the manifest

Expand All @@ -28,7 +29,7 @@ You can find the Teams manifest in `.fx/manifest.source.json`. It contains templ

Deploy your project to Azure by following these steps:

| From Visual Studio Code | Using TeamsFx CLI |
| From Visual Studio Code | From TeamsFx CLI |
| :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <ul><li>Open Teams Toolkit, and sign into Azure by clicking the `Sign in to Azure` under the `ACCOUNTS` section from sidebar.</li> <li>After you signed in, select a subscription under your account.</li><li>Open the command palette and select: `Teams: Provision in the Cloud`.</li><li>Open the command palette and select: `Teams: Deploy to the Cloud`.</li></ul> | <ul> <li>Run command `teamsfx account login azure`.</li> <li>Run command `teamsfx account set --subscription <your-subscription-id>`.</li> <li> Run command `teamsfx provision`.</li> <li>Run command: `teamsfx deploy`. </li></ul> |

Expand All @@ -37,10 +38,12 @@ Deploy your project to Azure by following these steps:
## Preview

Once the provisioning and deployment steps are finished, you can preview your app:
- From Visual Studio Code
1. Open the `Run and Debug Activity Panel`.
1. Select `Launch Remote (Edge)` or `Launch Remote (Chrome)` from the launch configuration drop-down.
1. Press the Play (green arrow) button to launch your app - now running remotely from Azure.

1. From Visual Studio Code, open the `Run and Debug Activity Panel`.
1. Select `Launch Remote (Edge)` or `Launch Remote (Chrome)` from the launch configuration drop-down.
1. Press the Play (green arrow) button to launch your app - now running remotely from Azure.
- From TeamsFx CLI: execute `teamsfx preview --remote` in your project directory to launch your application.

## Validate manifest file

Expand Down
13 changes: 8 additions & 5 deletions templates/bot/ts/default/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@ This is a sample chatbot application demonstrating Single Sign-on using `botbuil
## Debug

Start debugging the project by hitting the `F5` key in Visual Studio Code. Alternatively use the `Run and Debug Activity Panel` in Visual Studio Code and click the `Start Debugging` green arrow button.
- From Visual Studio Code: Start debugging the project by hitting the `F5` key in Visual Studio Code. Alternatively use the `Run and Debug Activity Panel` in Visual Studio Code and click the `Start Debugging` green arrow button.
- From TeamsFx CLI: Start debugging the project by executing the command `teamsfx preview --local` in your project directory.

## Edit the manifest

Expand All @@ -28,7 +29,7 @@ You can find the Teams manifest in `.fx/manifest.source.json`. It contains templ

Deploy your project to Azure by following these steps:

| From Visual Studio Code | Using TeamsFx CLI |
| From Visual Studio Code | From TeamsFx CLI |
| :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <ul><li>Open Teams Toolkit, and sign into Azure by clicking the `Sign in to Azure` under the `ACCOUNTS` section from sidebar.</li> <li>After you signed in, select a subscription under your account.</li><li>Open the command palette and select: `Teams: Provision in the Cloud`.</li><li>Open the command palette and select: `Teams: Deploy to the Cloud`.</li></ul> | <ul> <li>Run command `teamsfx account login azure`.</li> <li>Run command `teamsfx account set --subscription <your-subscription-id>`.</li> <li> Run command `teamsfx provision`.</li> <li>Run command: `teamsfx deploy`. </li></ul> |

Expand All @@ -37,10 +38,12 @@ Deploy your project to Azure by following these steps:
## Preview

Once the provisioning and deployment steps are finished, you can preview your app:
- From Visual Studio Code
1. Open the `Run and Debug Activity Panel`.
1. Select `Launch Remote (Edge)` or `Launch Remote (Chrome)` from the launch configuration drop-down.
1. Press the Play (green arrow) button to launch your app - now running remotely from Azure.

1. From Visual Studio Code, open the `Run and Debug Activity Panel`.
1. Select `Launch Remote (Edge)` or `Launch Remote (Chrome)` from the launch configuration drop-down.
1. Press the Play (green arrow) button to launch your app - now running remotely from Azure.
- From TeamsFx CLI: execute `teamsfx preview --remote` in your project directory to launch your application.

## Validate manifest file

Expand Down
Loading

0 comments on commit daf6fda

Please sign in to comment.