From 95ee2bca71e3c7a7945152d98d74551308f6bff4 Mon Sep 17 00:00:00 2001 From: Andy Stark <30621568+therealandeeee@users.noreply.github.com> Date: Fri, 29 Mar 2019 11:54:07 +0000 Subject: [PATCH] [ADF-4249] Doc review updates (#4524) * [ADF-4249] Edit latest changes to release notes * [ADF-4249] Fixed links --- docs/README.md | 6 +-- docs/core/services/nodes-api.service.md | 6 +-- .../services/task-cloud.service.md | 48 +++++++++---------- docs/release-notes/RelNote300.md | 19 +++++--- docs/release-notes/RelNote310.md | 30 ++++++------ 5 files changed, 57 insertions(+), 52 deletions(-) diff --git a/docs/README.md b/docs/README.md index b0b7efd78f..a772af2d7d 100644 --- a/docs/README.md +++ b/docs/README.md @@ -419,9 +419,9 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Claim Task Directive](process-services-cloud/directives/claim-task.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Claim a task | [Source](../lib/process-services-cloud/src/lib/task/directives/claim-task.directive.ts) | +| [Claim Task Directive](process-services-cloud/directives/claim-task.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Claims a task | [Source](../lib/process-services-cloud/src/lib/task/directives/claim-task.directive.ts) | | [Complete Task Directive](process-services-cloud/directives/complete-task.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Completes a task. | [Source](../lib/process-services-cloud/src/lib/task/directives/complete-task.directive.ts) | -| [Unclaim Task Directive](process-services-cloud/directives/unclaim-task.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Unclaim a task | [Source](../lib/process-services-cloud/src/lib/task/directives/unclaim-task.directive.ts) | +| [Unclaim Task Directive](process-services-cloud/directives/unclaim-task.directive.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Unclaims a task | [Source](../lib/process-services-cloud/src/lib/task/directives/unclaim-task.directive.ts) | ### Pipes @@ -440,7 +440,7 @@ for more information about installing and using the source code. | [Process List Cloud Service](process-services-cloud/services/process-list-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches processes. | [Source](../lib/process-services-cloud/src/lib/process/process-list/services/process-list-cloud.service.ts) | | [Start Process Cloud Service](process-services-cloud/services/start-process-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Gets process definitions and starts processes. | [Source](../lib/process-services-cloud/src/lib/process/start-process/services/start-process-cloud.service.ts) | | [Start Task Cloud Service](process-services-cloud/services/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 Cloud Service](process-services-cloud/services/task-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages task cloud. | [Source](../lib/process-services-cloud/src/lib/task/task-header/services/task-cloud.service.ts) | +| [Task Cloud Service](process-services-cloud/services/task-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Manages task cloud. | [Source](../lib/process-services-cloud/src/lib/task/services/task-cloud.service.ts) | | [Task Filter Cloud Service](process-services-cloud/services/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) | | [Task List Cloud Service](process-services-cloud/services/task-list-cloud.service.md) ![Experimental](docassets/images/ExperimentalIcon.png) | Searches tasks. | [Source](../lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts) | diff --git a/docs/core/services/nodes-api.service.md b/docs/core/services/nodes-api.service.md index 3fd04816a1..7715704909 100644 --- a/docs/core/services/nodes-api.service.md +++ b/docs/core/services/nodes-api.service.md @@ -111,8 +111,8 @@ modification dates, etc. Also, the `id` and `parentId` properties contain the no ID strings for the current node and its enclosing folder. Sometimes, a [`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md) is provided directly, for example, the `folderNode` property -of a [Document List component](../../content-services/document-list.component.md) or the data context of a -[Document List row](../../content-services/document-list.component.md#underlying-node-object). In these cases, +of a [Document List component](../../content-services/components/document-list.component.md) or the data context of a +[Document List row](../../content-services/components/document-list.component.md#underlying-node-object). In these cases, you might pass the `id` or `parentId` as a [route parameter](https://angular.io/guide/router) to a page describing the node in full detail. The component receiving the node ID can use the [Nodes Api service](nodes-api.service.md) to "decode" the ID string into a [`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md): @@ -188,5 +188,5 @@ pages in the Alfresco JS API for further details and options. Note that you can ## See also - [Deleted nodes api service](deleted-nodes-api.service.md) -- [Document list component](../../content-services/document-list.component.md) +- [Document list component](../../content-services/components/document-list.component.md) - [Node service](node.service.md) diff --git a/docs/process-services-cloud/services/task-cloud.service.md b/docs/process-services-cloud/services/task-cloud.service.md index e27229d5c5..23ff3ae9dc 100644 --- a/docs/process-services-cloud/services/task-cloud.service.md +++ b/docs/process-services-cloud/services/task-cloud.service.md @@ -2,10 +2,10 @@ Title: Task Cloud Service Added: v3.1.0 Status: Experimental -Last reviewed: 2019-03-19 +Last reviewed: 2019-03-29 --- -# [Task Cloud Service](../../../lib/process-services-cloud/src/lib/task/task-header/services/task-cloud.service.ts "Defined in task-cloud.service.ts") +# [Task Cloud Service](../../../lib/process-services-cloud/src/lib/task/services/task-cloud.service.ts "Defined in task-cloud.service.ts") Manages task cloud. @@ -13,45 +13,45 @@ Manages task cloud. ### Methods +- **canClaimTask**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)): `boolean`
+ Validate if a task can be claimed. + - _taskDetails:_ [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - task details object + - **Returns** `boolean` - Boolean value if the task can be completed - **canCompleteTask**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)): `boolean`
Validate if a task can be completed. - _taskDetails:_ [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - task details object - **Returns** `boolean` - Boolean value if the task can be completed -- **completeTask**(appName: `string`, taskId: `string`)
- Complete a task - - _appName:_ `string` - Name of the app - - _taskId:_ `string` - ID of the task to complete - - **Returns** [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - Details of the task that was completed -- **canClaimTask**(taskDetails: [`TaskDetailsCloudModel`](../../lib/process-services-cloud/src/lib/task/start-filters/models/task-details-cloud.model.ts))
- Validate if a task can be claimed. - - _taskDetails:_ [`TaskDetailsCloudModel`](../../lib/process-services-cloud/src/lib/task/start-filters/models/task-details-cloud.model.ts) - Task details object - - **Returns** `boolean` - Boolean value if the task can be claimed -- **canUnclaimTask**(taskDetails: [`TaskDetailsCloudModel`](../../lib/process-services-cloud/src/lib/task/start-filters/models/task-details-cloud.model.ts))
+- **canUnclaimTask**(taskDetails: [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)): `boolean`
Validate if a task can be unclaimed. - - _taskDetails:_ [`TaskDetailsCloudModel`](../../lib/process-services-cloud/src/lib/task/start-filters/models/task-details-cloud.model.ts) - Task details object - - **Returns** `boolean` - Boolean value if the task can be unclaimed -- **claimTask**(appName: `string`, taskId: `string`, assignee: `string`): `any`
+ - _taskDetails:_ [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - task details object + - **Returns** `boolean` - Boolean value if the task can be completed +- **claimTask**(appName: `string`, taskId: `string`, assignee: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
Claims a task for an assignee. - _appName:_ `string` - Name of the app - _taskId:_ `string` - ID of the task to claim - _assignee:_ `string` - User to assign the task to - - **Returns** [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - Details of the claimed task -- **unclaimTask**(appName: `string`, taskId: `string`): `any`
- Un-claims a task. + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Details of the claimed task +- **completeTask**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
+ Complete a task. - _appName:_ `string` - Name of the app - - _taskId:_ `string` - ID of the task to unclaim - - **Returns** [`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts) - Details of the task that was unclaimed -- **getTaskById**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
+ - _taskId:_ `string` - ID of the task to complete + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Details of the task that was completed +- **getTaskById**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
Gets details of a task. - _appName:_ `string` - Name of the app - _taskId:_ `string` - ID of the task whose details you want - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Task details -- **updateTask**(appName: `string`, taskId: `string`, updatePayload: `any`): `any`
+ - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Task details +- **unclaimTask**(appName: `string`, taskId: `string`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
+ Un-claims a task. + - _appName:_ `string` - Name of the app + - _taskId:_ `string` - ID of the task to unclaim + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Details of the task that was unclaimed +- **updateTask**(appName: `string`, taskId: `string`, updatePayload: `any`): [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>`
Updates the details (name, description, due date) for a task. - _appName:_ `string` - Name of the app - _taskId:_ `string` - ID of the task to update - _updatePayload:_ `any` - Data to update the task - - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Updated task details + - **Returns** [`Observable`](http://reactivex.io/documentation/observable.html)`<`[`TaskDetailsCloudModel`](../../../lib/process-services-cloud/src/lib/task/start-task/models/task-details-cloud.model.ts)`>` - Updated task details ## Details diff --git a/docs/release-notes/RelNote300.md b/docs/release-notes/RelNote300.md index a581f46a12..3988eabadd 100644 --- a/docs/release-notes/RelNote300.md +++ b/docs/release-notes/RelNote300.md @@ -21,16 +21,21 @@ If you want to be updated on the [ADF roadmap](../roadmap.md), check the public - [Single Sign On enhancement](#single-sign-on-enhancement) - [JS-API in Typescript](#js-api-in-typescript) - [Angular 7](#angular-7) + - [Create library Component](#create-library-component) + - [Tree view component](#tree-view-component) - [Deprecation removal](#deprecation-removal) - - [Activiti 7 support](#activiti-7-support-experimental) - - [Icon Component](#icon-component) + - [Activiti 7 support (Experimental)](#activiti-7-support-experimental) - [Localization](#localization) - [References](#references) + - [Icon Component](#icon-component) - [Issues addressed](#issues-addressed) - [Documentation](#documentation) - [Feature](#feature) + - [Epic](#epic) + - [Story](#story) - [Bug](#bug) - [Task](#task) + - [Feature Documentation](#feature-documentation) - [Feature Bug](#feature-bug) - [Feature (Task)](#feature-task) @@ -121,7 +126,7 @@ This rewrite has been necessary to make the JS-API lighter and faster with the Note that the following old package names have been deprecated: **alfresco-js-api**, **alfresco-js-api-node**. -The Node and Browser version are now both in: **_@alfresco/js-api_** +The [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) and Browser version are now both in: **_@alfresco/js-api_** Refer to the official [Alfresco JS-API documenation](https://github.com/Alfresco/alfresco-js-api) to learn more about this. ### Angular 7 @@ -144,7 +149,7 @@ You can now create a new Content Services document library/site with the Create ![TreeView component screenshot](../docassets/images/tree-view.png) -Shows the folder and subfolders of a node as a tree view. For more information about the Tree View component, see the [component documentation](../content-services/components/tree-view.component.md) +Shows the folder and subfolders of a node as a tree view. For more information about the [Tree View component,](../content-services/components/tree-view.component.md) see the [component documentation](../content-services/components/tree-view.component.md) #### Basic Usage @@ -201,7 +206,7 @@ links to documentation and source code: | [Start process cloud service](../process-services-cloud/services/start-process-cloud.service.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Gets process definitions and starts processes. | [Source](../../lib/process-services-cloud/src/lib/process/start-process/services/start-process-cloud.service.ts) | | [Start task cloud service](../process-services-cloud/services/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](../process-services-cloud/services/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) | -| [Task cloud service](../process-services-cloud/services/task-cloud.service.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Manages cloud tasks. | [Source](../../lib/process-services-cloud/src/lib/task/task-header/services/task-cloud.service.ts) | +| [Task cloud service](../process-services-cloud/services/task-cloud.service.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Manages cloud tasks. | [Source](../../lib/process-services-cloud/src/lib/task/services/task-cloud.service.ts) | | [Task list cloud service](../process-services-cloud/services/task-list-cloud.service.md) ![Experimental](../docassets/images/ExperimentalIcon.png) | Searches tasks. | [Source](../../lib/process-services-cloud/src/lib/task/task-list/services/task-list-cloud.service.ts) | @@ -226,7 +231,7 @@ Please refer to the [official documentation](http://docs.alfresco.com/) for furt ### Icon Component -Universal icon component that supports Material Ligatures and custom registered SVG icons in the same format. +Universal [icon component](../core/components/icon.component.md) that supports Material Ligatures and custom registered SVG icons in the same format. ```html @@ -239,7 +244,7 @@ Universal icon component that supports Material Ligatures and custom registered ``` -See Icon Component [documentation](../core/components/icon.component.md) for more details. +See [Icon Component](../core/components/icon.component.md) [documentation](../core/components/icon.component.md) for more details. ## Issues addressed diff --git a/docs/release-notes/RelNote310.md b/docs/release-notes/RelNote310.md index 2378c166e7..98a8f46875 100644 --- a/docs/release-notes/RelNote310.md +++ b/docs/release-notes/RelNote310.md @@ -75,10 +75,10 @@ In ADF 3.0.0 (released in February) we announced the introduction of the new `*C ``` -Please for more details refer to the : -- [Claim a task](../process-services-cloud/directives/claim-task.directive.md) +For more details refer to the : +- [Claim task directive](../process-services-cloud/directives/claim-task.directive.md) -#### EditTaskComponent allow sorting and actions customization +#### EditTaskComponent allows sorting and actions customization You can supply various _filter properties_ to edit that will determine which tasks are found by a filter. @@ -86,7 +86,7 @@ By default, the **_id_**, **_name_**, **_createdDate_** and **_priority_** prop displayed in the editor. However, you can also choose which sort properties to show using the `sortProperties` array. -Please for more details refer to the : +For more details refer to the : - [Edit Task Filter Cloud component](../process-services-cloud/components/edit-task-filter-cloud.component.md) #### EditProcessComponent allow sorting and actions customization @@ -97,7 +97,7 @@ By default, the **_status_**, **_sort_** and **_order_** properties are displayed in the editor. However, you can also choose which properties to show using the `filterProperties` array. -Please for more details refer to the : +For more details refer to the : - [Edit Process Filter Cloud component](../process-services-cloud/components/edit-process-filter-cloud.component.md) #### Complete task directive @@ -105,7 +105,7 @@ Please for more details refer to the : ```html ``` -Please for more details refer to the : +For more details refer to the : - [Complete task directive](../process-services-cloud/directives/complete-task.directive.md) ### Enhanced DocumentList @@ -130,7 +130,7 @@ First, set the `stickyHeader` property of your datatable to `true`: ``` -Please for more details refer to the : +For more details refer to the : - [Document List Component](../content-services/components/document-list.component.md) - [DataTable component](../core/components/datatable.component.md) @@ -138,7 +138,7 @@ Please for more details refer to the : As of this version of ADF, developers can include the full list of types/aspects into the metadata viewer, without the need to specify all of them. The limit of the previous version was that developers were requested to specify the list of types/aspects or an asterisk to say "include all". The use case represented by "include all except X, Y, Z..." was not covered but now it is. -You can list all the properties by simply adding the `includeAll: boolean` to your config. This config will display all the aspects and properties available for that specific file. +You can list all the properties by simply adding `includeAll: boolean` to your config. This config will display all the aspects and properties available for that specific file. ```json "content-metadata": { @@ -163,7 +163,7 @@ Futhermore, you can also exclude specific aspects by adding the `exclude` proper } ``` -Please for more details refer to the : +For more details refer to the : - [Content Metadata Card component](../content-services/components/content-metadata-card.component.md) ### Search pattern highlight @@ -202,7 +202,7 @@ The example above changes the highlighting prefix and postfix from the default fields except the "description" field, which uses '()' instead. The highlight information will then be added in each node entry response. -Please for more details refer to the : +For more details refer to the : - [Search Filter component highlight](../content-services/components/search-filter.component.md#highlight) @@ -259,14 +259,14 @@ for further details about the structure and properties of `intervals` that you c Each defined `intervals` item is collected into its own collapsible category identified uniquely by its `label`. The code snippet just above will result in the following display of facet intervals: -![Facet Intervals](../../docassets/images/search-facet-intervals.png) +![Facet Intervals](../docassets/images/search-facet-intervals.png) -Please for more details refer to the : -- [Facet intervals](../content-services/components/search-filter.component.md#facet-intervals) +For more details refer to the : +- [Facet intervals section of the Search Filter Component docs](../content-services/components/search-filter.component.md#facet-intervals) ### SSO Role AuthGuard -The [Auth Guard SSO role service](../../core/services/auth-guard-sso-role.service.md) implements an Angular +The [Auth Guard SSO role service](../core/services/auth-guard-sso-role.service.md) implements an Angular [route guard](https://angular.io/guide/router#milestone-5-route-guards) to check the user has the right role permission. This is typically used with the `canActivate` guard check in the route definition. The roles that user needs to have in order to access the route has to be specified in the roles array as in the example below: @@ -284,7 +284,7 @@ const appRoutes: Routes = [ ] ``` -Please for more details refer to the : +For more details refer to the : - [Facet intervals](../core/services/auth-guard-sso-role.service.md) ### Improved accessibility