mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
Review documentation plus some tools fix (#5100)
* review 3.5.0 doc * fix documentation * fix documentation * fix documentation
This commit is contained in:
39
docs/core/components/about-github-link.component.md
Normal file
39
docs/core/components/about-github-link.component.md
Normal file
@@ -0,0 +1,39 @@
|
||||
---
|
||||
Title: About GitHub Link Component
|
||||
Added: v3.5.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.
|
Reference in New Issue
Block a user