[ACA-2157] Fixed structure, markup and links (#904)

* [ACA-2157] Added brief description and updated links

* [ACA-2157] Fixed broken image URL
This commit is contained in:
Andy Stark
2019-01-23 07:45:31 +00:00
committed by Denys Vuika
parent a12c60337d
commit a46e16c28a
26 changed files with 106 additions and 219 deletions

View File

@@ -30,10 +30,8 @@ The Content App provides a proxy configuration for a local development server th
You can find settings in the "proxy.conf.js" file in the project root directory.
<p class="warning">
The proxy settings get automatically applied every time you run the application with the "npm start" script.
**Note:** The proxy settings get automatically applied every time you run the application with the "npm start" script.
You must restart the application every time you change its settings.
</p>
## Running unit tests

View File

@@ -73,10 +73,7 @@ If you run the application from a different server than the Content Services ser
}
```
<p class="warning">
If you run the application as part of Tomcat and not in the root (subfolder), then "baseShareUrl" value should contain full address to the app, for example: "baseShareUrl": "http://{serveraddress}{:port}/{folder}".
</p>
**Note:** If you run the application as part of Tomcat and not in the root (subfolder), then "baseShareUrl" value should contain full address to the app, for example: "baseShareUrl": "http://{serveraddress}{:port}/{folder}".
## Application settings
@@ -149,9 +146,7 @@ By default, the application ships with the following rules already predefined:
}
```
<p class="tip">
You can get more details on the supported rules in the following article: <a href="https://github.com/Alfresco/alfresco-ng2-components/blob/master/docs/core/upload.service.md" target="_blank">Upload Service</a>.
</p>
**Tip:** You can find more details on the supported rules in the ADF [Upload Service](https://www.alfresco.com/abn/adf/docs/core/upload.service/) docs.
### Pagination settings
@@ -175,6 +170,5 @@ You can change the default settings of the pagination that gets applied to all t
You can store any information in the application configuration file, and access it at runtime by using the `AppConfigService` service provided by ADF.
<p class="tip">
Please refer to the <a href="https://github.com/Alfresco/alfresco-ng2-components/blob/master/docs/core/app-config.service.md" target="_blank">AppConfigService</a> documentation to get more details on Application Configuration features and API's available.
</p>
**Tip:** Please refer to the ADF
[App Config Service](https://www.alfresco.com/abn/adf/docs/core/app-config.service/) documentation to get more details on the Application Configuration features and APIs available.

View File

@@ -5,6 +5,7 @@ Title: CORS
# CORS
The Alfresco Content Application comes with the proxy configuration for Angular CLI to address CORS-related issues for development.
Also, the docker images contain Nginx settings needed for CORS when developing and debugging an application locally.
## Chrome Workaround

View File

@@ -4,7 +4,8 @@ Title: Docker
# Docker
The ACA comes with the ACS 6.0 Community Edition preconfigured.
ACA comes with the ACS 6.0 Community Edition preconfigured.
The application runs in two modes:
- Development (runs latest source code, requires building application)
@@ -29,9 +30,7 @@ npm run stop:docker
## Preview Mode
<p class="tip">
With this mode, you do not need building application from source code or installing dependencies.
</p>
**Tip:** With this mode, you do not need building application from source code or installing dependencies.
To run the latest published container go to the `docker-compose` folder and start docker compose from there:

View File

@@ -23,7 +23,7 @@ The default language is English, however the current browser language is taken a
## User-defined language
You can allow users to set custom languages that are saved to their preferences.
The main application menu already has the [ADF Language Menu](https://github.com/Alfresco/alfresco-ng2-components/blob/master/docs/core/language-menu.component.md) component integrated and pre-filled with the supported items.
The main application menu already has the [ADF Language Menu](https://www.alfresco.com/abn/adf/docs/core/language-menu.component/) component integrated and pre-filled with the supported items.
To change the default language set edit the `app.config.json` file and add or remove items:
@@ -80,7 +80,7 @@ You can copy the content over to your newly created file and replace the English
The Content Application automatically bundles your file when the project builds.
You can test your locale by changing the browser language settings and reloading the page.
Optionally, you can extend the [ADF Language Menu](https://github.com/Alfresco/alfresco-ng2-components/blob/master/docs/core/language-menu.component.md) component with the newly added language by updating the `app.config.json` file.
Optionally, you can extend the [ADF Language Menu](https://www.alfresco.com/abn/adf/docs/core/language-menu.component/) component with the newly added language by updating the `app.config.json` file.
## Customizing ADF translations

View File

@@ -54,9 +54,7 @@ Navigation configuration supports array and object like schema. Defining an obje
`label` - represents the visual name of the link. It can be a string or a i18n defined reference.
<p class="danger">
Changing ` "route": { "url": "/..." } ` value will affect the navigation since these are mapped to application routing system.
</p>
**Caution:** Changing ` "route": { "url": "/..." } ` value will affect the navigation since these are mapped to application routing system.
### Custom text (i18n)

View File

@@ -10,9 +10,7 @@ This application uses the latest releases from Alfresco:
- [Alfresco Content Services (6.0)](https://www.alfresco.com/platform/content-services-ecm)
or [Alfresco Community Edition (6.0 - General Release: 201806)](https://www.alfresco.com/products/community/download)
<p class="warning">
You also need <a href="https://nodejs.org/en/" target="_blank">node.js</a> (LTS) installed to build it locally from source code.
</p>
**Note:** You also need [Node.js](https://nodejs.org/en/) (LTS) installed to build it locally from source code.
The latest version of the Alfresco Content platform is required
due to the application using the latest [REST APIs](https://docs.alfresco.com/5.2/pra/1/topics/pra-welcome.html) developments.