Skip to content
This repository was archived by the owner on Jan 15, 2025. It is now read-only.

Commit 8fcf25e

Browse files
munozemiliomunozemilio
authored
Generating docs for R12 (#1119)
* Generating docs for R12 * Documenting Node version dependency
1 parent 3b12e37 commit 8fcf25e

File tree

5 files changed

+123
-98
lines changed

5 files changed

+123
-98
lines changed

‎packages/cli/README.md‎

Lines changed: 72 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ botframework-cli
66
[![Downloads](https://img.shields.io/npm/dt/@microsoft/botframework-cli)](https://github.com/microsoft/botframework-cli)
77
[![License](https://img.shields.io/npm/l/@microsoft/botframework-cli)](https://github.com/microsoft/botframework-cli/blob/master/packages/cli/package.json)
88

9+
# Dependency
10+
Node v12
11+
12+
913
# Usage
1014

1115
```sh-session
@@ -309,23 +313,34 @@ _See code: [@microsoft/bf-dialog](https://github.com/microsoft/botframework-cli/
309313

310314
## `bf dialog:merge PATTERNS`
311315

312-
Merge component .schema files into an app.schema.
316+
Merge `<kind>.schema` and `<kind>[.<locale>].uischema` definitions from a project and its dependencies into a single .schema for describing .dialog files and a per locale .uischema for describing how Composer shows them. If a dependent package has an "exported" directory it is copied to /<package> in the --imports directory. You can make use of negative patterns like !**/generated/** to exclude particular directories or files, although some directories like bin, obj and node_modules are automatically excluded.
313317

314318
```
315319
USAGE
316320
$ bf dialog:merge PATTERNS
317321
318322
ARGUMENTS
319-
PATTERNS Any number of glob regex patterns to match .schema, .csproj, or package.json files.
323+
PATTERNS Any number of glob regex patterns to match .csproj, .nuspec or package.json files.
320324
321325
OPTIONS
322-
-h, --help show CLI help
323-
-o, --output=output [default: app.schema] Output path and filename for merged schema.
324-
-v, --verbose Show verbose logging of files as they are processed.
326+
-c, --checkOnly Check and do not write files.
327+
-h, --help show CLI help
328+
329+
-o, --output=output Output path and optional filename for merged .schema and .uischema. Defaults to first project
330+
name.
331+
332+
-s, --schema=schema Path to merged .schema file to use if merging .uischema only.
333+
334+
-v, --verbose Show verbose logging of files as they are processed.
335+
336+
--extension=extension [default: .dialog,.lg,.lu,.schema,.qna,.uischema] Extension to include as a resource.
337+
338+
--imports=imports Output path for imported assets. Defaults to the directory of --out with an imported
339+
directory.
325340
326341
EXAMPLES
327-
$ bf dialog:merge *.csproj
328-
$ bf dialog:merge libraries/**/*.schema **/*.csproj -o app.schema
342+
$ bf dialog:merge myProject.csproj plugins/*.nuspec
343+
$ bf dialog:merge package.json -o app.schema
329344
```
330345

331346
_See code: [@microsoft/bf-dialog](https://github.com/microsoft/botframework-cli/tree/master/packages/dialog/src/commands/dialog/merge.ts)_
@@ -342,8 +357,9 @@ ARGUMENTS
342357
PATTERNS Any number of glob regex patterns to match .dialog files.
343358
344359
OPTIONS
345-
-h, --help show CLI help
346-
-v, --verbose Show verbose output
360+
-h, --help show CLI help
361+
-s, --schema=schema Default schema to use if no $schema in dialog file.
362+
-v, --verbose Show verbose output
347363
```
348364

349365
_See code: [@microsoft/bf-dialog](https://github.com/microsoft/botframework-cli/tree/master/packages/dialog/src/commands/dialog/verify.ts)_
@@ -416,6 +432,7 @@ OPTIONS
416432
-i, --in=in (required) Folder that contains .lg file.
417433
-o, --out=out Output file or folder name. If not specified stdout will be used as output
418434
-r, --recurse Consider sub-folders to find .lg file(s)
435+
--region=region (required) The sub region.
419436
--srclang=srclang Source lang code. Auto detect if missing.
420437
--tgtlang=tgtlang (required) Comma separated list of target languages.
421438
--translate_comments Machine translate all comments found in .lg file
@@ -624,14 +641,9 @@ USAGE
624641
OPTIONS
625642
-h, --help show CLI help
626643
--appId=appId (required) LUIS application Id (defaults to config:LUIS:appId)
627-
628644
--direct Available only in direct version query. Do not publish to staging or production
629-
(default: false)
630-
631645
--endpoint=endpoint LUIS endpoint hostname
632-
633646
--staging Publishes application version to Staging slot, otherwise publish to production
634-
(default: false)
635647
636648
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
637649
config:LUIS:subscriptionKey)
@@ -740,9 +752,9 @@ OPTIONS
740752
-h, --help luis:build command help
741753
-i, --in=in Lu file or folder
742754
743-
-o, --out=out Output folder name to write out .dialog and settings files. If not specified, application
744-
setting will be output to console
745-
755+
-o, --out=out Output folder name to write out .dialog and settings files. If not specified,
756+
application setting will be output to console
757+
746758
--authoringKey=authoringKey LUIS authoring key
747759
748760
--botName=botName Bot name
@@ -751,27 +763,29 @@ OPTIONS
751763
752764
--deleteOldVersion Deletes old version of LUIS application after building new one.
753765
754-
--dialog=dialog Dialog recognizer type [multiLanguage|crosstrained]. No dialog recognizers will be generated if not specified. Only valid if --out is set
766+
--dialog=dialog Dialog recognizer type [multiLanguage|crosstrained]. No dialog recognizers will be
767+
generated if not specified. Only valid if --out is set
768+
769+
--directVersionPublish Available only in direct version query. Do not publish to staging or production
770+
771+
--endpoint=endpoint Luis authoring endpoint for publishing
755772
756773
--fallbackLocale=fallbackLocale Locale to be used at the fallback if no locale specific recognizer is found. Only
757774
valid if --out is set
758775
776+
--isStaging Publishes luis application to staging slot if set. Default to production slot
777+
759778
--log Writes out log messages to console
760779
761780
--luConfig=luConfig Path to config for lu build which can contain switches for arguments
762781
763782
--region=region [default: westus] LUIS authoring region [westus|westeurope|australiaeast]
764783
765-
--suffix=suffix Environment name as a suffix identifier to include in LUIS app name. Defaults to
766-
current logged in user alias
767-
768-
--endpoint Luis authoring endpoint for publishing
769-
770784
--schema=schema Defines $schema for generated .dialog files
771785
772-
--isStaging Publishes luis application to staging slot if set. Default to production slot
786+
--suffix=suffix Environment name as a suffix identifier to include in LUIS app name. Defaults to
787+
current logged in user alias
773788
774-
--directVersionPublish [default: false] Available only in direct version query. Do not publish to staging or production
775789
EXAMPLE
776790
777791
$ bf luis:build --in {INPUT_FILE_OR_FOLDER} --authoringKey {AUTHORING_KEY} --botName {BOT_NAME}
@@ -813,18 +827,18 @@ USAGE
813827
$ bf luis:cross-train
814828
815829
OPTIONS
816-
-f, --force [default: false] If --out flag is provided with the path to an existing file, overwrites that file
817-
-h, --help luis:cross-train command help
830+
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
831+
-h, --help Luis:cross-train command help
818832
-i, --in=in Source lu and qna files folder
819833
820-
-o, --out=out Output folder name. If not specified, the cross trained files will be wrote to cross-trained
821-
folder under folder of current command
834+
-o, --out=out Output folder name. If not specified, the cross trained files will be written to
835+
cross-trained folder under folder of current command
822836
823837
--config=config Path to config file of mapping rules
824838
825839
--intentName=intentName [default: _Interruption] Interruption intent name
826840
827-
--log [default: false] Writes out log messages to console
841+
--log Writes out log messages to console
828842
```
829843

830844
_See code: [@microsoft/bf-luis-cli](https://github.com/microsoft/botframework-cli/tree/master/packages/luis/src/commands/luis/cross-train.ts)_
@@ -939,6 +953,7 @@ OPTIONS
939953
--appId=appId (required) LUIS application Id (defaults to config:LUIS:appId)
940954
--endpoint=endpoint LUIS endpoint hostname
941955
--json Display output as JSON
956+
--mode=mode Value specifying mode of training (Standard | Neural).
942957
943958
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
944959
config:LUIS:subscriptionKey)
@@ -1077,6 +1092,8 @@ OPTIONS
10771092
10781093
--endpoint=endpoint LUIS endpoint hostname
10791094
1095+
--exportLU Export format type as LU
1096+
10801097
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
10811098
config:LUIS:subscriptionKey)
10821099
@@ -1113,7 +1130,7 @@ OPTIONS
11131130
--subscriptionKey=subscriptionKey (required) LUIS cognitive services subscription key (default:
11141131
config:LUIS:subscriptionKey)
11151132
1116-
--versionId=versionId Version to export (defaults to config:LUIS:versionId)
1133+
--versionId=versionId Version to import (defaults to config:LUIS:versionId)
11171134
11181135
EXAMPLE
11191136
@@ -1339,37 +1356,42 @@ USAGE
13391356
$ bf qnamaker:build
13401357
13411358
OPTIONS
1342-
-b, --botName=botName (required) Bot name
1343-
-f, --force [default: false] If --out flag is provided with the path to an existing file, overwrites that file
1359+
-b, --botName=botName Bot name
1360+
1361+
-f, --force If --out flag is provided with the path to an existing file, overwrites that
1362+
file
1363+
13441364
-h, --help qnamaker:build command help
1365+
13451366
-i, --in=in Source .qna file or folder
13461367
1347-
-o, --out=out Output folder name to write out .dialog and settings files. If not specified, knowledge base
1348-
setting will be output to console
1368+
-o, --out=out Output folder name to write out .dialog and settings files. If not specified,
1369+
knowledge base setting will be output to console
13491370
1350-
-s, --subscriptionKey=subscriptionKey (required) QnA maker subscription key
1371+
-s, --subscriptionKey=subscriptionKey QnA maker subscription key
13511372
13521373
--defaultCulture=defaultCulture Culture code for the content. Infer from .qna if available. Defaults to en-us
13531374
if not set
13541375
1355-
--dialog=dialog Dialog recognizer type [multiLanguage|crosstrained]. No dialog recognizers will be generated if not specified. Only valid if --out is set
1376+
--dialog=dialog Dialog recognizer type [multiLanguage|crosstrained]. No dialog recognizers will
1377+
be generated if not specified. Only valid if --out is set
1378+
1379+
--endpoint=endpoint Qnamaker authoring endpoint for publishing
13561380
13571381
--fallbackLocale=fallbackLocale Locale to be used at the fallback if no locale specific recognizer is found.
13581382
Only valid if --out is set
13591383
1360-
--log [default: false] Writes out log messages to console
1384+
--log Writes out log messages to console
13611385
1362-
--qnaConfig=qnaConfig Path to config for qnamaker build which can contain switches for arguments
1386+
--qnaConfig=qnaConfig Path to config for qna build which can contain switches for arguments
13631387
13641388
--region=region [default: westus] Overrides public endpoint
13651389
https://<region>.api.cognitive.microsoft.com/qnamaker/v4.0/
13661390
1391+
--schema=schema Defines $schema for generated .dialog files
1392+
13671393
--suffix=suffix Environment name as a suffix identifier to include in qnamaker kb name.
13681394
Defaults to current logged in user alias
1369-
1370-
--endpoint=endpoint Qnamaker authoring endpoint for publishing
1371-
1372-
--schema=schema Defines $schema for generated .dialog files
13731395
13741396
EXAMPLE
13751397
@@ -1409,18 +1431,18 @@ USAGE
14091431
$ bf qnamaker:cross-train
14101432
14111433
OPTIONS
1412-
-f, --force [default: false] If --out flag is provided with the path to an existing file, overwrites that file
1413-
-h, --help qnamaker:cross-train command help
1434+
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
1435+
-h, --help luis:cross-train command help
14141436
-i, --in=in Source lu and qna files folder
14151437
1416-
-o, --out=out Output folder name. If not specified, the cross trained files will be wrote to cross-trained
1417-
folder under folder of current command
1438+
-o, --out=out Output folder name. If not specified, the cross trained files will be written to
1439+
cross-trained folder under folder of current command
14181440
14191441
--config=config Path to config file of mapping rules
14201442
14211443
--intentName=intentName [default: _Interruption] Interruption intent name
14221444
1423-
--log [default: false] Writes out log messages to console
1445+
--log Writes out log messages to console
14241446
```
14251447

14261448
_See code: [@microsoft/bf-qnamaker](https://github.com/microsoft/botframework-cli/tree/master/packages/qnamaker/src/commands/qnamaker/cross-train.ts)_
@@ -1618,9 +1640,9 @@ USAGE
16181640
$ bf qnamaker:kb:export
16191641
16201642
OPTIONS
1621-
-f, --force [default: false] If --out flag is provided with the path to an existing file, overwrites that file.
1643+
-f, --force If --out flag is provided with the path to an existing file, overwrites that file.
16221644
-h, --help qnamaker:kb:export command help
1623-
-o, --out Output file path. If not specified stdout will be used as output.
1645+
-o, --out=out Output file path. If not specified stdout will be used as output.
16241646
--endpoint=endpoint Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/
16251647
--environment=environment [default: Prod] Specifies whether environment is Test or Prod.
16261648

‎packages/dialog/README.md‎

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,9 @@ This package is intended for Microsoft use only and should be consumed through @
1313

1414
# Commands
1515
<!-- commands -->
16-
- [@microsoft/bf-dialog](#microsoftbf-dialog)
17-
- [Relevant docs](#relevant-docs)
18-
- [Commands](#commands)
19-
- [`bf dialog`](#bf-dialog)
20-
- [`bf dialog:merge PATTERNS`](#bf-dialogmerge-patterns)
21-
- [`bf dialog:verify PATTERNS`](#bf-dialogverify-patterns)
16+
* [`bf dialog`](#bf-dialog)
17+
* [`bf dialog:merge PATTERNS`](#bf-dialogmerge-patterns)
18+
* [`bf dialog:verify PATTERNS`](#bf-dialogverify-patterns)
2219

2320
## `bf dialog`
2421

@@ -32,7 +29,7 @@ OPTIONS
3229
-h, --help Dialog command help
3330
```
3431

35-
_See code: [src/commands/dialog/index.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/dialog/blob/v1.0.0/src/commands/dialog/index.ts)_
32+
_See code: [src/commands/dialog/index.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/dialog/src/commands/dialog/index.ts)_
3633

3734
## `bf dialog:merge PATTERNS`
3835

@@ -66,7 +63,7 @@ EXAMPLES
6663
$ bf dialog:merge package.json -o app.schema
6764
```
6865

69-
_See code: [src/commands/dialog/merge.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/dialog/blob/v1.0.0/src/commands/dialog/merge.ts)_
66+
_See code: [src/commands/dialog/merge.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/dialog/src/commands/dialog/merge.ts)_
7067

7168
## `bf dialog:verify PATTERNS`
7269

@@ -85,5 +82,5 @@ OPTIONS
8582
-v, --verbose Show verbose output
8683
```
8784

88-
_See code: [src/commands/dialog/verify.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/dialog/blob/v1.0.0/src/commands/dialog/verify.ts)_
85+
_See code: [src/commands/dialog/verify.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/dialog/src/commands/dialog/verify.ts)_
8986
<!-- commandsstop -->

‎packages/lg/README.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,7 @@ OPTIONS
6969
-i, --in=in (required) Folder that contains .lg file.
7070
-o, --out=out Output file or folder name. If not specified stdout will be used as output
7171
-r, --recurse Consider sub-folders to find .lg file(s)
72+
--region=region (required) The sub region.
7273
--srclang=srclang Source lang code. Auto detect if missing.
7374
--tgtlang=tgtlang (required) Comma separated list of target languages.
7475
--translate_comments Machine translate all comments found in .lg file

0 commit comments

Comments
 (0)