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

Commit a2b30b5

Browse files
authored
Generating docs and removing dialog dependency from master (#648)
1 parent fded5d2 commit a2b30b5

File tree

6 files changed

+65
-21
lines changed

6 files changed

+65
-21
lines changed

packages/chatdown/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,4 +65,4 @@ _See code: [src/commands/chatdown/convert.ts](https://github.com/microsoft/botfr
6565
<!-- commandsstop -->
6666

6767
[1]:./docs/chatdown-format.md
68-
[2]:./docs/examples
68+
[2]:./docs/examples

packages/cli/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -963,7 +963,7 @@ _See code: [@microsoft/bf-cli-plugins](https://github.com/microsoft/botframework
963963

964964
## `bf plugins:install PLUGIN`
965965

966-
installs a plugin into the BF CLI
966+
Installs a plugin into the BF CLI
967967

968968
```
969969
USAGE
@@ -978,11 +978,11 @@ OPTIONS
978978
-v, --verbose
979979
980980
DESCRIPTION
981-
Can be installed from npm or a git url.
982-
Installation of a user-installed plugin will override a core plugin.
983-
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello'
984-
command will override the core plugin implementation. This is useful if a user needs to update core plugin
985-
functionality in the CLI without the need to patch and update the whole CLI.
981+
Installation of a user-installed plugin will override a core plugin.
982+
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
983+
will override the core plugin implementation.
984+
This is useful if a user needs to update core plugin functionality in the CLI without the need to patch and update the
985+
whole CLI.
986986
987987
ALIASES
988988
$ bf plugins:add

packages/cli/package.json

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@
3131
"@microsoft/bf-cli-config",
3232
"@microsoft/bf-qnamaker",
3333
"@microsoft/bf-luis-cli",
34-
"@microsoft/bf-dialog",
3534
"@microsoft/bf-cli-plugins"
3635
],
3736
"hooks": {
@@ -59,7 +58,6 @@
5958
"@microsoft/bf-cli-config": "1.0.0",
6059
"@microsoft/bf-luis-cli": "1.0.0",
6160
"@microsoft/bf-qnamaker": "1.0.0",
62-
"@microsoft/bf-dialog": "1.0.0",
6361
"@microsoft/bf-cli-plugins": "1.0.0",
6462
"@oclif/command": "~1.5.19",
6563
"@oclif/config": "~1.13.3",

packages/plugins/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ _See code: [src/commands/plugins/index.ts](https://github.com/microsoft/botframe
3434

3535
## `bf plugins:install PLUGIN`
3636

37-
installs a plugin into the BF CLI
37+
Installs a plugin into the BF CLI
3838

3939
```
4040
USAGE
@@ -49,11 +49,11 @@ OPTIONS
4949
-v, --verbose
5050
5151
DESCRIPTION
52-
Can be installed from npm or a git url.
53-
Installation of a user-installed plugin will override a core plugin.
54-
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello'
55-
command will override the core plugin implementation. This is useful if a user needs to update core plugin
56-
functionality in the CLI without the need to patch and update the whole CLI.
52+
Installation of a user-installed plugin will override a core plugin.
53+
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
54+
will override the core plugin implementation.
55+
This is useful if a user needs to update core plugin functionality in the CLI without the need to patch and update the
56+
whole CLI.
5757
5858
ALIASES
5959
$ bf plugins:add

packages/plugins/src/commands/plugins/install.ts

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,10 @@ import Plugins from '@oclif/plugin-plugins/lib/plugins'
88
import cli from 'cli-ux'
99

1010
export default class PluginsInstall extends Command {
11-
static description = `installs a plugin into the BF CLI
12-
Can be installed from npm or a git url.
11+
static description = `Installs a plugin into the BF CLI
1312
Installation of a user-installed plugin will override a core plugin.
14-
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in the CLI without the need to patch and update the whole CLI.
15-
`
13+
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command will override the core plugin implementation.
14+
This is useful if a user needs to update core plugin functionality in the CLI without the need to patch and update the whole CLI.`
1615

1716
static strict = false
1817

packages/qnamaker/README.md

Lines changed: 49 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ This package is intended for Microsoft use only and should be consumed through @
1818
* [`bf qnamaker:alterations`](#bf-qnamakeralterations)
1919
* [`bf qnamaker:alterations:list`](#bf-qnamakeralterationslist)
2020
* [`bf qnamaker:alterations:replace`](#bf-qnamakeralterationsreplace)
21+
* [`bf qnamaker:convert`](#bf-qnamakerconvert)
2122
* [`bf qnamaker:endpointkeys`](#bf-qnamakerendpointkeys)
2223
* [`bf qnamaker:endpointkeys:list`](#bf-qnamakerendpointkeyslist)
2324
* [`bf qnamaker:endpointkeys:refresh`](#bf-qnamakerendpointkeysrefresh)
@@ -38,6 +39,7 @@ This package is intended for Microsoft use only and should be consumed through @
3839
* [`bf qnamaker:operationdetails:get`](#bf-qnamakeroperationdetailsget)
3940
* [`bf qnamaker:query`](#bf-qnamakerquery)
4041
* [`bf qnamaker:train`](#bf-qnamakertrain)
42+
* [`bf qnamaker:translate`](#bf-qnamakertranslate)
4143

4244
## `bf qnamaker`
4345

@@ -106,6 +108,28 @@ OPTIONS
106108

107109
_See code: [src/commands/qnamaker/alterations/replace.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/qnamaker/src/commands/qnamaker/alterations/replace.ts)_
108110

111+
## `bf qnamaker:convert`
112+
113+
Converts .qna file(s) to QnA application JSON models or vice versa.
114+
115+
```
116+
USAGE
117+
$ bf qnamaker:convert
118+
119+
OPTIONS
120+
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
121+
-h, --help qnamaker:convert help
122+
-i, --in=in Source .qna file(s) or QnA KB JSON file
123+
-o, --out=out Output file or folder name. If not specified stdout will be used as output
124+
-r, --recurse Indicates if sub-folders need to be considered to file .qna file(s)
125+
--alterations Indicates if files is QnA Alterations
126+
--log Enables log messages
127+
--name=name Name of the QnA KB
128+
--sort When set, questions collections are alphabetically sorted are alphabetically sorted in .qna files
129+
```
130+
131+
_See code: [src/commands/qnamaker/convert.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/qnamaker/src/commands/qnamaker/convert.ts)_
132+
109133
## `bf qnamaker:endpointkeys`
110134

111135
Commands to refresh and list keys
@@ -301,7 +325,7 @@ USAGE
301325
OPTIONS
302326
-h, --help qnamaker:kb:export command help
303327
--endpoint=endpoint Overrides public endpoint https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/
304-
--environment=environment (required) Specifies whether environment is Test or Prod.
328+
--environment=environment [default: Prod] Specifies whether environment is Test or Prod.
305329
306330
--kbId=kbId Knowledgebase id to be exported. Overrides the knowledge base id present in the
307331
config
@@ -519,8 +543,31 @@ OPTIONS
519543
```
520544

521545
_See code: [src/commands/qnamaker/train.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/qnamaker/src/commands/qnamaker/train.ts)_
546+
547+
## `bf qnamaker:translate`
548+
549+
Translate given QnA maker application JSON model or qna file(s)
550+
551+
```
552+
USAGE
553+
$ bf qnamaker:translate
554+
555+
OPTIONS
556+
-f, --force If --out flag is provided with the path to an existing file, overwrites that file
557+
-h, --help qnamaker:translate help
558+
-i, --in=in Source .qna file(s) or QnA maker application JSON model
559+
-o, --out=out Output folder name. If not specified stdout will be used as output
560+
-r, --recurse Indicates if sub-folders need to be considered to find .qna file(s)
561+
--srclang=srclang Source lang code. Auto detect if missing.
562+
--tgtlang=tgtlang (required) Comma separated list of target languages.
563+
--translate_comments When set, machine translate comments found in .qna file
564+
--translate_link_text When set, machine translate link description in .qna file
565+
--translatekey=translatekey (required) Machine translation endpoint key.
566+
```
567+
568+
_See code: [src/commands/qnamaker/translate.ts](https://github.com/microsoft/botframework-cli/tree/master/packages/qnamaker/src/commands/qnamaker/translate.ts)_
522569
<!-- commandsstop -->
523570

524571
[1]:./docs/qna-file-format.md
525572
[2]:./docs/working-with-qna.md
526-
[3]:./docs/translate-command.md
573+
[3]:./docs/translate-command.md

0 commit comments

Comments
 (0)