Skip to content

Commit cccd8ba

Browse files
committed
fix web docs mainly
1 parent 6784ab7 commit cccd8ba

File tree

5 files changed

+17
-17
lines changed

5 files changed

+17
-17
lines changed

lib/interface/cli/commands/trigger/create.cmd.js

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,20 +8,20 @@ const command = new Command({
88
aliases: ['t'],
99
parent: createRoot,
1010
cliDocs: {
11-
description: 'Add pipeline/s to the existing or new trigger (will be created automatically)',
11+
description: 'Set pipeline(s) trigger: connect the `trigger-event` to the pipeline(s). *Note:* `trigger-event` exists only if there is at least one connected pipeline.',
1212
},
1313
webDocs: {
14-
category: 'Trigger',
15-
title: 'add specified pipeline/s to the existing or new trigger',
14+
category: 'Triggers',
15+
title: 'Set Pipeline Trigger',
1616
},
1717
builder: (yargs) => {
1818
return yargs
1919
.positional('event-uri', {
20-
describe: 'trigger event URI (as defined by trigger type/kind)',
20+
describe: '`trigger-event` URI (as defined by trigger `type[/kind]`)',
2121
require: true,
2222
})
2323
.positional('pipeline', {
24-
describe: 'pipeline(s) to be triggered by specified trigger event',
24+
describe: 'pipeline(s) to be triggered by the specified `trigger-event`',
2525
require: true,
2626
});
2727
},

lib/interface/cli/commands/trigger/delete.cmd.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ const command = new Command({
1010
aliases: ['t'],
1111
parent: deleteRoot,
1212
cliDocs: {
13-
description: 'Remove trigger from specified pipeline, this may also remove trigger event w/out pipelines too.',
13+
description: 'Remove pipeline trigger. *Note:* this may also remove `trigger-event` definition, if there are no pipelines left, that are connected to it.',
1414
},
1515
webDocs: {
1616
category: 'Triggers',
17-
title: 'Remove trigger from specified pipeline',
17+
title: 'Remove Pipeline Trigger',
1818
},
1919
builder: (yargs) => {
2020
return yargs
2121
.positional('event-uri', {
22-
describe: 'trigger event URI',
22+
describe: '`trigger-event` URI (as defined by trigger `type[/kind]`)',
2323
required: true,
2424
})
2525
.positional('pipeline', {

lib/interface/cli/commands/trigger/event/get.cmd.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,16 +10,16 @@ const command = new Command({
1010
aliases: ['te', 'event'],
1111
parent: getRoot,
1212
cliDocs: {
13-
description: 'Get detailed information about specified trigger event',
13+
description: 'Get detailed information about specified `trigger-event`',
1414
},
1515
webDocs: {
1616
category: 'Triggers',
17-
title: 'Get detailed information about trigger event',
17+
title: 'Get Trigger Event',
1818
},
1919
builder: (yargs) => {
2020
return yargs
2121
.positional('event-uri', {
22-
describe: 'trigger event uri (as defined by trigger type/kind)',
22+
describe: '`trigger-event` uri (as defined by trigger `type[/kind]`)',
2323
require: true,
2424
});
2525
},

lib/interface/cli/commands/trigger/get.cmd.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ const command = new Command({
1010
aliases: ['t'],
1111
parent: getRoot,
1212
cliDocs: {
13-
description: 'Get triggers connected to the specified pipeline',
13+
description: 'Get pipeline triggers',
1414
},
1515
webDocs: {
1616
category: 'Triggers',
17-
title: 'Get triggers connected to the specified pipeline',
17+
title: 'Get Pipeline Triggers',
1818
},
1919
builder: (yargs) => {
2020
return yargs

lib/interface/cli/commands/trigger/type/get.cmd.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,19 @@ const command = new Command({
1010
aliases: ['tt'],
1111
parent: getRoot,
1212
cliDocs: {
13-
description: 'Get list of trigger types or individual trigger installed in Codefresh environment',
13+
description: 'Get a list of system-wide available `trigger-types` or specified `trigger-type`',
1414
},
1515
webDocs: {
1616
category: 'Triggers',
17-
title: 'Get available trigger type/s',
17+
title: 'Get Trigger Types',
1818
},
1919
builder: (yargs) => {
2020
return yargs
2121
.positional('type', {
22-
describe: '[optional] trigger type (e.g. registry, cron)',
22+
describe: '`trigger-type` type name (e.g. `registry`, `cron`)',
2323
})
2424
.positional('kind', {
25-
describe: '[optional] trigger kind (e.g. dockerhub, cfcr, gcr, acr)',
25+
describe: '`trigger-type` kind (e.g. `dockerhub`, `cfcr`, `gcr`, `acr`); only some `trigger-types` may have kinds',
2626
});
2727
},
2828
handler: async (argv) => {

0 commit comments

Comments
 (0)