Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
Why these changes are being introduced:

Some of the links in the readme are not formatted properly, and we are
missing links to official and local docs.

Relevant ticket(s):

* https://mitlibraries.atlassian.net/browse/ETD-231

How this addresses that need:

This fixes the links and adds links to the docs.

Side effects of this change:

None.
  • Loading branch information
jazairi committed Apr 2, 2021
1 parent c097476 commit 29d936b
Showing 1 changed file with 9 additions and 2 deletions.
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Search Analytics (Matomo)

This repository supports MIT Libraries' implementation of (Matomo)[https://matomo.org/],
This repository supports MIT Libraries' implementation of [Matomo](https://matomo.org/),
which we use to collect discovery analytics. Our implementation uses the Docker
container provided by Matomo. We host the application in AWS Fargate.

Expand All @@ -13,7 +13,7 @@ Run `make build` to create a new container tagged as `analytics-stage:latest`.
Run `make dist` to build, tag, and push a container to staging. To promote to
production, run `make publish`.

Please see the corresponding (Terraform module)[https://github.com/MITLibraries/mitlib-terraform/tree/master/apps/analytics] for deployment config.
Please see the corresponding [Terraform module](https://github.com/MITLibraries/mitlib-terraform/tree/master/apps/analytics) for deployment config.

## URLs

Expand Down Expand Up @@ -76,3 +76,10 @@ permissions level.
Matomo has built-in two-factor authentication, which we enforce for all accounts.
When a user logs in to Matomo for the first time, they will be prompted to
configure 2FA. At this time, we are recommending Duo as an authenticator.

## Additional documentation

* [MIT Libraries dev docs](https://mitlibraries.github.io/guides/misc/matomo.html) - includes
information about setting up a website for tracking in Matomo.
* [Matomo help center](https://matomo.org/help/) - offical Matomo docs.
Includes user guide, developer guide, FAQ, and community support forum.

0 comments on commit 29d936b

Please sign in to comment.