diff --git a/README.md b/README.md index a241f72910..466e736de2 100644 --- a/README.md +++ b/README.md @@ -239,6 +239,7 @@ dspace-angular ├── config * Folder for configuration files │   ├── environment.default.js * Default configuration files │   └── environment.test.js * Test configuration files +├── docs * Folder for documentation ├── e2e * Folder for e2e test files │   ├── app.e2e-spec.ts * │   ├── app.po.ts * @@ -380,6 +381,11 @@ This project makes use of [`yarn`](https://yarnpkg.com/en/) to ensure that the e As you can see above, using `yarn` commandline tools means that you should never need to modify the `package.json` manually. *We recommend always using `yarn` to keep dependencies updated / in sync.* +Further Documentation +--------------------- + +See [`./docs`](docs) for further documentation. + Frequently asked questions -------------------------- diff --git a/docs/Configuration.md b/docs/Configuration.md new file mode 100644 index 0000000000..30dc5e2e88 --- /dev/null +++ b/docs/Configuration.md @@ -0,0 +1,10 @@ +# Configuration + +## Supporting analytics services other than Google Analytics +This project makes use of [Angulartics](https://angulartics.github.io/angulartics2/) to track usage events and send them to Google Analytics. + +Angulartics can be configured to work with a number of other services besides Google Analytics as well, e.g. [Piwik](https://github.com/angulartics/angulartics2/tree/master/src/lib/providers/piwik), [Google Tag Manager](https://github.com/angulartics/angulartics2/tree/master/src/lib/providers/gtm), or [Azure Application Insights](https://azure.microsoft.com/en-us/services/application-insights/) to name a few. + +In order to start using one of these services, select it from the [Angulartics Providers page](https://angulartics.github.io/angulartics2/#providers), and follow the instructions on how to configure it. + +The google analytics script was added in [`main.browser.ts`](https://github.com/DSpace/dspace-angular/blob/ff04760f4af91ac3e7add5e7424a46cb2439e874/src/main.browser.ts#L33) instead of the `` tag in `index.html` to ensure events get sent when the page is shown in a client's browser, and not when it's rendered on the universal server. Likely you'll want to do the same when adding a new service. \ No newline at end of file