Merge branch 'master' into chrande/qnamaker-reshuffle

Author: munozemilio

CONTRIBUTING.md

@@ -6,7 +6,7 @@
     2. Inside the project folder run 'npm run build'
     3. Inside the packages folder(https://github.com/microsoft/botframework-cli/tree/master/packages) run 'npx oclif plugin <plugin-name>'
     4. Follow the wizard and set the prompts:
-
+    
       ? npm package: @microsoft/bf-<plugin-name>
       ? description: <Plugin brief description>
       ? author: Microsoft
@@ -19,32 +19,32 @@
       ? Use tslint (linter for TypeScript): Y
       ? Use mocha (testing framework): Y
       ? Add CI service config (Press <space> to select, <a> to toggle all, <i> to invert selection): select any
-
+    
     4. Go to the folder created by the previous command and add @microsoft/bf-cli-command as a dependency in your package.json file
-
+    
       "dependencies": {
         ...,
         "@microsoft/bf-cli-command": "1.0.0",
         ...
       }   
-
+    
     5. At the root level(https://github.com/microsoft/botframework-cli) run 'npm run build' to bootstrap the packages
 
 ## Steps to create a new command
     1. Inside the plugin folder run 'npx oclif command <command-name>'. 
     	a. To add a subcommand use a colon separated format as follows: 
     		<command-name:subcommand-name>
     2. Replace the import 'import {Command, flags} from '@oclif/command' line inside the newly created command with '@microsoft/bf-cli-command'
-
+    
       - import {Command, flags} from '@oclif/command'
       + import {Command, flags} from '@microsoft/bf-cli-command'
-
+    
     3. Add the typing to the flags property like this if needed:
-
+    
       static flags: flags.Input<any> = {
         help: flags.help({description: 'Display help'}),
       }
-
+    
     4. Implement the run method
 
 ## General Guidelines
@@ -89,7 +89,7 @@ Use the following verbs for standard commands
 * Commands and options are case SenSiTive, specified in lower case. *bf cmd:subcmd*.
 * Multi word options are lowcase, nohyphen, multiwords. Multi word commands are forbidden.
 * Prefer flags to args
-* Commands shall follow the *bf \[noun\]\[verb\]\[noun\]* form for example *bf qnamaker:create:kb*. 
+* Commands shall follow the *bf \[noun\]\[noun\]\[verb\]* form for example *bf qnamaker:create:kb*. 
 * FLags with specific units: 
   * In general, DO NOT put units in Flag names. ALWAYS put the expected units in the help text. Example: --durationinminutes should simply be --duration. This prevents the need to add more arguments later if more units are supported. 
   * Consider allowing a syntax that will let the user specify units. For example, even if the service requires a value in minutes, consider accepting 1h or 60m. It is fine to assume a default (i.e. 60 = 60 minutes).

Internal-Hackathon-Oct-18-2019.md

@@ -40,7 +40,9 @@ npm i -g @microsoft/botframework-cli
 To view detailed usage information see the [CLI ReadMe page](https://github.com/microsoft/botframework-cli/tree/master/packages/cli)
 
 ## Issues and Feature Requests
-Please file issues and feature requests [here](https://github.com/microsoft/botframework-cli/issues).
+Please file issues and feature requests [here](https://github.com/microsoft/botframework-cli/issues). 
+
+Also, see current [known issues](https://github.com/microsoft/botframework-cli/labels/known-issues).
 
 Thank you for your support.
 

README.md

@@ -159,6 +159,7 @@ The following LUIS prebuilt entity types are supported -
         - \<synonym1>, \<synonym2>, ...
 
 > Alternate definition
+
 @ list color favColor, screenColor =
     - \<normalized-value>
         - \<synonym1>; \<synonym2>; ...
@@ -188,6 +189,7 @@ Example definition:
     - Set {deviceTemperature = {customDevice = owen} to 72}
 
 > Define a composite entity ‘deviceTemperature’ that has device (list entity), customDevice (ml entity), temperature (pre-built entity) as children
+
 @ composite deviceTemperature = [device, customDevice, temperature]
 
 @ list device = 
@@ -212,6 +214,7 @@ Example definition:
 @ hrf-number = /hrf-[0-9]{6}/
 
 > Alternate definition
+
 @ regex hrf-number from, to = /hrf-[0-9]{6}/
 ```
 
@@ -234,16 +237,20 @@ Roles in .lu file format can be explicitly or implicity defined.
 Explicit definition follow the following notation - @ \<entityType> \<entityName> [hasRole[s]] role1, role2, ...
 ```markdown
 > # ml entity definition with roles
+
 @ ml name role1, role2
 
 > this is the same as 
+
 @ ml name hasRoles role1, role2
 
 > this is also the same as 
+
 @ ml name
 @ name hasRoles role1, role2
 
 > Also same as 
+
 @ ml name
 @ name hasRole role1
 @ name hasRole role2
@@ -258,6 +265,7 @@ Implicit definition: You can refer to roles directly in patterns as well as in l
 - {userName=vishwac} is my name
 
 > This definition is same as including an explicit defintion for userName with 'lastName', 'firstName' as roles
+
 > @ ml userName hasRoles lastName, firstName
 ```
 
@@ -273,8 +281,9 @@ In patterns, you can use roles using the {\<entityName\>:\<roleName\>} notation.
 You can define multiple roles for an entity in patterns and the parser will do rest! 
 
 ```markdown
-# BookFlight
 > roles can be specified for list entity types as well - in this case fromCity and toCity are added as roles to the 'city' list entity defined further below
+
+# BookFlight
 - book flight from {city:fromCity} to {city:toCity}
 - [can you] get me a flight from {city:fromCity} to {city:toCity}
 - get me a flight to {city:toCity}
@@ -331,7 +340,7 @@ Here's an example of a phrase list definition:
 @ phraseList Want
 @ phraseList Want =
     - require, need, desire, know
-```
+
 
 > You can also break up the phrase list values into an actual list
 
@@ -341,6 +350,7 @@ Here's an example of a phrase list definition:
 	- desire
 	- know
 ```
+
 By default synonyms are set to be **not interchangeable** (matches with the portal experience). You can optionally set the synonyms to be **interchangeable** as part of the definition. Here's an example:
 
 ```markdown
@@ -355,26 +365,33 @@ Here's how you add a feature to a ml entity or an intent - with `usesFeature`.
 
 ```markdown
 > entity definition - <> \<entityType> \<entityName> [<roles>]
+  
 @ prebuilt personName
 @ prebuilt age
 
 > entity definition with roles
+  
 @ ml userName hasRoles fistName, lastName
 
 > add entity as feature to another entity
+  
 @ userName usesFeature personName
 
 > add entity as feature to intent
+  
 @ intent getUserNameIntent usesFeature personName
 
 > Intent definition
+  
 # getUserNameIntent
 - utterances
 
 > multiple entities as feature to a model
+  
 @ intent getUserNameIntent usesFeature age, personName
 
 > intent as feature to another intent
+  
 @ intent getUserProfileIntent usesFeature getUserNameIntent
 
 # getUserProfileIntent
@@ -393,21 +410,25 @@ Here's how you define phrase list as a feature to another model
 
 ```markdown
 > phrase list definition
+
 @ phraseList PLCity(interchangeable) = 
     - seattle
     - space needle
     - SEATAC
     - SEA
 
 > phrase list as feature to intent (also applicable to entities)
+
 @ intent getUserProfileIntent usesFeature PLCity
 
 > phrase list as a feature to an ml entity.
+
 @ ml myCity usesFeature PLCity
 
 @ regex regexZipcode = /[0-9]{5}/
 
 > phrase list as feature to n-depth entity with phrase list as a feature
+
 @ ml address fromAddress, toAddress
 @ address =
     - @ number 'door number'
@@ -474,16 +495,20 @@ Here's an example of those references:
 
 ```markdown
 > You can include references to other .lu files
+
 [All LU files](./all.lu)
 
 > References to other files can have wildcards in them
+
 [en-us](./en-us/*)
 
 > References to other lu files can include sub-folders as well. 
 > /** indicates to the parser to recursively look for .lu files in all subfolders as well.
+
 [all LU files](../**)
 
 > You can include deep references to intents defined in a .lu file in utterances
+
 # None
 - [None uttearnces](./all.lu#Help)
 
@@ -500,12 +525,14 @@ Here's an example of those references:
 > - [all.lu](./all.lu#*utterancesAndPatterns*)
 
 > You can include wild cards with deep references to QnA maker questions defined in a .qna file in utterances
+
 # None
 - [QnA questions](./*#?)
 
 > With the above statement, the parser will parse **all** .lu files under ./, extract out all questions from QnA pairs in those files and add them under 'None' intent as defined in this file.
 
 > You can include deep references to QnA maker questions defined in a .qna file in utterances
+
 # None
 - [QnA questions](./qna1.qna#?)