[ACA-1291] Update docs with new features (#325)

docs/doc-list.md

@@ -128,6 +128,14 @@ actions are automatically hidden when the user does not have permission.
             once the delete action has completed the user is notified and can undo the action (which restores the items from the trash).
         </td>
     </tr>
+    <tr>
+        <td>Manage Versions</td>
+        <td>
+            Versions of files can be viewed, uploaded, restored, downloaded and deleted by using the version manager dialog;
+            once each action has completed the list of versions is updated according to the change.
+        </td>
+        <td>Not applicable</td>
+    </tr>
 </tbody>
 </table>
 

docs/file-viewer.md

@@ -9,7 +9,7 @@ The Header & Toolbar section of the viewer contains a number of features that re
 - Close 'X' will return the user to the folder that contains the file.
 - The name and file type icon is shown in the middle.
 - Next and previous buttons will be displayed either side of the file name so that users can navigate to other files in the folder without navigating away from the viewer.
-- Finally, on the right hand side an actions toolbar provides users with the ability to download, favorite, move, copy and delete.
+- Finally, on the right hand side an actions toolbar provides users with the ability to download, favorite, move, copy, delete, manage versions and view info panel.
 
 #### Content (2)
 The File Viewer consists of four separate views that handle displaying the content based on four types of content, covering various [file/mime](https://alfresco.github.io/adf-component-catalog/components/ViewerComponent.html#supported-file-formats) types:

docs/index.html

@@ -24,7 +24,7 @@
                 items: [
                     {
                         title: 'Introduction',
-                        path: 'features',
+                        path: 'features'
                     },
                     {
                         title: 'Application Header',
@@ -41,6 +41,14 @@
                     {
                         title: 'File Viewer',
                         path: 'file-viewer'
+                    },
+                    {
+                        title: 'Info Drawer',
+                        path: 'info-drawer'
+                    },
+                    {
+                        title: 'Version Manager',
+                        path: 'version-manager'
                     }
                 ]
             },

docs/info-drawer.md

@@ -0,0 +1,23 @@
+### Info Drawer
+
+The Info Drawer displays node information in the right sidebar panel. It is created by using the [InfoDrawerComponent](https://alfresco.github.io/adf-component-catalog/components/InfoDrawerComponent.html). This info is available for both folder and file nodes.
+ 
+Currently, there are 2 tabs available: Properties and Versions.
+
+#### Properties tab
+
+The Properties tab displays the node's metadata info by using the [ContentMetadataCardComponent](https://alfresco.github.io/adf-component-catalog/components/ContentMetadataCardComponent.html).
+
+![](images/content-metadata.png)
+
+For more information, please check also the ADF's [ContentMetadataComponent](https://alfresco.github.io/adf-component-catalog/components/ContentMetadataComponent.html).
+
+#### Versions tab
+
+The Versions tab displays info about the node's versions and allows users to [manage versions](/version-manager), according to their permissions. Only the file nodes have version data available.
+
+![](images/version-manager-tab.png)
+
+It uses the [VersionManagerComponent](https://alfresco.github.io/adf-component-catalog/components/VersionManagerComponent.html) from ADF framework.
+
+Managing versions of a file can be possible also by accessing the 'Manage Versions' option from the 'More actions' menu. For more info on manage versions, please check the [version manager](/version-manager) page.

docs/version-manager.md

@@ -0,0 +1,33 @@
+## Version Manager
+
+The versions of a file can be viewed & managed by using the [VersionManagerComponent](https://alfresco.github.io/adf-component-catalog/components/VersionManagerComponent.html).
+
+There are 2 ways users can access the Version Manager:
+
+1. From the 'Manage Versions' option of the 'More actions' menu (check [Actions and the Actions Toolbar](/doc-list?id=actions-and-the-actions-toolbar)):
+![](images/version-manager-action.png)
+![](images/version-manager-dialog.png)
+
+2. From the [Info Drawer](/info-drawer) (the Details right panel):
+![](images/version-manager-tab.png)
+
+### Upload new version
+
+A new version for the selected file can be added by using this button. There is a restriction currently to only upload files of the same extension as the old version. The new version file will be automatically renamed to have the same name as the old version has. Please also check the [UploadVersionButtonComponent](https://alfresco.github.io/adf-component-catalog/components/UploadVersionButtonComponent.html). 
+
+### Actions Menu
+
+Each item in the version list has a couple of actions available: Restore, Download and Delete. These are displayed if user has permission to do that specific action. The 'Download' and 'Delete' can be also disabled from the app.config.
+
+In the app.config.json file, these are the current settings for the ACA version manager:
+```
+   "adf-version-manager": {
+       "allowComments": true,
+       "allowDownload": true,
+       "allowDelete": true
+   },
+    ...
+```
+Set the allowComments to false if the version comments should not be displayed on the version list.
+
+Clicking to delete a version of a file triggers a confirmation dialog. Please see the [ConfirmDialogComponent](https://alfresco.github.io/adf-component-catalog/components/ConfirmDialogComponent.html) for more info.