From e49ba58d65cd41aadecdfc1f3db85803c14de9fc Mon Sep 17 00:00:00 2001 From: Andy Stark <30621568+therealandeeee@users.noreply.github.com> Date: Thu, 14 Mar 2019 11:43:07 +0000 Subject: [PATCH] [ADF-4239] Updated and moved ADF introduction page (#4434) * [ADF-4239] Updated introduction text and moved to docs folder * [ADF-4239] Fixed bad link --- INTRODUCTION.md | 42 +++-------------------------- docs/user-guide/adf-introduction.md | 35 ++++++++++++++++++++++++ 2 files changed, 39 insertions(+), 38 deletions(-) create mode 100644 docs/user-guide/adf-introduction.md diff --git a/INTRODUCTION.md b/INTRODUCTION.md index 8a2cb8bdbe..d29dd16cc6 100644 --- a/INTRODUCTION.md +++ b/INTRODUCTION.md @@ -1,39 +1,5 @@ -# Introduction to the Alfresco Application Development Framework - -The Alfresco Application Development Framework (ADF) is based on the [Angular framework](https://angular.io/). -ADF is provided by Alfresco to make it easy to build custom web applications to manage and view content in the [Alfresco Platform Repository](https://docs.alfresco.com/5.2/concepts/content-repo-about.html). - -As you probably know, there is a general user interface called [Alfresco Share](https://docs.alfresco.com/5.2/concepts/gs-intro.html) available out-of-the-box. -Share is usually used as a quick way of getting started with content management in Alfresco. It gives you access to pretty much all -the features provided by the ACS system and a lot of customers customize it for their specific domain. - -However, there are use cases that Share does not fit very well, such as: - -- Feature-based clients, exposing functionality to perform a specific task(s) -- Role-based clients, exposing functionality based on role -- Clients where the UI layout and style differs significantly from the Share layout and styling -- [Mashup clients](http://whatis.techtarget.com/definition/mash-up) - -This is where ADF comes into play. You can use it to create exactly the user interface -(i.e. web client) that you require. - -The framework consists of several libraries that can be used to form a customized content management application. The available libraries are: - -- [Core](lib/core/README.md) -- [Content Services](lib/content-services/README.md) -- [Process Services](lib/process-services/README.md) -- [Insights](lib/insights/README.md) - - -You can browse documentation for all the components at the -[ADF Component Catalog](https://alfresco.github.io/adf-component-catalog/). - -An overview of the architecture is shown below: - -

- alfresco -

- -Here we can also see that there is an Alfresco JavaScript framework in use that wraps the Alfresco REST API, to make things easier for the client developer. - +# Introduction +See the [introduction page](docs/user-guide/adf-introduction.md) in our +[documentation](docs/README.md) for an overview of ADF along with links +to useful starting points. diff --git a/docs/user-guide/adf-introduction.md b/docs/user-guide/adf-introduction.md new file mode 100644 index 0000000000..382c9bc44e --- /dev/null +++ b/docs/user-guide/adf-introduction.md @@ -0,0 +1,35 @@ +--- +Title: Introduction to ADF +Added: 2019-03-13 +--- + +# Introduction to the Application Development Framework (ADF) + +Alfresco's Application Development Framework (ADF) lets you add your own custom front end to the existing Alfresco services. + +ADF is a set of custom [TypeScript](https://www.typescriptlang.org/) classes based on +the [Angular](https://angular.io/) web application framework. The most important classes +are the **components** that implement interactive UI features. +The components and other classes access information from Alfresco's main backend products, +[Content Services](https://www.alfresco.com/platform/content-services-ecm) and +[Process Services](https://www.alfresco.com/platform/process-services-bpm). +You can combine these classes to produce your own custom web app with the exact styling, +branding, and features that you need. Some examples of where this can be useful are: + +- **Feature based apps** with functionality based around tasks that arise frequently + in your business. +- **Role based apps** where specific types of user have their own feature set, tailor-made + for their role in the business. +- [**Mashups**](https://whatis.techtarget.com/definition/mash-up) where Alfresco services + are integrated with services from other suppliers in the same app. + +## Getting started with ADF + +You can find full instructions for installing ADF and its prerequisites in our +tutorial +[*Creating your first ADF application*](../tutorials/creating-your-first-adf-application.md). +When you have the environment and the scaffold app set up, the other +[tutorials](../tutorials/README.md) then explain how to connect to the backend services +and add custom features to your app. Use the [component reference](../README.md) pages +to learn about component features and the [user guide](../user-guide/README.md) +to learn about specific tasks and topics in depth.