From b277d9fd3963e4358b65a2df3db3379e06a45d05 Mon Sep 17 00:00:00 2001 From: Karl-Philipp Wulfert Date: Mon, 3 Dec 2018 15:06:54 +0100 Subject: [PATCH] docs: add workflow documentation to readme --- README.md | 38 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 38 insertions(+) diff --git a/README.md b/README.md index 2fcf65c9..8f7851e2 100755 --- a/README.md +++ b/README.md @@ -2,6 +2,44 @@ This repository contains documentation, project resources and cli tools to manage the `@openstapps` projects. +## Meetings + +We have developer meetings via video conference on at least every first and third wednesday of the month. + +An agenda is generated with the project management tool that contains all issues that have the label `meeting`. + +## Integrating new schools + +### Subgroup in GitLab + +Every school gets their own subgroup on GitLab inside the group `@openstapps`. + +The technical name is the license plate of the school. This can be found in the [list of license plates](resources/license-plates.md). + +The official name of the school is used as the group's name and a matching logo is picked to act as the group's logo - this should be a square one because of the way that GitLab handles/shows logos. + +#### Permissions on the group + +Every school should have one maintainer on the main group. This should be someone that is involved in the development. + +Inside the subgroup every school can decide on its own how to handle permissions. + +### Adjusting common projects + +#### `gitlab-ci.yml` in `@openstapps/backend` + +Every school has their own Docker image for the backend because every school needs other plugins and configuration. This is easily accomplished with a dedicated entry in the [`.gitlab-ci-yml`](https://gitlab.tubit.tu-berlin.de/stapps/backend/blob/develop/.gitlab-ci.yml). + +#### Add namespace for UUID generation + +To be able to generate UUIDs for things that need to be indexed/added to the backend every schools needs a namespace in the [`@openstapps/api`](https://gitlab.com/openstapps/api). This namespace can be any random, valid UUIDv4. + +#### Add subgroup's id to the scripts configuration + +To use the project management tool for the new subgroup, the id of that group needs to be added to the configuration of the tool. + +The groups id can be found in the settings of the group on GitLab. + ## Project management tool This is a small cli tool that helps to maintain the project(s).