me/breccia-mapper
1
0
Fork 0
mirror of https://github.com/Southampton-RSG/breccia-mapper.git synced 2026-03-02 19:07:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Add badges and links to docs

Browse Source
This commit is contained in:
Matthew Grove
2023-03-29 12:25:00 +01:00
parent 2f9f35c396
commit 2ebe7777c3
4 changed files with 7 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@@ -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

2
docs/source/1-deployment.md
View File

@@ -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

2
docs/source/2-configuration.md
View File

@@ -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.

4
docs/source/index.md
View File

@@ -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.