inteligr8/alfresco-content-app
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-content-app.git synced 2025-05-12 17:04:46 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ACS-5386] update docs (#3263)

Browse Source
This commit is contained in:
Denys Vuika 2023-06-09 08:25:43 +01:00 committed by GitHub
parent 99d8f84a4b
commit 699499780f
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 37 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@ -11,10 +11,14 @@ Please refer to the public [documentation](https://alfresco-content-app.netlify.
## Compatibility ## Compatibility
| ACA | ACS | Node | ADF | Angular | | ACA | ADF | ACS | Node | Angular |
| --- | --- | --- | --- | --- | | ---- | --- | --- | ---- | ------- |
| 4.1 | 7.4 | 18.x | 6.1.0 | 14.x | | 4.1 | 6.1 | 7.4 | 18.x | 14.x |
| 4.0 | 7.4 | 14.x | 6.0.0 | 14.x | | 4.0 | 6.1 | 7.4 | 14.x | 14.x |
| 3.1 | 5.1 | 7.3 | | |
| 3.0 | 5.0 | 7.3 | | |
> See <https://angular.io/guide/versions> for more details on Angular and Node.js compatibility
## Running ## Running
@ -48,7 +52,6 @@ APP_CONFIG_DOWNLOAD_PROMPT_DELAY=<time>
APP_CONFIG_DOWNLOAD_PROMPT_REMINDER_DELAY=<time> APP_CONFIG_DOWNLOAD_PROMPT_REMINDER_DELAY=<time>
APP_CONFIG_ENABLE_FILE_AUTO_DOWNLOAD=true APP_CONFIG_ENABLE_FILE_AUTO_DOWNLOAD=true
APP_CONFIG_FILE_AUTO_DOWNLOAD_SIZE_THRESHOLD_IN_MB=<file-size> APP_CONFIG_FILE_AUTO_DOWNLOAD_SIZE_THRESHOLD_IN_MB=<file-size>
``` ```
Where `<URL>` is the address of the ACS. Where `<URL>` is the address of the ACS.

46
docs/README.md
View File

@ -38,27 +38,31 @@ The documentation is divided into the following sections:
## Compatibility ## Compatibility
| ACA Version | Built with | Tested on | | ACA | ADF | ACS | Node | Angular |
| ----------- | ---------- | --------- | | ---- | --- | --- | ---- | ------- |
| ACA 3.1.0 | ADF 5.1.0 | ACS 7.3 | | 4.1 | 6.1 | 7.4 | 18.x | 14.x |
| ACA 3.0.0 | ADF 5.0.0 | ACS 7.3 | | 4.0 | 6.1 | 7.4 | 14.x | 14.x |
| ACA 2.4.0 | ADF 4.4.0 | ACS 6.2 | | 3.1 | 5.1 | 7.3 | | |
| ACA 2.3.0 | ADF 4.3.0 | ACS 6.2 | | 3.0 | 5.0 | 7.3 | | |
| ACA 2.2.0 | ADF 4.2.0 | ACS 6.2 | | 2.4 | 4.4 | 6.2 | | |
| ACA 2.1.0 | ADF 4.1.0 | ACS 6.2 | | 2.3 | 4.3 | 6.2 | | |
| ACA 1.12 | ADF 3.9.0 | ACS 6.2 | | 2.2 | 4.2 | 6.2 | | |
| ACA 1.11 | ADF 3.8.0 | ACS 6.2 | | 2.1 | 4.1 | 6.2 | | |
| ACA 1.10 | ADF 3.7.0 | ACS 6.2 | | 1.12 | 3.9 | 6.2 | | |
| ACA 1.9 | ADF 3.6.0 | ACS 6.2 | | 1.11 | 3.8 | 6.2 | | |
| ACA 1.8 | ADF 3.3.0 | ACS 6.1 | | 1.10 | 3.7 | 6.2 | | |
| ACA 1.7 | ADF 3.0.0 | ACS 6.1 | | 1.9 | 3.6 | 6.2 | | |
| ACA 1.6 | ADF 2.6.1 | ACS 6.1 | | 1.8 | 3.3 | 6.1 | | |
| ACA 1.5 | ADF 2.6.0 | ACS 6.0 | | 1.7 | 3.0 | 6.1 | | |
| ACA 1.4 | ADF 2.5.0 | ACS 6.0 | | 1.6 | 2.6 | 6.1 | | |
| ACA 1.3 | ADF 2.4.0 | ACS 6.0 | | 1.5 | 2.6 | 6.0 | | |
| ACA 1.2 | ADF 2.3.0 | ACS 5.2 | | 1.4 | 2.5 | 6.0 | | |
| ACA 1.1 | ADF 2.2.0 | ACS 5.2 | | 1.3 | 2.4 | 6.0 | | |
| ACA 1.0 | ADF 2.0.0 | ACS 5.2 | | 1.2 | 2.3 | 5.2 | | |
| 1.1 | 2.2 | 5.2 | | |
| 1.0 | 2.0 | 5.2 | | |
> See <https://angular.io/guide/versions> for more details on Angular and Node.js compatibility
## Available Features ## Available Features

4
docs/getting-started/building-from-source.md
View File

@ -8,8 +8,8 @@ The Content App is based on [Angular CLI](https://cli.angular.io), and you can u
## Prerequisites for building ## Prerequisites for building
- [Node.js](https://nodejs.org/en/) 14.x - [Node.js](https://nodejs.org/en/) 18.x
- NPM 6.x - NPM 9.x
- (optional) [Angular CLI](https://cli.angular.io/) 14.x or later - (optional) [Angular CLI](https://cli.angular.io/) 14.x or later
> The Angular CLI libraries are already part of the setup. > The Angular CLI libraries are already part of the setup.

3
docs/getting-started/nvm.md
View File

@ -6,13 +6,14 @@ Title: Node Version Manager
Nvm is a version manager for Node.js. You can use it to install and switch to correct Node.js version. Nvm is a version manager for Node.js. You can use it to install and switch to correct Node.js version.
## Installation ## Installation
To install nvm you can run following: To install nvm you can run following:
```sh ```sh
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.2/install.sh | bash curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.2/install.sh | bash
``` ```
for other installation options and troubleshooting instructions please follow [nvm installation docs](https://github.com/nvm-sh/nvm#install--update-script). for other installation options and troubleshooting instructions please follow [nvm installation docs](https://github.com/nvm-sh/nvm#install--update-script).
## Usage ## Usage