From baf010db615789aba0652b12b8130acf3d77a23b Mon Sep 17 00:00:00 2001 From: Denys Vuika Date: Tue, 16 May 2023 17:37:50 +0100 Subject: [PATCH] cleanup ADF readme (#8543) --- BROWSER-SUPPORT.md | 54 -------------------------------------- INTRODUCTION.md | 5 ---- PREREQUISITES.md | 11 -------- README.md | 65 ++++++++++++++++++---------------------------- 4 files changed, 25 insertions(+), 110 deletions(-) delete mode 100644 BROWSER-SUPPORT.md delete mode 100644 INTRODUCTION.md delete mode 100644 PREREQUISITES.md diff --git a/BROWSER-SUPPORT.md b/BROWSER-SUPPORT.md deleted file mode 100644 index 8bd1bc2e3c..0000000000 --- a/BROWSER-SUPPORT.md +++ /dev/null @@ -1,54 +0,0 @@ -# Browser Support - -This page gives a guide to Browser support and polyfills. - -Browser compatibility and support depends on targeted browsers and 3rd party libraries. ADF is based on the following libraries and components: - -- Angular (all ADF components) -- Moment.js (many ADF components) -- PDF.js (`ng2-alfresco-viewer` component) -- Raphael.js (`ng2-alfresco-diagrams`, `ng2-alfresco-analytics`) -- Chart.js (`ng2-alfresco-analytics`) - -## Browser polyfills - -### Angular - -Please refer to the [official guide](https://angular.io/docs/ts/latest/guide/browser-support.html) for Angular browser support. - -ADF (demo shell) imports by default the following set of recommended polyfills: - -- [core-js](https://www.npmjs.com/package/core-js) (ES6 standard support) - -### 3rd party libraries - -Please refer to the following list of [popular polyfills](https://github.com/Modernizr/Modernizr/wiki/HTML5-Cross-Browser-Polyfills) for HTML5 cross-browser compatibility. - -ADF (demo shell) imports by default the following set of recommended polyfills: - -- [intl](https://www.npmjs.com/package/intl), Polyfill the ECMA-402 Intl API (except collation), **IE**/**Safari** -- [pdfjs compatibility](https://www.npmjs.com/package/pdfjs-dist), Portable Document Format (PDF) library that is built with HTML5, **IE** - -## Example - -```html - - - - - - - - - - - - - - - - -``` - -See the [demo shell](demo-shell/index.html) example project for -further information and source code. diff --git a/INTRODUCTION.md b/INTRODUCTION.md deleted file mode 100644 index d29dd16cc6..0000000000 --- a/INTRODUCTION.md +++ /dev/null @@ -1,5 +0,0 @@ -# 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/PREREQUISITES.md b/PREREQUISITES.md deleted file mode 100644 index baa791a39d..0000000000 --- a/PREREQUISITES.md +++ /dev/null @@ -1,11 +0,0 @@ -# Prerequisites for building and running apps with the Alfresco Application Development Framework - -See our tutorial -[Creating your first ADF Application](docs/tutorials/creating-your-first-adf-application.md) -for full details of what you need to install before using ADF. - -If you experience [CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) -issues then you should also read our -[CORS guide](ALFRESCOCORS.md) -to see the full range of solutions available. - \ No newline at end of file diff --git a/README.md b/README.md index 869c4922b6..ad4ef99e67 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,29 @@ # Alfresco Application Development Framework (ADF) -| branch | status | -| --- | --- | -| master | [![git-tag](https://github.com/Alfresco/alfresco-ng2-components/actions/workflows/git-tag.yml/badge.svg)](https://github.com/Alfresco/alfresco-ng2-components/actions/workflows/git-tag.yml) | -| develop | [![cron schedule](https://github.com/Alfresco/alfresco-ng2-components/actions/workflows/cron.yml/badge.svg)](https://github.com/Alfresco/alfresco-ng2-components/actions/workflows/cron.yml)| - -[![Codacy Badge](https://api.codacy.com/project/badge/Grade/d9eb873741da403bb3284778102372e7)](https://www.codacy.com/app/Alfresco/alfresco-ng2-components?utm_source=github.com&utm_medium=referral&utm_content=Alfresco/alfresco-ng2-components&utm_campaign=badger) -[![Join the chat at https://gitter.im/Alfresco/alfresco-ng2-components](https://badges.gitter.im/Alfresco/alfresco-ng2-components.svg)](https://gitter.im/Alfresco/alfresco-ng2-components?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) - -

- - license - -

- yeoman logo -

+To speed up the development, you can use the +[Generator for Yeoman](https://github.com/Alfresco/generator-ng2-alfresco-app). ## Browser Support All components are supported in the following browsers: -|**Browser** |**Version** | -|--- |--- | -|Chrome |Latest | -|Safari (OS X) |9.x | -|Firefox* |Latest | -|Edge |13, 14 | -|Internet Explorer |11 | - -* Due to a [known issue](https://bugzilla.mozilla.org/show_bug.cgi?id=1188880) in Firefox, the Alfresco Upload Component does not currently support folder upload functionality on Firefox. - -See the [Browser Support](BROWSER-SUPPORT.md) article for more details. +|**Browser** |**Version** | +|--- |--- | +| Chrome | Latest | +| Safari | Latest | +| Firefox | Latest | +| Edge | Latest |