inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-24 17:32:15 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ADF-4249] Updates for doc review (#4454)

Browse Source 
* [ADF-4249] Updates for doc review

* [ADF-4249] Clarified text slightly
This commit is contained in:
Andy Stark
2019-03-19 15:35:59 +00:00
committed by Eugenio Romano
parent 34b5c5a1b3
commit 7fe066b068
17 changed files with 123 additions and 75 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/core/components/about.component.md
View File

@@ -2,7 +2,7 @@
Title: About Component
Added: v2.4.0
Status: Experimental
Last reviewed: 2018-11-14
Last reviewed: 2019-03-19
---
# [About Component](../../../lib/core/about/about.component.ts "Defined in about.component.ts")
@@ -10,33 +10,38 @@ Last reviewed: 2018-11-14
Shows a general version and status overview of the installed ADF library.
## Basic Usage
With default input values
```html
<adf-about></adf-about>
```
With custom input values:
```html
<adf-about
githubUrlCommitAlpha="https://githubcom/Alfresco/alfresco-ng2-components/commits/"
githubUrlCommitAlpha="https://github.com/Alfresco/alfresco-ng2-components/commits/"
showExtensions="false"
regexp="^(@alfresco)"
></adf-about>
```
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| githubUrlCommitAlpha | `string` | https://githubcom/Alfresco/alfresco-ng2-components/commits/ | Version of ADF to be used |
| showExtensions | `boolean` | true | Parameter for hide or show extensions block |
| regexp | `string` | ^(@alfresco) | Regular expression for filtering dependencies packages |
| githubUrlCommitAlpha | `string` | | Commit corresponding to the version of ADF to be used. |
| regexp | `string` | "^(@alfresco)" | Regular expression for filtering dependencies packages. |
| showExtensions | `boolean` | true | Toggles showing/hiding of extensions block. |
## Details
Use this component to get a general overview of the version of ADF installed and the status of the [Content service](../services/content.service.md) and [Process service](../../process-services/services/process.service.md).
Note at the moment this component is mostly for internal use and it requires you to:
Note that at the moment this component is mostly for internal use and it requires you to:
- create a version file : `npm list --depth=0 --json=true --prod=true > versions.json`
- provide this version file in the `dist` folder