Skip to content

Commit

Permalink
creates required initial .md files
Browse files Browse the repository at this point in the history
  • Loading branch information
Sueda Ciftci committed May 22, 2024
1 parent aa0f6ea commit c1572cb
Show file tree
Hide file tree
Showing 6 changed files with 66 additions and 2 deletions.
1 change: 1 addition & 0 deletions containers/cleanair/cleanair_data/docs/codebase.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Codebase
22 changes: 22 additions & 0 deletions containers/cleanair/cleanair_data/docs/contributors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
## Active contributors

| Name | GitHub ID | Email | Admin |
| ------------------ | -----------------------------------------------------| --------------------------- | ------ |
| Sueda Ciftci | [@edasu](https://github.com/edasu) | <[email protected]> | Infrastructure, Software Engineering |
| Oliver Hamelijnck | [@defaultobject](https://github.com/defaultobject) | <[email protected]> | Modelling |
| Patrick O'Hara | [@PatrickOHara](https://github.com/PatrickOHara) | <[email protected]> | Validation, visualisation |

## Alumni contributors

| Name | GitHub ID | Email | Admin |
| ------------------ | -----------------------------------------------------| --------------------------- | ------ |
| James Brandreth | [@jamesbrandreth](https://github.com/jamesbrandreth) | <[email protected]> / <[email protected]> | Infrastructure, Odysseus |
| Oscar Giles | [@OscartGiles](https://github.com/OscartGiles) | <[email protected]> | Infrastructure, Prod Database, Kubernetes Cluster |
| Chance Haycock | [@chancehaycock](https://github.com/chancehaycock) | <[email protected]> | |
| Christy Nakou | [@ChristyNou](https://github.com/ChristyNou) | <[email protected]> | |
| Harry Moss | [@harryjmoss](https://github.com/harryjmoss) | <[email protected]> | |
| David Perez-Suarez | [@dpshelio](https://github.com/dpshelio) | <[email protected]> | |
| James Robinson | [@jemrobinson](https://github.com/jemrobinson) | <[email protected]> | Infrastructure, Prod Database, Kubernetes Cluster |
| Tim Spain | [@timspainUCL](https://github.com/timspainUCL) | <[email protected]> | |
| Edward Thorpe-Woods | [@TeddyTW](https://github.com/TeddyTW) | <[email protected]>| |
| James Walsh | [@dead-water](https://github.com/dead-water) | <[email protected]>| Infrastructure, Odysseus |
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,8 @@ This guide describes how to connect to the PostgreSQL database (DB) hosted by Az
Before starting this guide, please make sure have completed the following tasks:

1. [Installing the cleanair package](installation.md)
2. [Login to Azure CLI](azure.md)

The recommended way of accessing the database is via our cleanair package and the `urbanair` CLI.
The recommended way of accessing the database is via our cleanair package and the `urbanair_db` CLI.

```bash
urbanair_db init production
Expand Down
5 changes: 5 additions & 0 deletions containers/cleanair/cleanair_data/docs/developer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Developer guide

**Make sure you have [installed the packages](installation.md) before following this guide.**

This guide describes all the tools you need for developing & contributing to the codebase of the London Air Quality Project.
15 changes: 15 additions & 0 deletions containers/cleanair/cleanair_data/docs/docker.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# Docker

This guide walks you through how to build, pull, run and push our docker images.
Before starting this guide:

- [Install docker!](https://docs.docker.com/get-docker/)
- Please make sure you are familiar with the [basic docker principles](https://docs.docker.com/get-started/) before starting this guide.

## Contents

- [Our docker images](#our-docker-images)
- [Pulling a docker image](#pulling) from the [Azure container registry](#azure-container-registry).
- [Building a docker image](#building)
- [Running a docker image](#running) including [mounting a secret file](#mounting-a-secrets-file)
- [(Optional) Networks of docker containers](#multi-container-networks)
22 changes: 22 additions & 0 deletions containers/cleanair/gpflow1_models/contributors.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
## Active contributors

| Name | GitHub ID | Email | Admin |
| ------------------ | -----------------------------------------------------| --------------------------- | ------ |
| Sueda Ciftci | [@edasu](https://github.com/edasu) | <[email protected]> | Infrastructure, Software Engineering |
| Oliver Hamelijnck | [@defaultobject](https://github.com/defaultobject) | <[email protected]> | Modelling |
| Patrick O'Hara | [@PatrickOHara](https://github.com/PatrickOHara) | <[email protected]> | Validation, visualisation |

## Alumni contributors

| Name | GitHub ID | Email | Admin |
| ------------------ | -----------------------------------------------------| --------------------------- | ------ |
| James Brandreth | [@jamesbrandreth](https://github.com/jamesbrandreth) | <[email protected]> / <[email protected]> | Infrastructure, Odysseus |
| Oscar Giles | [@OscartGiles](https://github.com/OscartGiles) | <[email protected]> | Infrastructure, Prod Database, Kubernetes Cluster |
| Chance Haycock | [@chancehaycock](https://github.com/chancehaycock) | <[email protected]> | |
| Christy Nakou | [@ChristyNou](https://github.com/ChristyNou) | <[email protected]> | |
| Harry Moss | [@harryjmoss](https://github.com/harryjmoss) | <[email protected]> | |
| David Perez-Suarez | [@dpshelio](https://github.com/dpshelio) | <[email protected]> | |
| James Robinson | [@jemrobinson](https://github.com/jemrobinson) | <[email protected]> | Infrastructure, Prod Database, Kubernetes Cluster |
| Tim Spain | [@timspainUCL](https://github.com/timspainUCL) | <[email protected]> | |
| Edward Thorpe-Woods | [@TeddyTW](https://github.com/TeddyTW) | <[email protected]>| |
| James Walsh | [@dead-water](https://github.com/dead-water) | <[email protected]>| Infrastructure, Odysseus |

0 comments on commit c1572cb

Please sign in to comment.