From cc4171f6e954474aa88e5efdff35762e97c94ab1 Mon Sep 17 00:00:00 2001 From: Jumpy Squirrel Date: Thu, 17 Oct 2024 16:36:59 +0200 Subject: [PATCH] chore(docs): document components and licenses --- LICENSE | 2 +- README.md | 22 +++++++++++++++++++ .../Chart.yaml | 2 +- .../eurofurence-registration-system/README.md | 22 +++++++++++++++++++ 4 files changed, 46 insertions(+), 2 deletions(-) diff --git a/LICENSE b/LICENSE index 8d12b6c..0a158b4 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2023 Eurofurence e.V. +Copyright (c) 2024 Eurofurence e.V. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 96ae50f..9cfc30f 100644 --- a/README.md +++ b/README.md @@ -7,6 +7,28 @@ A helm chart that can deploy the Eurofurence Registration System. +The Eurofurence Registration System is Open Source software, +all major components are [MIT licensed](https://github.com/eurofurence/reg-helm-chart/blob/main/LICENSE). + +| Component | Description | +|---------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------| +| [Helm Chart](https://github.com/eurofurence/reg-helm-chart) | helm chart used to deploy the registration system | +| | | +| [Attendee Service](https://github.com/eurofurence/reg-attendee-service) | backend micro-service providing a central attendee-related REST API | +| [Auth Service](https://github.com/eurofurence/reg-auth-service) | backend micro-service that bridges registration and the identity provider | +| [Mail Service](https://github.com/eurofurence/reg-mail-service) | backend micro-service for rendering mails based on templates and sending them | +| [Payment Service](https://github.com/eurofurence/reg-payment-service) | backend micro-service for dues and payments booking and accounting | +| [Room Service](https://github.com/eurofurence/reg-payment-service) | backend micro-service for rooms, roomgroups, and hotel booking | +| | | +| [Concardis Adapter](https://github.com/eurofurence/reg-payment-cncrd-adapter) | backend micro-service that interfaces between the registration system and the Paylink API | +| | | +| [Frontend](https://github.com/eurofurence/reg-frontend) and [Component Library](https://github.com/eurofurence/reg-component-library) | Frontend and component library for end user registration | +| [Onsite UI](https://github.com/eurofurence/reg-onsite-ui) | UI used by the onsite registration team | +| [Regsys Classic](https://github.com/eurofurence/reg-regsys-classic) | Admin UI (and what's left of the regsys we used in the years 2001-2019) | + +The Eurofurence Registration System depends on the [Eurofurence Identity Provider](https://github.com/Thiritin/identity), +which is also Open Source software (Apache 2.0). + ## Installation To use, you just need helm in your path. diff --git a/charts/eurofurence-registration-system/Chart.yaml b/charts/eurofurence-registration-system/Chart.yaml index 5c6a221..25887ac 100644 --- a/charts/eurofurence-registration-system/Chart.yaml +++ b/charts/eurofurence-registration-system/Chart.yaml @@ -1,6 +1,6 @@ apiVersion: v2 name: eurofurence-registration-system -version: 0.0.29 +version: 0.0.30 description: A helm chart that can deploy the Eurofurence Registration System. type: application home: https://github.com/eurofurence/reg-helm-chart diff --git a/charts/eurofurence-registration-system/README.md b/charts/eurofurence-registration-system/README.md index e5880e1..ca5537e 100644 --- a/charts/eurofurence-registration-system/README.md +++ b/charts/eurofurence-registration-system/README.md @@ -4,6 +4,28 @@ A helm chart that can deploy the Eurofurence Registration System. +The Eurofurence Registration System is Open Source software, +all major components are [MIT licensed](https://github.com/eurofurence/reg-helm-chart/blob/main/LICENSE). + +| Component | Description | +|---------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------| +| [Helm Chart](https://github.com/eurofurence/reg-helm-chart) | helm chart used to deploy the registration system | +| | | +| [Attendee Service](https://github.com/eurofurence/reg-attendee-service) | backend micro-service providing a central attendee-related REST API | +| [Auth Service](https://github.com/eurofurence/reg-auth-service) | backend micro-service that bridges registration and the identity provider | +| [Mail Service](https://github.com/eurofurence/reg-mail-service) | backend micro-service for rendering mails based on templates and sending them | +| [Payment Service](https://github.com/eurofurence/reg-payment-service) | backend micro-service for dues and payments booking and accounting | +| [Room Service](https://github.com/eurofurence/reg-payment-service) | backend micro-service for rooms, roomgroups, and hotel booking | +| | | +| [Concardis Adapter](https://github.com/eurofurence/reg-payment-cncrd-adapter) | backend micro-service that interfaces between the registration system and the Paylink API | +| | | +| [Frontend](https://github.com/eurofurence/reg-frontend) and [Component Library](https://github.com/eurofurence/reg-component-library) | Frontend and component library for end user registration | +| [Onsite UI](https://github.com/eurofurence/reg-onsite-ui) | UI used by the onsite registration team | +| [Regsys Classic](https://github.com/eurofurence/reg-regsys-classic) | Admin UI (and what's left of the regsys we used in the years 2001-2019) | + +The Eurofurence Registration System depends on the [Eurofurence Identity Provider](https://github.com/Thiritin/identity), +which is also Open Source software (Apache 2.0). + ## Configuration TODO add documentation here.