Skip to content

Commit

Permalink
docs: archive old docs (microsoft#3572)
Browse files Browse the repository at this point in the history
Co-authored-by: Andy Brown <asbrown002@gmail.com>
  • Loading branch information
zxyanliu and a-b-r-o-w-n authored Jul 7, 2020
1 parent fc33f24 commit b7df0ff
Show file tree
Hide file tree
Showing 266 changed files with 370 additions and 214 deletions.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.

Large diffs are not rendered by default.

File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,58 +1,58 @@
# Linting and validation

As an integrated development tool, Bot Framework Composer supports validation of data when you author an [.lg](https://aka.ms/lg-file-format) template, an [.lu](https://aka.ms/lu-file-format) template, and [expressions](https://github.com/microsoft/BotBuilder-Samples/tree/master/experimental/common-expression-language) to fill in property fields. Error indicators will show in both inline editors and corresponding all-up views (**Bot Responses** and **User Input**). The **Notifications** page (click **Notifications** icon on the left navigation pane) displays an aggregation of all errors and warnings. With the help of linting and validation, your bot-authoring experience will be improved and you can easily build a functional bot that can "run".

> [!NOTE]
> We are still working to improve the implementation of linting and validation in Composer. More user scenarios will be updated.
Whenever you see `Start Bot` button in grey, this indicates your bot has errors that prevent it from running successfully.

![start-grey](./media/validation/start-grey.png)

The number beside the error icon indicates the number of errors. Click the error icon you will be navigated to the **Notifications** page listing all errors and warnings.

![notification-all-up-view](./media/validation/notification-all-up-view.png)

Click any of the errors on the **Notifications** page will navigate you to the matching error location. After you fix all the errors, you will see the `Start Bot` button in blue, this indicates your bot has no errors and it will run successfully.

## .lg files

When you author an [.lg template](https://aka.ms/lg-file-format) that has syntax errors, an indicator will show in the inline editor with a red wiggling line.

![inline-error-lg](./media/validation/inline-error-lg.png)

To diagnose and fix the error, you can read the error message beneath the editor and click `here` to refer to the syntax documentation. You can also hover your mouse over the erroneous part and read the detailed error message with suggested fixes.

![hover-message-lg](./media/validation/hover-message-lg.png)

Click **Bot Responses** on the left navigation pane, you will find the error is also saved and updated in the lg all-up view. The tiny red rectangle on the right end of the editor helps you to identify where the error is. This is especially helpful when you have a long list of templates. Hover your mouse over the erroneous part you will see detailed error message with suggested fixes.

![lg-all-up-view](./media/validation/lg-all-up-view.png)

## .lu files

When you author an [.lu template](https://aka.ms/lu-file-format) that has syntax errors, the entire lu inline editor will be in red frame. To diagnose and fix the error, you can read the error message beneath the editor and click `here` to refer to the syntax documentation.

![lu-inline-error](./media/validation/lu-inline-error.png)

Click **User Input** on the left navigation pane, you will see a popup window describing the lu error message.

![lu-popup](./media/validation/lu-popup.png)

Click **Edit** button you will see the error is also saved and updated in the lu all-up view. You can choose to fix the error either in the lu all-up view or in the inline editor.

![lu-all-up-view](./media/validation/lu-all-up-view.png)

## Expressions

When you fill in property fields with invalid [expressions](https://github.com/microsoft/BotBuilder-Samples/tree/master/experimental/common-expression-language) or when a required property is missing, the entire form editor will be in red frame.

![expression-inline-error](./media/validation/expression-inline-error.png)

To diagnose and fix the error, you can read the error message beneath the editor and click `here` to refer to the syntax documentation.

![expression-missing-property](./media/validation/expression-missing-property.png)

# Next

TBD
# Linting and validation

As an integrated development tool, Bot Framework Composer supports validation of data when you author an [.lg](https://aka.ms/lg-file-format) template, an [.lu](https://aka.ms/lu-file-format) template, and [expressions](https://github.com/microsoft/BotBuilder-Samples/tree/master/experimental/common-expression-language) to fill in property fields. Error indicators will show in both inline editors and corresponding all-up views (**Bot Responses** and **User Input**). The **Notifications** page (click **Notifications** icon on the left navigation pane) displays an aggregation of all errors and warnings. With the help of linting and validation, your bot-authoring experience will be improved and you can easily build a functional bot that can "run".

> [!NOTE]
> We are still working to improve the implementation of linting and validation in Composer. More user scenarios will be updated.
Whenever you see `Start Bot` button in grey, this indicates your bot has errors that prevent it from running successfully.

![start-grey](./media/validation/start-grey.png)

The number beside the error icon indicates the number of errors. Click the error icon you will be navigated to the **Notifications** page listing all errors and warnings.

![notification-all-up-view](./media/validation/notification-all-up-view.png)

Click any of the errors on the **Notifications** page will navigate you to the matching error location. After you fix all the errors, you will see the `Start Bot` button in blue, this indicates your bot has no errors and it will run successfully.

## .lg files

When you author an [.lg template](https://aka.ms/lg-file-format) that has syntax errors, an indicator will show in the inline editor with a red wiggling line.

![inline-error-lg](./media/validation/inline-error-lg.png)

To diagnose and fix the error, you can read the error message beneath the editor and click `here` to refer to the syntax documentation. You can also hover your mouse over the erroneous part and read the detailed error message with suggested fixes.

![hover-message-lg](./media/validation/hover-message-lg.png)

Click **Bot Responses** on the left navigation pane, you will find the error is also saved and updated in the lg all-up view. The tiny red rectangle on the right end of the editor helps you to identify where the error is. This is especially helpful when you have a long list of templates. Hover your mouse over the erroneous part you will see detailed error message with suggested fixes.

![lg-all-up-view](./media/validation/lg-all-up-view.png)

## .lu files

When you author an [.lu template](https://aka.ms/lu-file-format) that has syntax errors, the entire lu inline editor will be in red frame. To diagnose and fix the error, you can read the error message beneath the editor and click `here` to refer to the syntax documentation.

![lu-inline-error](./media/validation/lu-inline-error.png)

Click **User Input** on the left navigation pane, you will see a popup window describing the lu error message.

![lu-popup](./media/validation/lu-popup.png)

Click **Edit** button you will see the error is also saved and updated in the lu all-up view. You can choose to fix the error either in the lu all-up view or in the inline editor.

![lu-all-up-view](./media/validation/lu-all-up-view.png)

## Expressions

When you fill in property fields with invalid [expressions](https://github.com/microsoft/BotBuilder-Samples/tree/master/experimental/common-expression-language) or when a required property is missing, the entire form editor will be in red frame.

![expression-inline-error](./media/validation/expression-inline-error.png)

To diagnose and fix the error, you can read the error message beneath the editor and click `here` to refer to the syntax documentation.

![expression-missing-property](./media/validation/expression-missing-property.png)

# Next

TBD
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes
File renamed without changes.
File renamed without changes.
File renamed without changes.
74 changes: 74 additions & 0 deletions docs/archived docs/toc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Microsoft Bot Framework Composer

### Overview

- [Introduction to Bot Framework Composer](./docs/introduction.md)

### Installation

- [Set up Composer using Yarn](./docs/setup-yarn.md)

### QuickStart

- [Tour of Composer](./docs/onboarding.md)
- [Create your first bot](./docs/quickstart-create-bot.md)

### Tutorials

0. [Introduction](./docs/tutorial/tutorial-introduction.md)
1. [Create a bot](./docs/tutorial/tutorial-create-bot.md)
1. [Add a dialog](./docs/tutorial/tutorial-add-dialog.md)
1. [Get weather report](./docs/tutorial/tutorial-get-weather.md)
1. [Add help and cancel commands](./docs/tutorial/tutorial-add-help.md)
1. [Add Language Generation](./docs/tutorial/tutorial-lg.md)
1. [Use cards](./docs/tutorial/tutorial-cards.md)
1. [Add LUIS](./docs/tutorial/tutorial-luis.md)

### Concepts

- [Dialogs](./docs/concept-dialog.md)
- [Events and triggers](./docs/concept-events-and-triggers.md)
- [Conversation flow and memory](./docs/concept-memory.md)
- [Language generation](./docs/concept-language-generation.md)
- [Language understanding](./docs/concept-language-understanding.md)

### How to

#### Develop

- [Send messages](./docs/how-to-send-messages.md)
- [Ask for user input](./docs/how-to-ask-for-user-input.md)
- [Manage conversation flow](./docs/how-to-control-conversation-flow.md)
- [Add LUIS to your bot](./docs/how-to-use-LUIS.md)
- [Add QnA to your bot](./docs/how-to-add-qna-to-bot.md)
- [Send cards](./docs/how-to-send-cards.md)
- [Define triggers and events](./docs/how-to-define-triggers.md)
- [Define advanced intents and entities](./docs/how-to-define-advanced-intents-entities.md)
- [Use OAuth](./docs/how-to-use-oauth.md)
- [Send an HTTP request](./docs/how-to-send-http-request.md)

#### Test

- [Test in Emulator](https://docs.microsoft.com/en-us/azure/bot-service/bot-service-debug-emulator?view=azure-bot-service-4.0&tabs=csharp)

#### Debug

- [Linting and validation](./docs/how-to-use-validation.md)

#### Publish

- [Publish your bot to Azure](/docs/how-to-publish-bot.md)

### Resources

- [Bot Framework Adaptive Dialog](https://github.com/microsoft/BotBuilder-Samples/tree/master/experimental/adaptive-dialog)
- [Language generation](https://github.com/microsoft/BotBuilder-Samples/tree/master/experimental/language-generation)
- [Common expression language](https://github.com/microsoft/BotBuilder-Samples/blob/master/experimental/common-expression-language)
- [.lu file format](https://aka.ms/lu-file-format)
- [.lg file format](https://aka.ms/lg-file-format)

## Related projects

- [Bot Framework](https://github.com/microsoft/botframework)
- [Bot Framework SDK](https://github.com/microsoft/botframework-sdk)
- [Bot Framework Emulator](https://github.com/microsoft/botframework-emulator)
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
82 changes: 82 additions & 0 deletions docs/toc.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
# Microsoft Bot Framework Composer

### Overview

- [Introduction to Bot Framework Composer](https://aka.ms/bf-composer-docs-introduction)

### Installation

- [Install Composer](https://aka.ms/bf-composer-docs-setup-yarn)

### QuickStart

- [Tour of Composer](https://aka.ms/bf-composer-docs-onboarding)
- [Create your first bot](https://aka.ms/bf-composer-docs-create-first-bot)

### Tutorials

1. [Introduction](https://aka.ms/bf-composer-docs-tutorial-introduction)
2. [Create a bot](https://aka.ms/bf-composer-docs-tutorial-create-bot)
3. [Add a dialog](https://aka.ms/bf-composer-docs-tutorial-add-dialog)
4. [Get weather report](https://aka.ms/bf-composer-docs-tutorial-get-weather-report)
5. [Add help and cancel commands](https://aka.ms/bf-composer-docs-tutorial-add-help-cancel-command)
6. [Add Language Generation](https://aka.ms/bf-composer-docs-tutorial-add-lg)
7. [Use cards](https://aka.ms/bf-composer-docs-tutorial-use-cards)
8. [Add LUIS](https://aka.ms/bf-composer-docs-tutorial-add-luis)

### Concepts

- [Dialogs](https://aka.ms/bf-composer-docs-dialog)
- [Events and triggers](https://aka.ms/bf-composer-docs-triggers)
- [Conversation flow and memory](https://aka.ms/bf-composer-docs-memory)
- [Concept natural language processing](https://aka.ms/bf-composer-docs-nlp)
- [Language generation](https://aka.ms/bf-composer-docs-lg)
- [Language understanding](https://aka.ms/bf-composer-docs-lu)

### Samples

- [Use samples](https://aka.ms/bf-composer-docs-use-samples)

### How to

#### Develop

- [Send messages](https://aka.ms/bf-composer-docs-send-messages)
- [Send cards](https://aka.ms/bf-composer-docs-send-cards)
- [Ask for user input](https://aka.ms/bf-composer-docs-ask-input)
- [Manage conversation flow](https://aka.ms/bf-composer-docs-conversation-flow)
- [Add LUIS to your bot](https://aka.ms/bf-composer-docs-add-luis)
- [Add QnA to your bot](https://aka.ms/bf-composer-docs-add-qna)
- [Define triggers and events](https://aka.ms/bf-composer-docs-define-triggers)
- [Define advanced intents and entities](https://aka.ms/bf-composer-docs-define-intent-entity)
- [Use OAuth](https://aka.ms/bf-composer-docs-oauth)
- [Send an HTTP request](https://aka.ms/bf-composer-docs-http-request)
- [Connect to a skill](https://aka.ms/bf-composer-docs-connect-skill)
- [Add custom actions](https://aka.ms/bf-composer-docs-custom-action)

#### Test

- [Test in Emulator](https://docs.microsoft.com/en-us/azure/bot-service/bot-service-debug-emulator?view=azure-bot-service-4.0&tabs=csharp)

#### Debug

- [Linting and validation](https://aka.ms/bf-composer-docs-validation)

#### Publish

- [Publish your bot to Azure](https://aka.ms/bf-composer-docs-publish-bot)

### Resources

- [Bot Framework Adaptive Dialog](https://aka.ms/adaptive-dialogs)
- [Language generation](https://aka.ms/language-generation)
- [Adaptive expressions](https://aka.ms/adaptive-expressions)
- [.lu file format](https://aka.ms/lu-file-format)
- [.lg file format](https://aka.ms/lg-file-format)
- [Glossary concepts](https://aka.ms/bf-composer-docs-glossary-concepts)

## Related projects

- [Bot Framework](https://github.com/microsoft/botframework)
- [Bot Framework SDK](https://github.com/microsoft/botframework-sdk)
- [Bot Framework Emulator](https://github.com/microsoft/botframework-emulator)

0 comments on commit b7df0ff

Please sign in to comment.