diff --git a/README.md b/README.md index 17ca3b0..dd07ff0 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # BRECcIA Mapper -[![Documentation Status](https://readthedocs.org/projects/breccia/badge/?version=latest)](https://breccia.readthedocs.io/en/latest/?badge=latest) +[![Documentation Status](https://readthedocs.org/projects/breccia/badge/?version=latest)](https://docs.gcrf-breccia.com/en/latest/?badge=latest) BRECcIA Mapper is a web app to collect and explore data about the relationships between researchers and their stakeholders on large-scale, multi-site research projects. This allows researchers to visually represent the relationships between project staff and stakeholders involved in the their project at different points in time. @@ -11,7 +11,7 @@ This work was funded through the "Building REsearch Capacity for sustainable wat ## Deployment This project is written in Python using the popular [Django](https://www.djangoproject.com/) framework. -Deployment is managed using [Ansible](https://www.ansible.com/) and Docker (https://www.docker.com/), see the `deploy/README.md` for details. +Deployment relies on [Docker Compose](https://docs.docker.com/compose) but is possible with various methods. See [the documentation](https://docs.gcrf-breccia.com/en/latest/1-deployment.html) for details. ## Contributors diff --git a/docs/source/1-deployment.md b/docs/source/1-deployment.md index 18cde4d..5e95c9e 100644 --- a/docs/source/1-deployment.md +++ b/docs/source/1-deployment.md @@ -1,6 +1,6 @@ # Deployment -The BRECcIA Network Mapper can be deployed in a variety of ways, most of which utilise Docker. +The [BRECcIA Network Mapper](https://github.com/Southampton-RSG/breccia-mapper) can be deployed in a variety of ways, most of which utilise Docker. Ansible deployment has been tested on RHEL7 and RHEL8. ## Choosing How to Deploy diff --git a/docs/source/2-configuration.md b/docs/source/2-configuration.md index 8c351ad..5f134e7 100644 --- a/docs/source/2-configuration.md +++ b/docs/source/2-configuration.md @@ -1,6 +1,6 @@ # Configuration -After installing the Network Mapper, some configuration must be done in the web interface. You will need to log in with an admin account. +After installing the [BRECcIA Network Mapper](https://github.com/Southampton-RSG/breccia-mapper), some configuration must be done in the web interface. You will need to log in with an admin account. :::{note} Admin dashboard: this is the admin section of the site, accessed by clicking `Admin` in the navigation bar at the top of the screen. diff --git a/docs/source/index.md b/docs/source/index.md index 250f8cf..fd7097b 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -1,6 +1,8 @@ # BRECcIA Network Mapper documentation -The BRECcIA Network Mapper is a web app designed to track and quantify personnel networks & relationships - primarily developed for use in research projects. It is designed for global use across many different organisations involved in a single project, and has been utilised as part of [BRECcIA](https://gcrf-breccia.com) itself. +[![GitHub latest release](https://img.shields.io/github/downloads/Southampton-RSG/breccia-mapper/latest/total?label=Latest%20release)](https://github.com/Southampton-RSG/breccia-mapper/releases/latest) + +The [BRECcIA Network Mapper (view on GitHub)](https://github.com/Southampton-RSG/breccia-mapper) is a web app designed to track and quantify personnel networks & relationships - primarily developed for use in research projects. It is designed for global use across many different organisations involved in a single project, and has been utilised as part of [BRECcIA](https://gcrf-breccia.com) itself. It can be deployed by individuals or organisations, and supports login with username/password, Google, and Microsoft.