feat(ui): on action - add url to official doc (#3809)

close #672

Signed-off-by: Yvonnick Esnault <[email protected]>

contrib/grpcplugins/action/kafka-publish/kafka-publish.yml

@@ -7,6 +7,8 @@ description: |
   You are able to send a custom "message" file and all the artifacts you want: there is no file size limit. To improve security, you can encrypt the files content with a GPG Key. From the consumer side, you will need to decrypt files content with you GPG private key and your passphrase.
 
   This action is a CDS Plugin packaged as a single binary file you can download and use to listen and consume data coming from CDS through Kafka. CDS can also wait for an acknowledgement coming from the consumer side. To send the acknowledgement, you can again use the plugin binary. For more details, see readme file of the plugin.
+
+  How to use: https://github.com/ovh/cds/tree/master/contrib/grpcplugins/action/kafka-publish
 parameters:
   message:
     type: text

contrib/grpcplugins/action/kafka-publish/main.go

@@ -38,7 +38,10 @@ func (actPlugin *kafkaPublishActionPlugin) Manifest(ctx context.Context, _ *empt
 
 		You are able to send a custom "message" file and all the artifacts you want: there is no file size limit. To improve security, you can encrypt the files content with a GPG Key. From the consumer side, you will need to decrypt files content with you GPG private key and your passphrase.
 	  
-		This action is a CDS Plugin packaged as a single binary file you can download and use to listen and consume data coming from CDS through Kafka. CDS can also wait for an acknowledgement coming from the consumer side. To send the acknowledgement, you can again use the plugin binary. For more details, see readme file of the plugin.`,
+		This action is a CDS Plugin packaged as a single binary file you can download and use to listen and consume data coming from CDS through Kafka. CDS can also wait for an acknowledgement coming from the consumer side. To send the acknowledgement, you can again use the plugin binary. For more details, see readme file of the plugin.
+		
+		How to use: https://github.com/ovh/cds/tree/master/contrib/grpcplugins/action/kafka-publish
+		`,
 		Version: sdk.VERSION,
 	}, nil
 }

docs/content/workflows/pipelines/actions/builtin/deployapplication.md

@@ -0,0 +1,27 @@
++++
+title = "DeployApplication"
+chapter = true
+
++++
+
+**DeployApplication** is a builtin action, you can't modify it.
+
+This action is useful only if you have a Deployment Plaftorm associated to your current application.
+
+### Example
+
+* Add a deployment platform on your application.
+
+![img](/images/workflows.pipelines.actions.builtin.deploy-application-1.png)
+
+* Create a workflow, add a pipeline and an application linked to a platform.
+
+![img](/images/workflows.pipelines.actions.builtin.deploy-application-2.png)
+
+* Or edit the pipeline context from your workflow view.
+
+![img](/images/workflows.pipelines.actions.builtin.deploy-application-3.png)
+
+* In the job, use action DeployApplication
+
+![img](/images/workflows.pipelines.actions.builtin.deploy-application-4.png)

docs/content/workflows/pipelines/actions/plugins/plugin-archive.md

@@ -12,8 +12,4 @@ This is a plugin to compress or uncompress an archive. Supported formats: .zip,
 * **action**: "compress" or "uncompress" an archive
 
 
