Skip to content

Commit

Permalink
[repo] docs: Update wording in the sample readmes for clarity (#2225)
Browse files Browse the repository at this point in the history
## Linked issues

closes: #minor

## Details

I updated the wording in the samples so verifying login and running TTK
is more clear.

Co-authored-by: Corina Gum <>
  • Loading branch information
corinagum authored Dec 9, 2024
1 parent 0f7591e commit d3356b6
Show file tree
Hide file tree
Showing 41 changed files with 531 additions and 441 deletions.
14 changes: 7 additions & 7 deletions js/samples/01.getting-started/a.echoBot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ This sample shows how to incorporate a basic conversational flow into a Microsof

<!-- code_chunk_output -->

- [Teams Echo Bot](#teams-echo-bot)
- [Interacting with the bot](#interacting-with-the-bot)
- [Setting up the sample](#setting-up-the-sample)
- [Testing the sample](#testing-the-sample)
- [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code)
- [Using Teams App test tool](#using-teams-app-test-tool)
- [Teams Echo Bot](#teams-echo-bot)
- [Interacting with the bot](#interacting-with-the-bot)
- [Setting up the sample](#setting-up-the-sample)
- [Testing the sample](#testing-the-sample)
- [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code)
- [Using Teams App test tool](#using-teams-app-test-tool)

<!-- /code_chunk_output -->

Expand Down Expand Up @@ -77,7 +77,7 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual
1. Copy this sample into a new folder outside of teams-ai
1. Select **File > Open Folder** in VS Code and choose this sample's directory
1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps.
1. Ensure that you have set up the sample from the previous step.
1. Verify that the Teams Toolkit extension is connected to your Teams account from the above step.
1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client.
1. In the browser that launches, select the **Add** button to install the app to Teams..
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,17 @@ This sample shows how to incorporate a basic Message Extension app into a Micros
<!-- code_chunk_output -->

- [Teams Search Command Message Extension](#teams-search-command-message-extension)
- [Interacting with the message extension](#interacting-with-the-message-extension)
- [Setting up the sample](#setting-up-the-sample)
- [Testing the sample](#testing-the-sample)
- [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code)
- [Interacting with the message extension](#interacting-with-the-message-extension)
- [Setting up the sample](#setting-up-the-sample)
- [Testing the sample](#testing-the-sample)
- [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code)

<!-- /code_chunk_output -->

## Interacting with the message extension

- Message Extensions are convenient ways to add functionality to Teams.
- This sample adds a search command to the compose area of a chat.
- Message Extensions are convenient ways to add functionality to Teams.
- This sample adds a search command to the compose area of a chat.

> Note: this is not a chat bot and therefore the bot does not respond if you talk to it. Once it is installed in Teams, you can interact with it by selecting it's app icon in the chat compose area.
Expand Down Expand Up @@ -79,7 +79,7 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual
1. Copy this sample into a new folder outside of teams-ai
1. Select File > Open Folder in VS Code and choose this sample's directory
1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps
1. Ensure that you have set up the sample from the previous step.
1. Verify that the Teams Toolkit extension is connected to your Teams account from the above step.
1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client.
1. In the browser that launches, select the **Add** button to install the app to Teams.
Expand Down
22 changes: 11 additions & 11 deletions js/samples/02.teams-features/b.adaptiveCards.typeAheadBot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,20 @@ This sample shows how to incorporate Adaptive Cards into a Microsoft Teams appli

<!-- code_chunk_output -->

- [Type-Ahead Search](#type-ahead-search)
- [Interacting with the bot](#interacting-with-the-bot)
- [Setting up the sample](#setting-up-the-sample)
- [Testing the sample](#testing-the-sample)
- [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code)
- [Using Teams App test tool](#using-teams-app-test-tool)
- [Type-Ahead Search](#type-ahead-search)
- [Interacting with the bot](#interacting-with-the-bot)
- [Setting up the sample](#setting-up-the-sample)
- [Testing the sample](#testing-the-sample)
- [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code)
- [Using Teams App test tool](#using-teams-app-test-tool)

<!-- /code_chunk_output -->

## Interacting with the bot

- You can interact by sending 'dynamic' or 'static' to the app. The app will respond with an Adaptive Card.
- Typing into the search box will filter the list of options. Selecting an option and submitting will send a message to the bot with the selected option(s).
- The Adaptive Cards used are `json` files located under `/src/cards`. You can use the Teams developer portal to design and host your Adaptive Cards.
- You can interact by sending 'dynamic' or 'static' to the app. The app will respond with an Adaptive Card.
- Typing into the search box will filter the list of options. Selecting an option and submitting will send a message to the bot with the selected option(s).
- The Adaptive Cards used are `json` files located under `/src/cards`. You can use the Teams developer portal to design and host your Adaptive Cards.

## Setting up the sample

Expand Down Expand Up @@ -77,7 +77,7 @@ The simplest way to run this sample in Teams is to use Teams Toolkit for Visual
1. Copy this sample into a new folder outside of teams-ai
1. Select File > Open Folder in VS Code and choose this sample's directory
1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps
1. Ensure that you have set up the sample from the previous step.
1. Verify that the Teams Toolkit extension is connected to your Teams account from the above step.
1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client.
1. In the browser that launches, select the **Add** button to install the app to Teams.

Expand All @@ -93,4 +93,4 @@ Use **Teams App test tool** (integrated into teams Toolkit) to run this sample.
1. Select File > Open Folder in VS Code and choose this sample's directory
1. From the left pane, select **Run and Debug**(Ctrl+Shift+D) and select **Debug in Test Tool** in dropdown list.
1. Select Debug > Start Debugging or F5 to run the app.
1. The browser will pop up to open Teams App Test Tool.
1. The browser will pop up to open Teams App Test Tool.
24 changes: 12 additions & 12 deletions js/samples/03.ai-concepts/a.twentyQuestions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,10 @@ Welcome to the 20 Questions Bot: The Ultimate Guessing Game! This developer samp
<!-- code_chunk_output -->

- [AI in Microsoft Teams: Twenty Questions](#ai-in-microsoft-teams-twenty-questions)
- [Setting up the sample](#setting-up-the-sample)
- [Testing the sample](#testing-the-sample)
- [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code)
- [Using Teams App test tool](#using-teams-app-test-tool)
- [Setting up the sample](#setting-up-the-sample)
- [Testing the sample](#testing-the-sample)
- [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code)
- [Using Teams App test tool](#using-teams-app-test-tool)

<!-- /code_chunk_output -->

Expand Down Expand Up @@ -58,7 +58,6 @@ Welcome to the 20 Questions Bot: The Ultimate Guessing Game! This developer samp
1. If developing without Teams Toolkit, add your OpenAI or Azure OpenAI key to the `OPENAI_KEY` or `AZURE_OPENAI_KEY` and `AZURE_OPENAI_ENDPOINT` variable(s) in `.env` file, which you can copy from `sample.env`. If using TTK, continue following the directions below.
## Testing the sample
The easiest and fastest way to get up and running is with Teams Toolkit as your development guide.
Expand Down Expand Up @@ -106,7 +105,7 @@ If you are using Azure OpenAI then follow these steps:
1. Copy this sample into a new folder outside of teams-ai
1. Select File > Open Folder in VS Code and choose this sample's directory
1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps
1. Ensure that you have set up the sample from the previous step.
1. Verify that the Teams Toolkit extension is connected to your Teams account from the above step.
1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client.
1. In the browser that launches, select the **Add** button to install the app to Teams.

Expand All @@ -123,13 +122,14 @@ If you are using Azure OpenAI then follow these steps:
```yml
- uses: file/createOrUpdateEnvironmentFile
with:
target: ./.localConfigs.testTool
envs:
TEAMSFX_NOTIFICATION_STORE_FILENAME: ${{TEAMSFX_NOTIFICATION_STORE_FILENAME}}
# OPENAI_KEY: ${{SECRET_OPENAI_KEY}}
AZURE_OPENAI_KEY: ${{SECRET_AZURE_OPENAI_KEY}}
AZURE_OPENAI_ENDPOINT: ${{SECRET_AZURE_OPENAI_ENDPOINT}}
target: ./.localConfigs.testTool
envs:
TEAMSFX_NOTIFICATION_STORE_FILENAME: ${{TEAMSFX_NOTIFICATION_STORE_FILENAME}}
# OPENAI_KEY: ${{SECRET_OPENAI_KEY}}
AZURE_OPENAI_KEY: ${{SECRET_AZURE_OPENAI_KEY}}
AZURE_OPENAI_ENDPOINT: ${{SECRET_AZURE_OPENAI_ENDPOINT}}
```

1. Ensure you have downloaded and installed [Visual Studio Code](https://code.visualstudio.com/docs/setup/setup-overview)
1. Install the [Teams Toolkit extension](https://marketplace.visualstudio.com/items?itemName=TeamsDevApp.ms-teams-vscode-extension)
1. Copy this sample into a new folder outside of teams-ai
Expand Down
22 changes: 11 additions & 11 deletions js/samples/03.ai-concepts/b.AI-messageExtensions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@ This sample is a message extension (ME) for Microsoft Teams that leverages the g

<!-- code_chunk_output -->

- [AI in Microsoft Teams Message Extensions: GPT-ME](#ai-in-microsoft-teams-message-extensions-gpt-me)
- [Summary](#summary)
- [Setting up the sample](#setting-up-the-sample)
- [Testing the sample](#testing-the-sample)
- [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code)
- [AI in Microsoft Teams Message Extensions: GPT-ME](#ai-in-microsoft-teams-message-extensions-gpt-me)
- [Summary](#summary)
- [Setting up the sample](#setting-up-the-sample)
- [Testing the sample](#testing-the-sample)
- [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code)

<!-- /code_chunk_output -->

Expand Down Expand Up @@ -76,9 +76,9 @@ To use Teams Toolkit, continue following the directions below.

If you are using Azure OpenAI then follow these steps:

- Comment the `SECRET_OPENAI_KEY` variable in the `./env/.env.local.user` file.
- Add your Azure OpenAI key and endpoint values to the `SECRET_AZURE_OPENAI_KEY` and `SECRET_AZURE_OPENAI_ENDPOINT` variables
- Open the `teamsapp.local.yml` file and modify the last step to use Azure OpenAI variables instead:
- Comment the `SECRET_OPENAI_KEY` variable in the `./env/.env.local.user` file.
- Add your Azure OpenAI key and endpoint values to the `SECRET_AZURE_OPENAI_KEY` and `SECRET_AZURE_OPENAI_ENDPOINT` variables
- Open the `teamsapp.local.yml` file and modify the last step to use Azure OpenAI variables instead:

```yml
- uses: file/createOrUpdateEnvironmentFile
Expand All @@ -92,8 +92,8 @@ If you are using Azure OpenAI then follow these steps:
AZURE_OPENAI_ENDPOINT: ${{SECRET_AZURE_OPENAI_ENDPOINT}}
```

- Open `./infra/azure.bicep` and comment out lines 72-75 and uncomment lines 76-83.
- Open `./infra/azure.parameters.json` and replace lines 20-22 with:
- Open `./infra/azure.bicep` and comment out lines 72-75 and uncomment lines 76-83.
- Open `./infra/azure.parameters.json` and replace lines 20-22 with:

```json
"azureOpenAIKey": {
Expand All @@ -109,7 +109,7 @@ If you are using Azure OpenAI then follow these steps:
1. Copy this sample into a new folder outside of teams-ai
1. Select File > Open Folder in VS Code and choose this sample's directory
1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps
1. Ensure that you have set up the sample from the previous step.
1. Verify that the Teams Toolkit extension is connected to your Teams account from the above step.
1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client.
1. In the browser that launches, select the **Add** button to install the app to Teams.
Expand Down
39 changes: 20 additions & 19 deletions js/samples/03.ai-concepts/c.actionMapping-lightBot/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ LightBot: Your Enlightened Assistant. This example showcases how the LightBot un

<!-- code_chunk_output -->

- [AI in Microsoft Teams: Light Bot](#ai-in-microsoft-teams-light-bot)
- [Interacting with the bot](#interacting-with-the-bot)
- [Setting up the sample](#setting-up-the-sample)
- [Testing the sample](#testing-the-sample)
- [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code)
- [Using Teams App Test Tool](#using-teams-app-test-tool)
- [AI in Microsoft Teams: Light Bot](#ai-in-microsoft-teams-light-bot)
- [Interacting with the bot](#interacting-with-the-bot)
- [Setting up the sample](#setting-up-the-sample)
- [Testing the sample](#testing-the-sample)
- [Using Teams Toolkit for Visual Studio Code](#using-teams-toolkit-for-visual-studio-code)
- [Using Teams App Test Tool](#using-teams-app-test-tool)

<!-- /code_chunk_output -->

Expand Down Expand Up @@ -81,9 +81,9 @@ To use Teams Toolkit, continue following the directions below.

If you are using Azure OpenAI then follow these steps:

- Comment the `SECRET_OPENAI_KEY` variable in the `./env/.env.local.user` file.
- Add your Azure OpenAI key and endpoint values to the `SECRET_AZURE_OPENAI_KEY` and `SECRET_AZURE_OPENAI_ENDPOINT` variables
- Open the `teamsapp.local.yml` file and modify the last step to use Azure OpenAI variables instead:
- Comment the `SECRET_OPENAI_KEY` variable in the `./env/.env.local.user` file.
- Add your Azure OpenAI key and endpoint values to the `SECRET_AZURE_OPENAI_KEY` and `SECRET_AZURE_OPENAI_ENDPOINT` variables
- Open the `teamsapp.local.yml` file and modify the last step to use Azure OpenAI variables instead:

```yml
- uses: file/createOrUpdateEnvironmentFile
Expand All @@ -97,8 +97,8 @@ If you are using Azure OpenAI then follow these steps:
AZURE_OPENAI_ENDPOINT: ${{SECRET_AZURE_OPENAI_ENDPOINT}}
```

- Open `./infra/azure.bicep` and comment out lines 72-75 and uncomment lines 76-83.
- Open `./infra/azure.parameters.json` and replace lines 20-22 with:
- Open `./infra/azure.bicep` and comment out lines 72-75 and uncomment lines 76-83.
- Open `./infra/azure.parameters.json` and replace lines 20-22 with:

```json
"azureOpenAIKey": {
Expand All @@ -114,7 +114,7 @@ If you are using Azure OpenAI then follow these steps:
1. Copy this sample into a new folder outside of teams-ai
1. Select File > Open Folder in VS Code and choose this sample's directory
1. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps
1. Ensure that you have set up the sample from the previous step.
1. Verify that the Teams Toolkit extension is connected to your Teams account from the above step.
1. Select **Debug > Start Debugging** or **F5** to run the app in a Teams web client.
1. In the browser that launches, select the **Add** button to install the app to Teams.
Expand All @@ -131,17 +131,18 @@ If you are using Azure OpenAI then follow these steps:
```yml
- uses: file/createOrUpdateEnvironmentFile
with:
target: ./.localConfigs.testTool
envs:
TEAMSFX_NOTIFICATION_STORE_FILENAME: ${{TEAMSFX_NOTIFICATION_STORE_FILENAME}}
# OPENAI_KEY: ${{SECRET_OPENAI_KEY}}
AZURE_OPENAI_KEY: ${{SECRET_AZURE_OPENAI_KEY}}
AZURE_OPENAI_ENDPOINT: ${{SECRET_AZURE_OPENAI_ENDPOINT}}
target: ./.localConfigs.testTool
envs:
TEAMSFX_NOTIFICATION_STORE_FILENAME: ${{TEAMSFX_NOTIFICATION_STORE_FILENAME}}
# OPENAI_KEY: ${{SECRET_OPENAI_KEY}}
AZURE_OPENAI_KEY: ${{SECRET_AZURE_OPENAI_KEY}}
AZURE_OPENAI_ENDPOINT: ${{SECRET_AZURE_OPENAI_ENDPOINT}}
```
1. Ensure you have downloaded and installed [Visual Studio Code](https://code.visualstudio.com/docs/setup/setup-overview)
1. Install the [Teams Toolkit extension](https://marketplace.visualstudio.com/items?itemName=TeamsDevApp.ms-teams-vscode-extension)
1. Copy this sample into a new folder outside of teams-ai
1. Select File > Open Folder in VS Code and choose this sample's directory
1. From the left pane, select **Run and Debug**(Ctrl+Shift+D) and select **Debug in Test Tool** in dropdown list.
1. Select Debug > Start Debugging or F5 to run the app.
1. The browser will pop up to open Teams App Test Tool.
1. The browser will pop up to open Teams App Test Tool.
Loading

0 comments on commit d3356b6

Please sign in to comment.