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-4878] Refactor, Split ADF About component (#5064)

Browse Source 
* Refactor, Split ADF About component

* [ADF-4878] Add documentation

* [ADF-4878] Rename Component

* [ADF-4878] Implement comments

* [ADF-4878] Update documentation for about components
This commit is contained in:
arditdomi
2019-09-12 15:02:28 +01:00
committed by Eugenio Romano
parent d90497a3f8
commit c2c883885e
18 changed files with 404 additions and 245 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
docs/core/components/about-application-modules.md Normal file
View File

@@ -0,0 +1,40 @@
---
Title: About Application Modules Component
Added: v1.0.0
Status: Experimental
Last reviewed: 2019-09-09
---
# [About Application Modules Component](../../../lib/core/about/about-application-modules/about-application-modules.component.ts "Defined in about-application-modules.component.ts")
Shows which ADF libraries and plugins an application is using.
## Basic Usage
With default input values:
```html
<adf-about-application-modules></adf-about-application-modules>
```
With custom input values:
```html
<adf-about-application-modules
[dependencies]="yourDependencies"
[showExtensions]="true"
[regexp]="^(@alfresco)">
</adf-about-application-modules>
```
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| dependencies | `any` | | The dependencies value defined in the package.json |
| showExtensions | `boolean` | true | Toggles showing/hiding of extensions block. |
| regexp | `string` | "^(@alfresco)" | Regular expression for filtering dependencies packages. |
## Details
Use this component to display an overview of the dependencies and plugins used by an application.

39
docs/core/components/about-github-link.md Normal file
View File

@@ -0,0 +1,39 @@
---
Title: About GitHub Link Component
Added: v1.0.0
Status: Experimental
Last reviewed: 2019-09-09
---
# [About GitHub Link Component](../../../lib/core/about/about-github-link/about-github-link.component.ts "Defined in about-github-link.component.ts")
Shows which version of the application is running based on the latest GitHub commit, as well as the server settings for the application.
## Basic Usage
With default input values:
```html
<adf-about-github-link></adf-about-github-link>
```
With custom input values:
```html
<adf-about-github-link
[url]=yourUrl"
[version]="yourVersion">
</adf-about-github-link>
```
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| url | `string` | | The GitHub commit that corresponds to the version of ADF in use. |
| version | `string` | "3.x.x" | A number displaying the version of ADF in use. |
## Details
Use this component to display an overview of the latest GitHub commit and the server settings used by an application.

22
docs/core/components/about-product-version.component.md Normal file
View File

@@ -0,0 +1,22 @@
---
Title: About Product Version Component
Added: v1.0.0
Status: Experimental
Last reviewed: 2019-09-09
---
# [About Product Version Component](../../../lib/core/about/about-product-version/about-product-version.component.ts "Defined in about-product-version.component.ts")
Shows which version of Process Services (BPM) and Content Services (ECM) an application is running. It also shows the relevant license information, application status and Alfresco modules running in an application.
## Basic Usage
With default input values:
```html
<adf-about-product-version></adf-about-product-version>
```
## Details
Use this component to display an overview of which version of Process Services and Content Services an application is running as well as the associated license information. It also displays application status and any modules running.

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

@@ -1,47 +0,0 @@
---
Title: About Component
Added: v2.4.0
Status: Experimental
Last reviewed: 2019-03-19
---
# [About Component](../../../lib/core/about/about.component.ts "Defined in about.component.ts")
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://github.com/Alfresco/alfresco-ng2-components/commits/"
showExtensions="false"
regexp="^(@alfresco)"
></adf-about>
```
## Class members
### Properties
| Name | Type | Default value | Description |
| ---- | ---- | ------------- | ----------- |
| 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 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