From 24a7c939e60f4859e08674a2ebe2d07e43e7fada Mon Sep 17 00:00:00 2001 From: Andy Stark <30621568+therealandeeee@users.noreply.github.com> Date: Tue, 15 Jan 2019 15:12:53 +0000 Subject: [PATCH] [ADF-3745] Doc review updates (#4165) * [ADF-3745] Doc review * [ADF-3745] Minor fix to task attach list docs --- docs/content-services/rating.component.md | 1 + docs/process-services/apps-list.component.md | 2 +- .../create-process-attachment.component.md | 3 ++- docs/process-services/create-task-attachment.component.md | 3 ++- docs/process-services/people-list.component.md | 8 +++----- .../process-services/process-attachment-list.component.md | 4 ++-- docs/process-services/process-audit.directive.md | 3 ++- .../process-services/process-instance-header.component.md | 2 +- docs/process-services/select-apps-dialog.component.md | 1 + docs/process-services/start-process.component.md | 2 +- docs/process-services/start-task.component.md | 4 ++-- docs/process-services/task-attachment-list.component.md | 8 +++++--- docs/process-services/task-audit.directive.md | 1 + docs/process-services/task-header.component.md | 2 +- 14 files changed, 25 insertions(+), 19 deletions(-) diff --git a/docs/content-services/rating.component.md b/docs/content-services/rating.component.md index 7afa78a22c..0889bff32b 100644 --- a/docs/content-services/rating.component.md +++ b/docs/content-services/rating.component.md @@ -2,6 +2,7 @@ Title: Rating component Added: v2.0.0 Status: Active +Last reviewed: 2019-01-14 --- # [Rating component](../../lib/content-services/social/rating.component.ts "Defined in rating.component.ts") diff --git a/docs/process-services/apps-list.component.md b/docs/process-services/apps-list.component.md index b26105e60b..a4722021dd 100644 --- a/docs/process-services/apps-list.component.md +++ b/docs/process-services/apps-list.component.md @@ -2,7 +2,7 @@ Title: Apps List Component Added: v2.0.0 Status: Active -Last reviewed: 2018-06-08 +Last reviewed: 2019-01-14 --- # [Apps List Component](../../lib/process-services/app-list/apps-list.component.ts "Defined in apps-list.component.ts") diff --git a/docs/process-services/create-process-attachment.component.md b/docs/process-services/create-process-attachment.component.md index 5e1f7c221f..d07906f0bb 100644 --- a/docs/process-services/create-process-attachment.component.md +++ b/docs/process-services/create-process-attachment.component.md @@ -2,11 +2,12 @@ Title: Create Process Attachment component Added: v2.0.0 Status: Active +Last reviewed: 2019-01-14 --- # [Create Process Attachment component](../../lib/process-services/attachment/create-process-attachment.component.ts "Defined in create-process-attachment.component.ts") -Displays Upload Component (Drag and Click) to upload the attachment to a specified process instance +Displays an Upload Component (Drag and Click) to upload the attachment to a specified process instance. ![process-create-attachment](../docassets/images/process-create-attachment.png) diff --git a/docs/process-services/create-task-attachment.component.md b/docs/process-services/create-task-attachment.component.md index fe6959ee34..08e5ad4ae0 100644 --- a/docs/process-services/create-task-attachment.component.md +++ b/docs/process-services/create-task-attachment.component.md @@ -2,11 +2,12 @@ Title: Create Task Attachment Component Added: v2.0.0 Status: Active +Last reviewed: 2019-01-14 --- # [Create Task Attachment Component](../../lib/process-services/attachment/create-task-attachment.component.ts "Defined in create-task-attachment.component.ts") -Displays Upload Component (Drag and Click) to upload the attachment to a specified task +Displays an Upload Component (Drag and Click) to upload the attachment to a specified task. ![task-create-attachment](../docassets/images/task-create-attachment.png) diff --git a/docs/process-services/people-list.component.md b/docs/process-services/people-list.component.md index f066b06ad5..5b3d54f54e 100644 --- a/docs/process-services/people-list.component.md +++ b/docs/process-services/people-list.component.md @@ -2,7 +2,7 @@ Title: People list component Added: v2.0.0 Status: Active -Last reviewed: 2018-11-14 +Last reviewed: 2019-01-14 --- # [People list component](../../lib/process-services/people/components/people-list/people-list.component.ts "Defined in people-list.component.ts") @@ -44,7 +44,8 @@ export class SomeComponent implements OnInit { } ``` -In the component template use the [people list component](../process-services/people-list.component.md): +You can use column templates with the [people list component](../process-services/people-list.component.md), since it is based on the +[Datatable component](../core/datatable.component.md): @@ -71,9 +72,6 @@ In the component template use the [people list component](../process-services/pe -Note that the [people list component](../process-services/people-list.component.md) is based on the -[Datatable component](../core/datatable.component.md). - ## Class members ### Properties diff --git a/docs/process-services/process-attachment-list.component.md b/docs/process-services/process-attachment-list.component.md index d479c4b8ac..da8814bcaf 100644 --- a/docs/process-services/process-attachment-list.component.md +++ b/docs/process-services/process-attachment-list.component.md @@ -2,12 +2,12 @@ Title: Process Attachment List component Added: v2.0.0 Status: Active -Last reviewed: 2018-03-21 +Last reviewed: 2019-01-14 --- # [Process Attachment List component](../../lib/process-services/attachment/process-attachment-list.component.ts "Defined in process-attachment-list.component.ts") -Displays attached documents on a specified process instance +Displays documents attached to a specified process instance. ![process-attachment-list-sample](../docassets/images/process-attachment-list.png) diff --git a/docs/process-services/process-audit.directive.md b/docs/process-services/process-audit.directive.md index c8a38845ad..e531028726 100644 --- a/docs/process-services/process-audit.directive.md +++ b/docs/process-services/process-audit.directive.md @@ -2,11 +2,12 @@ Title: Process Audit Directive Added: v2.0.0 Status: Active +Last reviewed: 2019-01-14 --- # [Process Audit Directive](../../lib/process-services/process-list/components/process-audit.directive.ts "Defined in process-audit.directive.ts") -Fetches the Process Audit information the PDF or JSON format. +Fetches the Process Audit information in PDF or JSON format. ![adf-process-audit-directive](../docassets/images/adf-process-audit-directive.png) diff --git a/docs/process-services/process-instance-header.component.md b/docs/process-services/process-instance-header.component.md index 1ef3d18036..1ff061e3c5 100644 --- a/docs/process-services/process-instance-header.component.md +++ b/docs/process-services/process-instance-header.component.md @@ -2,7 +2,7 @@ Title: Process Instance Details Header component Added: v2.0.0 Status: Active -Last reviewed: 2018-06-08 +Last reviewed: 2019-01-14 --- # [Process Instance Details Header component](../../lib/process-services/process-list/components/process-instance-header.component.ts "Defined in process-instance-header.component.ts") diff --git a/docs/process-services/select-apps-dialog.component.md b/docs/process-services/select-apps-dialog.component.md index a8067aec5c..ebf656fc86 100644 --- a/docs/process-services/select-apps-dialog.component.md +++ b/docs/process-services/select-apps-dialog.component.md @@ -2,6 +2,7 @@ Title: Select App Component Added: v2.0.0 Status: Active +Last reviewed: 2019-01-14 --- # [Select App Component](../../lib/process-services/app-list/select-apps-dialog-component.ts "Defined in select-apps-dialog-component.ts") diff --git a/docs/process-services/start-process.component.md b/docs/process-services/start-process.component.md index 7b747708b2..160e786bd6 100644 --- a/docs/process-services/start-process.component.md +++ b/docs/process-services/start-process.component.md @@ -2,7 +2,7 @@ Title: Start Process component Added: v2.0.0 Status: Active -Last reviewed: 2018-11-13 +Last reviewed: 2019-01-14 --- # [Start Process component](../../lib/process-services/process-list/components/start-process.component.ts "Defined in start-process.component.ts") diff --git a/docs/process-services/start-task.component.md b/docs/process-services/start-task.component.md index d186900b6f..1096455253 100644 --- a/docs/process-services/start-task.component.md +++ b/docs/process-services/start-task.component.md @@ -2,12 +2,12 @@ Title: Start Task Component Added: v2.0.0 Status: Active -Last reviewed: 2018-11-13 +Last reviewed: 2019-01-14 --- # [Start Task Component](../../process-services/task-list/components/start-task.component.ts "Defined in start-task.component.ts") -Creates/Starts a new task for the specified app +Creates/Starts a new task for the specified app. ![adf-start-task](../docassets/images/adf-start-task.png) diff --git a/docs/process-services/task-attachment-list.component.md b/docs/process-services/task-attachment-list.component.md index e67605e3f8..bcbad71bd2 100644 --- a/docs/process-services/task-attachment-list.component.md +++ b/docs/process-services/task-attachment-list.component.md @@ -2,12 +2,12 @@ Title: Task Attachment List Component Added: v2.0.0 Status: Active -Last reviewed: 2018-03-13 +Last reviewed: 2019-01-14 --- # [Task Attachment List Component](../../lib/process-services/attachment/task-attachment-list.component.ts "Defined in task-attachment-list.component.ts") -Displays attached documents on a specified task. +Displays documents attached to a specified task. ![task-attachment-list-sample](../docassets/images/task-attachment-list.png) @@ -103,4 +103,6 @@ export class MyCustomTaskAttachmentComponent { } ``` -[Upload Drag Area Component](../content-services/upload-drag-area.component.md) +## See also + +- [Upload Drag Area Component](../content-services/upload-drag-area.component.md) diff --git a/docs/process-services/task-audit.directive.md b/docs/process-services/task-audit.directive.md index f2942e7d27..391327cc72 100644 --- a/docs/process-services/task-audit.directive.md +++ b/docs/process-services/task-audit.directive.md @@ -2,6 +2,7 @@ Title: Task Audit Directive Added: v2.0.0 Status: Active +Last reviewed: 2019-01-14 --- # [Task Audit Directive](../../lib/process-services/task-list/components/task-audit.directive.ts "Defined in task-audit.directive.ts") diff --git a/docs/process-services/task-header.component.md b/docs/process-services/task-header.component.md index 99551106d2..d8fdcfae32 100644 --- a/docs/process-services/task-header.component.md +++ b/docs/process-services/task-header.component.md @@ -2,7 +2,7 @@ Title: Task Header component Added: v2.0.0 Status: Active -Last reviewed: 2018-11-13 +Last reviewed: 2019-01-14 --- # [Task Header component](../../lib/process-services/task-list/components/task-header.component.ts "Defined in task-header.component.ts")