# User guide for CoPED

[Queries on the written documentation](https://hackmd.io/o8yGZXeaTAabrjA8NQnA7g)

# CoPED's website

## Signing up and creating a profile

A profile is required to do the following:
1. Message another user
2. Add, edit, or claim a project on the [CoPED website](https://coped.coventry.ac.uk/)
3. View full data tables or create visualisations on [CoPED's Metabase platform](https://coped.coventry.ac.uk/metabase/).

To create a profile, first go to the [CoPED homepage](https://coped.coventry.ac.uk/).


On the homepage, click the "Sign up" button in the upper right-hand corner. That will redirect you to the [CoPED registration page](https://coped.coventry.ac.uk/accounts/register/).


Enter details here, which includes a username, email address, first name, last name, password, and password confirmation. Click the Captcha tick box to confirm you are human and complete the task on screen. Then click "Submit".

You should then receive an email asking you to confirm your account registration. This link will be valid for 7 days.

## How to use the messaging system

The messaging system can be used to do the following:
1. Send a message to another user or administrator.
2. Request ownership of a project, person, or organization.
3. Request a data change on a project, person, or organization.
4. Request contributor permission.

In the sections below, we will demonstrate the use of this system for sending messages to others, claiming ownership of a project, requesting data changes on an existing project, and requesting permission to contribute.

### Messaging another user or administrator

If you wish to send a message to another user or the administrator, starting from the [CoPED homepage](https://coped.coventry.ac.uk/), click your username in the top right corner. This will open a drop-down menu with multiple options including "Messages".


After clicking the "Messages" option, you will be redirected to your messaging system, shown below. Here you can view unread or read messages and send a new message. There are two separate new message buttons: one to contact another user and one to contact the administrator.


Clicking "New Message" will allow you to send a message to another user, including the administrator "copedadmin". Clicking the "Contact Administrator" button will only allow you to message the administrator. Both button open a similar page, shown below, where you can type your message.


After clicking "Send", the user will be notified of a new message in their inbox.

### Receiving a message

If you receive a message, you will receive a notification next to your username in the top right corner.


If you click your username with the red notification icon, a drop-down menu will appear.


Click "Messages" is access your inbox, shown below.


Here we see one unread message. If you click "View", you are able to read the full message and reply as appropriate.

### Claim ownership of a project

Starting on the [CoPED homepage](https://coped.coventry.ac.uk/), there are two options to view an existing project, as the blue arrows indicate in the image below:
1. Type the name into the "Search for projects" bar, or
2. Click the "Projects" button on the top of the page.


I am searching for the EnergyREV project, the results of this search are shown below.


The third project down is the correct one, so click the blue, linked project title to redirect to the project page. On this page, one of the options under the title is to "Claim Ownership" via the green button, as shown below.


If the "Claim Ownership" button is not appearing, it is possible that someone else has already claimed ownership. Please see the [Contacting a project owner](#contacting-a-project-owner) section for further details.

Clicking the "Claim Ownership" button will redirect you to the messaging system, shown below.


The to user, subject, and content fields are pre-filled with relevant information and text prompts, such as:
1. What is your involvement with the project?
2. Your name and contact details (optional).

This information will help the administrator verify whether ownership should be approved. Once the relevant information is added, click "Send" to send your request to the administrator.

### Contacting a project owner

If a project has already been claimed, you will see a "Contact Owner" button in place of the "Claim Ownership" one, as shown below.


Clicking the "Claim Ownership" button will redirect you to the messaging system, shown below, where you can see the username of the owner.


You are then able to contact the owner by typing your message in the "Content" section and pressing "Send".

### Request a data change to a project

Following the previous example,you may have noticed an error in the description on the EnergyREV project page.


If you notice an error, or want to request another data change, this can be done by clicking the yellow "Request Data Change" button at the top of the page.


Clicking the "Request Data Change" will redirect you to the messaging system. The content field is pre-filled with relevant information and text prompts, such as:
1. What needs to be changed?
2. What is your involvement with the project?


Once the relevant information is added, click "Send" to send your request to the administrator.

### Request contributor permission

You will need contributor permission to add a new project, person, or organisation to CoPED. This request can be done in two ways.

The first way is to go to your profile. From the [CoPED homepage](https://coped.coventry.ac.uk/), click your username in the top right corner. This opens a drop-down menu with the option "Profile" at the top.


Clicking "Profile" redirects you to your profile details, as shown below. Here you can click the yellow button for "Request contributor permissions".


The second way to make this request is through the Projects page. Starting from the [CoPED homepage](https://coped.coventry.ac.uk/), click the "Projects" button in the top menu bar.


Clicking "Projects" will open the page shown below. Here you can click the yellow "Request Permission to Contribute" button.


Both approaches will open the page shown below.


Here you can detail why you are making the request along with your name and details. After this is done, click "Submit" to send your request to the administrator.

## Where can I find out about the data that is in the CoPED database so I can query it later or make a visualisation?

# CoPED's Metabase platform

The CoPED Metabase platform can be accessed either directly at [coped.coventry.ac.uk/metabase/](https://coped.coventry.ac.uk/metabase/) or through the [CoPED homepage](https://coped.coventry.ac.uk/) by clicking the "Data & Analysis" button and selecting "Home" from the dropdown menu.

Please note that a login is required to access to the Metabase platform.


## Adding a project and corresponding information

## Submit an announcement to the platform administrator

## Editing/updating a project

## How to find projects like one you are interested in

# CoPED's Git platform

## Running the code

## Suggesting an issue

## Reporting a bug

## Voting on possible new features

## Submitting code to a branch

# Data and Visualisations

## Downloading data from a table or visualisation

*Insert embedded youtube video here*

A full transcript of the video can be found here: [How do I download the data from a table or visualisation?](https://hackmd.io/@jessb/Bk4sB_GCq)

If you are interested in downloading data from the visualisations on the [CoPED homepage](https://coped.coventry.ac.uk/), put your cursor over the visualisation you are interested in. A cloud button will appear in the top right-hand corner of the visualisation, as shown in the "Project funders" visualisation below.

Click the cloud button to download full results. You will then be given the option of downloading three different file types (csv, xlsx, or json).

If you are interested in dowloading data from the [CoPED Metabse platform](https://coped.coventry.ac.uk/metabase/), you will need to be logged in. From the homepage, we can view all the data tables under 'Base Views'. After selecting the table you are interested in, you will be able to view the data.
In the example below we chose 'Project funds'. To download the data from the table, click the cloud button in the bottom right-hand corner and choose the desired file type.

## Creating a simple visualisation on a single table

To create a simple visualisation from a single table, start on the [CoPED Metabse platform](https://coped.coventry.ac.uk/metabase/)

## Combining tables to visualise linked data

## Creating a complicated visualisation

## Where can I find out about the data that is in the CoPED database so I can query it later or make a visualisation?

## Building a new visualisation from an existing one

## Creating your own dashboard

## Adding filters to make dynamic dashboards

## Adding filters to make searchable tables

## How to share or embed a visualisation or dashboard