-## More
-
-More documentation on [Github](https://github.com/ovh/cds/tree/master/contrib/grpcplugins/action/archive/README.md)
-
 

docs/content/workflows/pipelines/actions/plugins/plugin-clair.md

@@ -10,8 +10,4 @@ This is a plugin to run clair analysis
 * **image**: Image to analyze
 
 
-## More
-
-More documentation on [Github](https://github.com/ovh/cds/tree/master/contrib/grpcplugins/action/clair/README.md)
-
 

docs/content/workflows/pipelines/actions/plugins/plugin-download.md

@@ -12,8 +12,4 @@ This is a plugin to download file from URL
 * **headers**: Specific headers to add to your request ("headerName"="value" newline separated list)
 
 
-## More
-
-More documentation on [Github](https://github.com/ovh/cds/tree/master/contrib/grpcplugins/action/download/README.md)
-
 

docs/content/workflows/pipelines/actions/plugins/plugin-group-tmpl.md

@@ -15,8 +15,4 @@ Check documentation on text/template for more information https://golang.org/pkg
 * **applications**: Applications file variables
 
 
-## More
-
-More documentation on [Github](https://github.com/ovh/cds/tree/master/contrib/grpcplugins/action/group-tmpl/README.md)
-
 

docs/content/workflows/pipelines/actions/plugins/plugin-kafka-publish.md

@@ -12,22 +12,18 @@ This action is a CDS Plugin packaged as a single binary file you can download an
 
 ## Parameters
 
+* **kafkaPassword**: Kafka password
+* **kafkaAddresses**: Kafka Addresses
 * **topic**: Kafka Topic
 * **artifacts**: Artifacts list (comma separated)"
-* **publicKey**: GPG Public Key (ASCII armored format)
 * **key**: Key used by AES Encryption. It have to be the same value as --key on plugin binary
-* **waitForAck**: Wait for ACK
-* **waitForAckTimeout**: Ack timeout (seconds). Used only if "waitForAck" is true.
-* **kafkaAddresses**: Kafka Addresses
 * **kafkaUser**: Kafka user
-* **kafkaPassword**: Kafka password
 * **kafkaGroup**: Kafka Consumer Group (used for acknowledgment)
+* **publicKey**: GPG Public Key (ASCII armored format)
+* **waitForAck**: Wait for ACK
 * **waitForAckTopic**: Wait for ACK topic
+* **waitForAckTimeout**: Ack timeout (seconds). Used only if "waitForAck" is true.
 * **message**: Kafka Message
 
 
-## More
-
-More documentation on [Github](https://github.com/ovh/cds/tree/master/contrib/grpcplugins/action/kafka-publish/README.md)
-
 

docs/content/workflows/pipelines/actions/plugins/plugin-marathon.md

@@ -10,8 +10,6 @@ Your marathon.json file can be templated with cds variables "{{.cds.variables}}"
 
 ## Parameters
 
-* **url**: Marathon URL http://127.0.0.1:8081,http://127.0.0.1:8082,http://127.0.0.1:8083
-* **user**: Marathon User (please use project, application or environment variables)
 * **password**: Marathon Password (please use project, application or environment variables)
 * **configuration**: Marathon application configuration file (json format)
 * **waitForDeployment**: Wait for instances deployment.
@@ -20,10 +18,8 @@ If not set, CDS will consider a successful result if marathon accepts the provid
 
 * **insecureSkipVerify**: Skip SSL Verify if you want to use self-signed certificate
 * **timeout**: Marathon deployment timeout (seconds). Used only if "waitForDeployment" is true.
+* **url**: Marathon URL http://127.0.0.1:8081,http://127.0.0.1:8082,http://127.0.0.1:8083
+* **user**: Marathon User (please use project, application or environment variables)
 
 
-## More
-
-More documentation on [Github](https://github.com/ovh/cds/tree/master/contrib/grpcplugins/action/marathon/README.md)
-
 

docs/content/workflows/pipelines/actions/plugins/plugin-npm-audit-parser.md

@@ -10,8 +10,4 @@ This is a plugin to parse npm audit report
 * **file**: Path to audit file (generally generated by npm audit --json >{{.cds.workspace}}/audit.json for example)
 
 
-## More
-
-More documentation on [Github](https://github.com/ovh/cds/tree/master/contrib/grpcplugins/action/npm-audit-parser/README.md)
-
 

docs/content/workflows/pipelines/actions/plugins/plugin-ssh-cmd.md

@@ -15,8 +15,4 @@ This plugin helps you to run cmd on remote server over ssh.
 * **commandTimeout**: Command Timeout (seconds)
 
 
-## More
-
-More documentation on [Github](https://github.com/ovh/cds/tree/master/contrib/grpcplugins/action/ssh-cmd/README.md)
-
 

docs/content/workflows/pipelines/actions/plugins/plugin-tmpl.md

@@ -15,8 +15,4 @@ Check documentation on text/template for more information https://golang.org/pkg
 * **params**: Parameters to pass on the template file (key=value newline separated list)
 
 
-## More
-
-More documentation on [Github](https://github.com/ovh/cds/tree/master/contrib/grpcplugins/action/tmpl/README.md)
-
 

docs/content/workflows/pipelines/actions/plugins/plugin-venom.md

@@ -10,17 +10,13 @@ Add an extra step of type junit on your job to view tests results on CDS UI.
 
 ## Parameters
 
+* **vars-from-file**: filename.yaml or filename.json. See https://github.com/ovh/venom#run-venom-with-file-var
+* **path**: Path containers yml venom files. Format: adirectory/, ./*aTest.yml, ./foo/b*/**/z*.yml
 * **exclude**: Exclude some files, one file per line
 * **output**: Directory where output xunit result file
 * **parallel**: Launch Test Suites in parallel. Enter here number of routines
 * **loglevel**: Log Level: debug, info, warn or error
 * **vars**: Empty: all {{.cds...}} vars will be rewrited. Otherwise, you can limit rewrite to some variables. Example, enter cds.app.yourvar,cds.build.foo,myvar=foo to rewrite {{.cds.app.yourvar}}, {{.cds.build.foo}} and {{.foo}}. Default: Empty
-* **vars-from-file**: filename.yaml or filename.json. See https://github.com/ovh/venom#run-venom-with-file-var
-* **path**: Path containers yml venom files. Format: adirectory/, ./*aTest.yml, ./foo/b*/**/z*.yml
-
-
-## More
 
-More documentation on [Github](https://github.com/ovh/cds/tree/master/contrib/grpcplugins/action/venom/README.md)
 
 

ui/src/app/shared/action/step/step.html

@@ -16,9 +16,12 @@
                 {{step.step_name}}
                 <i class="stepname" *ngIf="step.step_name !== step.name">({{step.name}})</i>
             </span>
-            <a class="inline pointing ml5" (click)="editStepName = true" *ngIf="!editStepName">
+            <a class="inline pointing ml5" title="{{ 'step_edit_title' | translate }}" (click)="editStepName = true" *ngIf="!editStepName">
                 <i class="pencil icon float"></i>
             </a>
+            <a class="inline pointing ml5" title="{{ 'common_documentation' | translate }}" [routerLink]="['/settings/action', step.name]">
+                <i class="book icon float"></i>
+            </a>
         </div>
         <div class="{{edit ? 'four' : 'eight'}} wide inline field">
             <span class="pointing" (click)="collapsed = !collapsed">

ui/src/app/views/settings/action/edit/action.edit.component.ts

@@ -19,6 +19,7 @@ import { ToastService } from '../../../../shared/toast/ToastService';
 @AutoUnsubscribe()
 export class ActionEditComponent implements OnInit {
     action: Action;
+    actionDoc: string;
     isAdmin: boolean;
     pipelinesUsingAction: Array<PipelineUsingAction>;
     path: Array<PathItem>;
@@ -39,6 +40,7 @@ export class ActionEditComponent implements OnInit {
         this.paramsSub = this._route.params.subscribe(params => {
             this._actionService.getAction(params['name']).subscribe(u => {
                 this.action = u;
+                this.actionDoc = u.name.toLowerCase().replace(' ', '-');
                 if (this.isAdmin) {
                     this._actionService.getPipelinesUsingAction(params['name']).pipe(first()).subscribe(p => {
                         this.pipelinesUsingAction = p;

ui/src/app/views/settings/action/edit/action.edit.html

@@ -6,6 +6,8 @@
             <div id="ActionEdit">
                 <div class="ui info message" *ngIf="action.type === 'Builtin'">
                     {{ 'action_edit_builtin' | translate }}
+                    <a class="item" href="https://ovh.github.io/cds/workflows/pipelines/actions/builtin/{{actionDoc}}">
+                        <i class="book icon"></i> {{ 'common_documentation' | translate }} {{action.name}}</a>
                 </div>
                 <div class="ui info message" *ngIf="action.type === 'Plugin'">
                     {{ 'action_edit_plugin' | translate }}

ui/src/assets/i18n/en.json

@@ -24,7 +24,7 @@
   "action_deleted": "Action deleted",
   "action_edit_title": "Edit action",
   "action_name": "Action name",
-  "action_edit_builtin": "It's a Builtin action, you can not modify it",
+  "action_edit_builtin": "It's a Builtin action, you can not modify it.",
   "action_edit_plugin": "It's a Plugin action, you can not modify it without re-import it",
   "action_none": "No action",
   "action_saved": "Action saved",
@@ -773,6 +773,7 @@
   "step_nonfinal_no": "There is no step.",
   "step_updated": "Step updated",
   "step_title_duration": "Start: {{start}}, End: {{end}}",
+  "step_edit_title": "Edit title",
 
   "timeline_loading": "Loading timeline...",
   "timeline_no": "Timeline is empty",

ui/src/assets/i18n/fr.json

@@ -24,7 +24,7 @@
   "action_deleted": "Action supprimée",
   "action_edit_title": "Édition de l'action",
   "action_name": "Nom de l'action",
-  "action_edit_builtin": "C'est une action de type Builtin, vous ne pouvez pas la modifier",
+  "action_edit_builtin": "C'est une action de type Builtin, vous ne pouvez pas la modifier.",
   "action_edit_plugin": "C'est une action de type Plugin, vous ne pouvez pas la modifier sans la ré-importer",
   "action_none": "Aucune action",
   "action_saved": "Action sauvegardée",
@@ -773,6 +773,7 @@
   "step_nonfinal_no": "Il n'y a aucune étape.",
   "step_updated": "Etape mise à jour",
   "step_title_duration": "Début: {{start}}, Fin: {{end}}",
+  "step_edit_title": "Éditer le titre",
 
   "timeline_loading": "Chargement du fil d'actualité...",
   "timeline_no": "Le fil d'actualité est vide",