Doc updates (#268)

Author: vishwacsena

packages/lu/README.md

@@ -11,6 +11,12 @@
 * [`lu file format`](./docs/lu-file-format.md)
 * [`QnA file format`](./docs/qna-file-format.md)
 
+# Additional documentation
+* [Working with LUIS](./working-with-luis.md)
+* [Working with QnA Maker](./working-with-qna.md)
+* [Machine translating .lu/ .qna files](./translate-command.md)
+* [@microsoft/bf-lu as a library](./use-as-library.md)
+
 # Commands
 <!-- commands -->
 * [`bf luis`](#bf-luis)

packages/lu/docs/create-luis-json.md

@@ -35,7 +35,7 @@ You can add comments to your .lu document by prefixing the comment with >. Here'
     ```
 ```
 
-Here's an example of question and answer definitions. The LUDown tool will automatically separate question and answers into a qnamaker JSON file that you can then use to create your new [QnaMaker.ai](http://qnamaker.ai) knowledge base article.
+Here's an example of question and answer definitions. The bf qnamaker:convert command will automatically separate question and answers into a qnamaker JSON file that you can then use to create your new [QnaMaker.ai](http://qnamaker.ai) knowledge base article.
 
 ```markdown
 > # QnA Definitions
@@ -113,7 +113,7 @@ $botframework : qna-alterations=
 ```
 
 ## QnA Maker pdf file ingestion
-QnA Maker also supports ingesting pdf files during KB creation. You can add files for QnA maker to ingest using the URL reference scheme. If the URI's content-type is not text/html, then the ludown parser will add it to files collection for QnA Maker to ingest. 
+QnA Maker also supports ingesting pdf files during KB creation. You can add files for QnA maker to ingest using the URL reference scheme. If the URI's content-type is not text/html, then the parser will add it to files collection for QnA Maker to ingest. 
 
 ```markdown
 [SurfaceManual.pdf](https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf)
@@ -131,7 +131,7 @@ You can include configuration information for your LUIS application or QnA Maker
 **Note** Any information explicitly passed in via CLI arguments will override information in the .qna file.
 
 ```markdown
-> Parser instruction - this is optional; unless specified, ludown will default to the latest version.
+> Parser instruction - this is optional; unless specified, parser will default to the latest version.
 > !# @version = 1.0
 
 > QnA Maker KB description

packages/lu/docs/qna-file-format.md

@@ -3,18 +3,17 @@ Often times you might want to target a multi-lingual bot. You can of course use
 
 In other cases, you might want to manage the translation and localization for the language understanding content for your bot independently. 
 
-Translate command in the ludown CLI takes advantage of the [Microsoft text translation API](https://docs.microsoft.com/en-us/azure/cognitive-services/translator/) to automatically machine translate .lu files to one or more than [60+ languages](https://aka.ms/translate-langs) supported by the Microsoft text translation cognitive service.
+Translate command in the @microsoft/bf-lu library takes advantage of the [Microsoft text translation API](https://docs.microsoft.com/en-us/azure/cognitive-services/translator/) to automatically machine translate .lu files to one or more than [60+ languages](https://aka.ms/translate-langs) supported by the Microsoft text translation cognitive service.
 
 You can learn more about language x locale support for [LUIS.ai](https://www.luis.ai/) [here](https://docs.microsoft.com/en-us/azure/cognitive-services/LUIS/luis-supported-languages) and [qnamaker.ai](https://www.qnamaker.ai/) [here](https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/languages-supported)
 
 ## What is translated? 
-With the ludown translate command you can translate: 
-- An .lu file and optionally translate
+- An .lu (or .qna) file and optionally translate
     - Comments in the lu file
     - LU and QnA reference link texts
-- List of .lu files under a specific path.
+- List of .lu/ .qna files under a specific path.
 
-When translating .lu file, 
+When translating .lu/ .qna file, 
 - [Intents](docs/lu-file-format.md#intent) are not translated
 - [Entity](docs/lu-file-format.md#entity) names are not translated
 
@@ -33,10 +32,10 @@ OPTIONS
 ```
 
 ## Getting keys
-Ludown translate expects a Machine translation subscription key. You can obtain one [here](https://aka.ms/translate-key)
+luis:translate command expects a Machine translation subscription key. You can obtain one [here](https://aka.ms/translate-key)
 
 ## Generating LUIS models from translated lu files
-You can follow instructions [here](https://aka.ms/translate-langs) to create LUIS models from lu files using ludown translate command. 
+You can follow instructions [here](./working-with-luis.md) to create LUIS models from lu files generated via luis:translate command. 
 
 **Note**: You need to explicitly provide the correct [LUIS lang code](https://docs.microsoft.com/en-us/azure/cognitive-services/LUIS/luis-supported-languages) to the bf luis:translate command.
 

packages/lu/docs/refresh-command.md

@@ -1,15 +1,15 @@
-# Ludown as a library
-Ludown can be used within a Node.js application as an imported library. Install locally:
+# Consuming @microsoft/bf-lu as a library
+@microsoft/bf-lu can be used within a Node.js application as an imported library. Install locally:
 
 ```bash
-npm install @microsoft/bf-luis --save
+npm install @microsoft/bf-lu --save
 ```
 
 ## Parsing lu files
 To parse LU files, you can use the parseFile() method. 
 
 ```js
-const ludown = require('ludown');
+const ludown = require('@microsoft/bf-lu');
 const luContent1 = `# Greeting
 - hi`;
 const log = false;
@@ -19,7 +19,7 @@ ludown.parser.parseFile(luContent1, log, locale)
         // Parsed LUIS object
         console.log(JSON.stringify(parsedContent.LUISJsonStructure, 2, null));
         // Parsed QnA content
-        console.log(JSON.stringify(parsedContent.additionalFilesToParse, 2, null));
+        console.log(JSON.stringify(parsedContent.qnaJsonStructure, 2, null));
         // Additional files to parse
         console.log(JSON.stringify(parsedContent.additionalFilesToParse, 2, null));
     })
@@ -40,7 +40,7 @@ ludown.parser.parseFile(luContent1, log, locale)
 You can use the available validateLUISBlob() function to verify if the parsed LUIS blob is valid. This helps catch name conflicts, invalid labelled utterances etc. 
 
 ```js
-const ludown = require('ludown');
+const ludown = require('@microsoft/bf-lu');
 const luContent = `# Greeting
 - hi {userName=bob}
 $userName:first=
@@ -79,8 +79,7 @@ parseContent();
 You can generate lu content from LUIS and QnA maker JSON using constructMdFromLUIS() and constructMdFromQnA() methods. Here's an example code snippet. 
 
 ```js
-#!/usr/bin/env node
-const ludown = require('ludown');
+const ludown = require('@microsoft/bf-lu')
 const luContent = `# Greeting
 - hi
 $userName:first=
@@ -128,7 +127,7 @@ You can take advantage of the [Microsoft text translation API](https://docs.micr
 To translate lu file content, you can simply use the parseAndTranslate() method. Here's a code snippet.
 
 ```js
-const ludown = require('ludown');
+const ludown = require('@microsoft/bf-lu');
 const luContent = `# Greeting
 - hi
 $userName:first=

packages/lu/docs/translate-command.md

@@ -0,0 +1,67 @@
+# Creating LUIS JSON model file
+
+Once you have created individual .lu files you can parse them all to a LUIS JSON model using this command: 
+```bash
+> bf luis:convert --in <folder with .lu files> --out <outputfolder> --name <luisAppName> --culture <luisAppCulture>]
+```
+
+This will parse all .lu files found and will create **ONE** LUIS JSON model. 
+
+If you would like to create multiple luis apps, then you can add a [root.lu file](./lu-file-format.md#External-references) that holds reference to other relevant .lu files and parse it like this: 
+
+```bash
+> bf luis:convert --in <root_file.lu> [--out <outputFolder> --name <luisAppName> --culture <luisAppCulture>]
+```
+
+This will parse all .lu files referenced in the root_file.lu and output **ONE** LUIS JSON model. 
+
+# Creating a New LUIS App
+## Pre-requisite
+- Install the luis-apis CLI via the following command
+
+```bash
+> npm i -g luis-apis
+```
+
+## using command line 
+You can use the new LUIS JSON file to create a new LUIS application using this command.
+```bash
+luis import application --in _LUISApp.json --authoringKey "" --endpoint ""
+```
+Note: If you are using LUIS CLI, you might see the option to provide a versionId, application name directly in the LUIS CLI. You can also provide this information directly in the [.lu file format](./lu-file-format.md#Model-description). Information explicitly specified in the LUIS CLI will override any information captured by bf luis:convert command. 
+
+## using [LUIS](http://luis.ai) portal
+- Navigate to [LUIS](http://luis.ai)
+- Sign in
+- Click on My apps
+- "Import new App"
+- Choose file -> select the _LUISApp.json generated by bf luis:convert command
+
+# Refresh command
+After you have bootstrapped and created your LUIS model and / or QnAMaker knowledge base, you might make subsequent refinements to your models directly from [luis.ai](https://luis.ai/) or [qnamaker.ai](https://qnamaker.ai). You can use the refresh command to re-generate .lu files from your LUIS JSON and / or QnAMaker JSON files.  
+
+```
+>bf luis:convert or bf qnamaker:convert
+
+  Usage: bf luis:convert --in <LUISJsonFile>  or bf qnamaker:convert --in <QnAJSONFile>
+
+```
+
+# Exporting LUIS model (for bf luis:convert)
+## Using CLI
+```bash
+luis export version --appId <string> --versionId <string> --authoringKey <key>
+```
+## using [LUIS](http://luis.ai) portal
+- Navigate to [LUIS](http://luis.ai)
+- Sign in
+- Click on My apps
+- Find the app you wish to download, click "..." -> Export app
+
+# Exporting QnA Maker 
+## using CLI
+```bash
+bf qnamaker:export:kb --kbId <kbId> --environment <string>
+```
+
+

packages/lu/docs/ludown-library.md packages/lu/docs/use-as-library.mdpackages/lu/docs/ludown-library.md renamed to packages/lu/docs/use-as-library.md

@@ -16,7 +16,7 @@ If you would like to create multiple QnA Maker KB's, then you can add a [root.lu
 This will parse all .lu files referenced in the root_file.lu and output **ONE** QnA Maker JSON model. 
 
 # Creating word alterations/ synonyms list
-You can use ludown to parse and compile all word alterations/ synonyms list that can then be used to replace your existing [QnA Maker alterations](https://westus.dev.cognitive.microsoft.com/docs/services/5a93fcf85b4ccd136866eb37/operations/5ac266295b4ccd1554da75fd) list. 
+You can use bf qnamaker:convert to parse and compile all word alterations/ synonyms list that can then be used to replace your existing [QnA Maker alterations](https://westus.dev.cognitive.microsoft.com/docs/services/5a93fcf85b4ccd136866eb37/operations/5ac266295b4ccd1554da75fd) list. 
 
 See [here](lu-file-format.md#QnA-Maker-alterations) for defining word alterations/ synonyms list in .lu files.
 

packages/lu/docs/working-with-luis.md

@@ -1,4 +1,4 @@
-> ludown can also parse .md files as well! 
+> parser can handle .md files as well! 
 
 # Greeting
 - Hi