From c1572cb310062dfdb64ac7eefc79f09f44204321 Mon Sep 17 00:00:00 2001 From: Sueda Ciftci Date: Wed, 22 May 2024 16:40:37 +0100 Subject: [PATCH] creates required initial .md files --- .../cleanair/cleanair_data/docs/codebase.md | 1 + .../cleanair_data/docs/contributors.md | 22 +++++++++++++++++++ .../cleanair_data/docs/database_connection.md | 3 +-- .../cleanair/cleanair_data/docs/developer.md | 5 +++++ .../cleanair/cleanair_data/docs/docker.md | 15 +++++++++++++ .../cleanair/gpflow1_models/contributors.md | 22 +++++++++++++++++++ 6 files changed, 66 insertions(+), 2 deletions(-) create mode 100644 containers/cleanair/cleanair_data/docs/codebase.md create mode 100644 containers/cleanair/cleanair_data/docs/contributors.md create mode 100644 containers/cleanair/cleanair_data/docs/developer.md create mode 100644 containers/cleanair/cleanair_data/docs/docker.md create mode 100644 containers/cleanair/gpflow1_models/contributors.md diff --git a/containers/cleanair/cleanair_data/docs/codebase.md b/containers/cleanair/cleanair_data/docs/codebase.md new file mode 100644 index 000000000..4d435e652 --- /dev/null +++ b/containers/cleanair/cleanair_data/docs/codebase.md @@ -0,0 +1 @@ +# Codebase diff --git a/containers/cleanair/cleanair_data/docs/contributors.md b/containers/cleanair/cleanair_data/docs/contributors.md new file mode 100644 index 000000000..529bbeb52 --- /dev/null +++ b/containers/cleanair/cleanair_data/docs/contributors.md @@ -0,0 +1,22 @@ +## Active contributors + +| Name | GitHub ID | Email | Admin | +| ------------------ | -----------------------------------------------------| --------------------------- | ------ | +| Sueda Ciftci | [@edasu](https://github.com/edasu) | | Infrastructure, Software Engineering | +| Oliver Hamelijnck | [@defaultobject](https://github.com/defaultobject) | | Modelling | +| Patrick O'Hara | [@PatrickOHara](https://github.com/PatrickOHara) | | Validation, visualisation | + +## Alumni contributors + +| Name | GitHub ID | Email | Admin | +| ------------------ | -----------------------------------------------------| --------------------------- | ------ | +| James Brandreth | [@jamesbrandreth](https://github.com/jamesbrandreth) | / | Infrastructure, Odysseus | +| Oscar Giles | [@OscartGiles](https://github.com/OscartGiles) | | Infrastructure, Prod Database, Kubernetes Cluster | +| Chance Haycock | [@chancehaycock](https://github.com/chancehaycock) | | | +| Christy Nakou | [@ChristyNou](https://github.com/ChristyNou) | | | +| Harry Moss | [@harryjmoss](https://github.com/harryjmoss) | | | +| David Perez-Suarez | [@dpshelio](https://github.com/dpshelio) | | | +| James Robinson | [@jemrobinson](https://github.com/jemrobinson) | | Infrastructure, Prod Database, Kubernetes Cluster | +| Tim Spain | [@timspainUCL](https://github.com/timspainUCL) | | | +| Edward Thorpe-Woods | [@TeddyTW](https://github.com/TeddyTW) | | | +| James Walsh | [@dead-water](https://github.com/dead-water) | | Infrastructure, Odysseus | diff --git a/containers/cleanair/cleanair_data/docs/database_connection.md b/containers/cleanair/cleanair_data/docs/database_connection.md index 41e4fd6ee..665eadf3a 100644 --- a/containers/cleanair/cleanair_data/docs/database_connection.md +++ b/containers/cleanair/cleanair_data/docs/database_connection.md @@ -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 diff --git a/containers/cleanair/cleanair_data/docs/developer.md b/containers/cleanair/cleanair_data/docs/developer.md new file mode 100644 index 000000000..958358cb5 --- /dev/null +++ b/containers/cleanair/cleanair_data/docs/developer.md @@ -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. diff --git a/containers/cleanair/cleanair_data/docs/docker.md b/containers/cleanair/cleanair_data/docs/docker.md new file mode 100644 index 000000000..bb37ec928 --- /dev/null +++ b/containers/cleanair/cleanair_data/docs/docker.md @@ -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) diff --git a/containers/cleanair/gpflow1_models/contributors.md b/containers/cleanair/gpflow1_models/contributors.md new file mode 100644 index 000000000..529bbeb52 --- /dev/null +++ b/containers/cleanair/gpflow1_models/contributors.md @@ -0,0 +1,22 @@ +## Active contributors + +| Name | GitHub ID | Email | Admin | +| ------------------ | -----------------------------------------------------| --------------------------- | ------ | +| Sueda Ciftci | [@edasu](https://github.com/edasu) | | Infrastructure, Software Engineering | +| Oliver Hamelijnck | [@defaultobject](https://github.com/defaultobject) | | Modelling | +| Patrick O'Hara | [@PatrickOHara](https://github.com/PatrickOHara) | | Validation, visualisation | + +## Alumni contributors + +| Name | GitHub ID | Email | Admin | +| ------------------ | -----------------------------------------------------| --------------------------- | ------ | +| James Brandreth | [@jamesbrandreth](https://github.com/jamesbrandreth) | / | Infrastructure, Odysseus | +| Oscar Giles | [@OscartGiles](https://github.com/OscartGiles) | | Infrastructure, Prod Database, Kubernetes Cluster | +| Chance Haycock | [@chancehaycock](https://github.com/chancehaycock) | | | +| Christy Nakou | [@ChristyNou](https://github.com/ChristyNou) | | | +| Harry Moss | [@harryjmoss](https://github.com/harryjmoss) | | | +| David Perez-Suarez | [@dpshelio](https://github.com/dpshelio) | | | +| James Robinson | [@jemrobinson](https://github.com/jemrobinson) | | Infrastructure, Prod Database, Kubernetes Cluster | +| Tim Spain | [@timspainUCL](https://github.com/timspainUCL) | | | +| Edward Thorpe-Woods | [@TeddyTW](https://github.com/TeddyTW) | | | +| James Walsh | [@dead-water](https://github.com/dead-water) | | Infrastructure, Odysseus |