From fdded836993634c0966048886451bb2060de9142 Mon Sep 17 00:00:00 2001 From: Andy Stark <30621568+therealandeeee@users.noreply.github.com> Date: Thu, 17 Jan 2019 17:22:04 +0000 Subject: [PATCH] [ADF-3745] Added docs for the new pipes (#4178) * [ADF-3745] Added docs for the new pipes * [ADF-3745] Added cont services readme file * [ADF-3745] Added group initial pipe to type name exceptions --- docs/README.md | 4 +-- docs/content-services/README.md | 2 +- .../file-upload-error.pipe.md | 34 +++++++++++++++++++ .../file-uploading-dialog.component.md | 1 + .../upload-button.component.md | 1 + .../upload-drag-area.component.md | 7 ++++ docs/process-services-cloud/README.md | 12 ++++++- .../group-initial.pipe.md | 33 ++++++++++++++++++ tools/doc/doctool.config.json | 1 + 9 files changed, 91 insertions(+), 4 deletions(-) create mode 100644 docs/content-services/file-upload-error.pipe.md create mode 100644 docs/process-services-cloud/group-initial.pipe.md diff --git a/docs/README.md b/docs/README.md index 754a3f2ba2..1c889fb5b6 100644 --- a/docs/README.md +++ b/docs/README.md @@ -283,7 +283,7 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | -| _File upload error pipe_ | _Not currently documented_ | [Source](../lib/content-services/upload/pipes/file-upload-error.pipe.ts) | +| [File upload error pipe](content-services/file-upload-error.pipe.md) | Converts an upload error code to an error message. | [Source](../lib/content-services/upload/pipes/file-upload-error.pipe.ts) | ## Services @@ -399,7 +399,7 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | -| _Group initial pipe_ | _Not currently documented_ | [Source](../lib/process-services-cloud/src/lib/group/pipe/group-initial.pipe.ts) | +| [Group initial pipe](process-services-cloud/group-initial.pipe.md) | Extracts the initial character from a group name. | [Source](../lib/process-services-cloud/src/lib/group/pipe/group-initial.pipe.ts) | ## Services diff --git a/docs/content-services/README.md b/docs/content-services/README.md index c298c25d7e..3297d94001 100644 --- a/docs/content-services/README.md +++ b/docs/content-services/README.md @@ -81,7 +81,7 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | -| _File upload error pipe_ | _Not currently documented_ | [Source](../../lib/content-services/upload/pipes/file-upload-error.pipe.ts) | +| [File upload error pipe](file-upload-error.pipe.md) | Converts an upload error code to an error message. | [Source](../../lib/content-services/upload/pipes/file-upload-error.pipe.ts) | ## Services diff --git a/docs/content-services/file-upload-error.pipe.md b/docs/content-services/file-upload-error.pipe.md new file mode 100644 index 0000000000..6cf0f218b3 --- /dev/null +++ b/docs/content-services/file-upload-error.pipe.md @@ -0,0 +1,34 @@ +--- +Title: File upload error pipe +Added: v3.0.0 +Status: Active +Last reviewed: 2019-01-17 +--- + +# [File upload error pipe](../../lib/content-services/upload/pipes/file-upload-error.pipe.ts "Defined in file-upload-error.pipe.ts") + +Converts an upload error code to an error message. + +## Basic Usage + + + +```HTML +
+ Upload failed: {{ errorCode | adfFileUploadError }} +
+``` + + + +## Details + +The pipe takes an upload error code (eg, from the `error` event of one of the +upload components) and converts it to a human-readable message. The message is +automatically translated to the user's chosen language. + +## See also + +- [File uploading dialog component](../content-services/file-uploading-dialog.component.md) +- [Upload drag area component](../content-services/upload-drag-area.component.md) +- [Upload button component](../content-services/upload-button.component.md) diff --git a/docs/content-services/file-uploading-dialog.component.md b/docs/content-services/file-uploading-dialog.component.md index 6335e7c125..8f7a6a9eb0 100644 --- a/docs/content-services/file-uploading-dialog.component.md +++ b/docs/content-services/file-uploading-dialog.component.md @@ -39,3 +39,4 @@ This component should be used in combination with the - [Upload button component](upload-button.component.md) - [Upload drag area component](upload-drag-area.component.md) +- [File upload error pipe](../content-services/file-upload-error.pipe.md) diff --git a/docs/content-services/upload-button.component.md b/docs/content-services/upload-button.component.md index deb27bab84..2f6216245a 100644 --- a/docs/content-services/upload-button.component.md +++ b/docs/content-services/upload-button.component.md @@ -84,3 +84,4 @@ export class MyComponent { ## See also - [Upload Version Button component](upload-version-button.component.md) +- [File upload error pipe](../content-services/file-upload-error.pipe.md) diff --git a/docs/content-services/upload-drag-area.component.md b/docs/content-services/upload-drag-area.component.md index 630c8e8a55..7bcfa21faf 100644 --- a/docs/content-services/upload-drag-area.component.md +++ b/docs/content-services/upload-drag-area.component.md @@ -19,6 +19,7 @@ Adds a drag and drop area to upload files to ACS. - [Details](#details) - [Intercepting uploads](#intercepting-uploads) - [Example](#example) +- [See also](#see-also) ## Basic Usage @@ -134,3 +135,9 @@ export class MyComponent { The example above shows a confirmation dialog every time a user uploads more than 1 file. This could be either a selection of 2 or more files, or a folder with multiple entries. + +## See also + +- [File uploading dialog component](../content-services/file-uploading-dialog.component.md) +- [Upload button component](../content-services/upload-button.component.md) +- [File upload error pipe](../content-services/file-upload-error.pipe.md) diff --git a/docs/process-services-cloud/README.md b/docs/process-services-cloud/README.md index 4262a0ee1d..07752ca4d8 100644 --- a/docs/process-services-cloud/README.md +++ b/docs/process-services-cloud/README.md @@ -17,16 +17,24 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | | [App list cloud component](app-list-cloud.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Shows all deployed cloud application instances. | [Source](../../lib/process-services-cloud/src/lib/app/components/app-list-cloud.component.ts) | +| [Group cloud component](group-cloud.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Searches Groups. | [Source](../../lib/process-services-cloud/src/lib/group/components/group-cloud.component.ts) | | [Edit process filter cloud component](edit-process-filter-cloud.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Shows Process Filter Details. | [Source](../../lib/process-services-cloud/src/lib/process/process-filters/components/edit-process-filter-cloud.component.ts) | | [Process filters cloud component](process-filters-cloud.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Lists all available process filters and allows to select a filter. | [Source](../../lib/process-services-cloud/src/lib/process/process-filters/components/process-filters-cloud.component.ts) | | [Process list cloud component](process-list-cloud.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Renders a list containing all the process instances matched by the parameters specified. | [Source](../../lib/process-services-cloud/src/lib/process/process-list/components/process-list-cloud.component.ts) | | [Start process cloud component](start-process-cloud.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Starts a process. | [Source](../../lib/process-services-cloud/src/lib/process/start-process/components/start-process-cloud.component.ts) | +| [People cloud component](people-cloud.component.md) | An autosuggest input control that allows single or multiple users to be selected based on the input parameters. | [Source](../../lib/process-services-cloud/src/lib/task/start-task/components/people-cloud/people-cloud.component.ts) | | [Start task cloud component](start-task-cloud.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Creates/starts a new task for the specified app. | [Source](../../lib/process-services-cloud/src/lib/task/start-task/components/start-task-cloud.component.ts) | | [Edit task filter cloud component](edit-task-filter-cloud.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Edits Task Filter Details. | [Source](../../lib/process-services-cloud/src/lib/task/task-filters/components/edit-task-filter-cloud.component.ts) | | [Task filters cloud component](task-filters-cloud.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Shows all available filters. | [Source](../../lib/process-services-cloud/src/lib/task/task-filters/components/task-filters-cloud.component.ts) | +| [Task header cloud component](task-header-cloud.component.md) | Shows all the information related to a task. | [Source](../../lib/process-services-cloud/src/lib/task/task-header/components/task-header-cloud.component.ts) | | [Task list cloud component](task-list-cloud.component.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Renders a list containing all the tasks matched by the parameters specified. | [Source](../../lib/process-services-cloud/src/lib/task/task-list/components/task-list-cloud.component.ts) | | _App details cloud component_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/app/components/app-details-cloud.component.ts) | -| _People cloud component_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/task/start-task/components/people-cloud/people-cloud.component.ts) | + +## Pipes + +| Name | Description | Source link | +| ---- | ----------- | ----------- | +| [Group initial pipe](group-initial.pipe.md) | Extracts the initial character from a group name. | [Source](../../lib/process-services-cloud/src/lib/group/pipe/group-initial.pipe.ts) | ## Services @@ -37,7 +45,9 @@ for more information about installing and using the source code. | [Start task cloud service](start-task-cloud.service.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Starts standalone tasks. | [Source](../../lib/process-services-cloud/src/lib/task/start-task/services/start-task-cloud.service.ts) | | [Task filter cloud service](task-filter-cloud.service.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Manages task filters. | [Source](../../lib/process-services-cloud/src/lib/task/task-filters/services/task-filter-cloud.service.ts) | | _Apps process cloud service_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/app/services/apps-process-cloud.service.ts) | +| _Group cloud service_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/group/services/group-cloud.service.ts) | | _Process list cloud service_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/process/process-list/services/process-list-cloud.service.ts) | +| _Task header cloud service_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/task/task-header/services/task-header-cloud.service.ts) | | _Task list cloud service_ | _Not currently documented_ | [Source](../../lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts) | diff --git a/docs/process-services-cloud/group-initial.pipe.md b/docs/process-services-cloud/group-initial.pipe.md new file mode 100644 index 0000000000..b3a95468b3 --- /dev/null +++ b/docs/process-services-cloud/group-initial.pipe.md @@ -0,0 +1,33 @@ +--- +Title: Group initial pipe +Added: v3.0.0 +Status: Active +Last reviewed: 2019-01-17 +--- + +# [Group initial pipe](../../lib/process-services-cloud/src/lib/group/pipe/group-initial.pipe.ts "Defined in group-initial.pipe.ts") + +Extracts the initial character from a group name. + +## Basic Usage + + + +```HTML +
+ Group: {{ currentGroup | groupNameInitial }} +
+``` + + + +## Details + +This pipe takes a [`GroupModel`](../../lib/process-services-cloud/src/lib/group/models/group.model.ts) +object as its parameter and extracts the initial character from the `name` +property. The initial is a handy way to identify the group in lists and +other situations where there is limited screen space available. + +## See also + +- [Group cloud component](../process-services-cloud/group-cloud.component.md) diff --git a/tools/doc/doctool.config.json b/tools/doc/doctool.config.json index 904f0a427f..1b23cd458c 100644 --- a/tools/doc/doctool.config.json +++ b/tools/doc/doctool.config.json @@ -72,6 +72,7 @@ "document-library.model": "NodePaging", "dynamic.component": "DynamicExtensionComponent", "form-field-validator.interface": "FormFieldValidator", + "group-initial.pipe": "InitialGroupNamePipe", "header.component": "HeaderLayoutComponent", "inherited-button.directive": "InheritPermissionDirective", "library.dialog": "LibraryDialogComponent",