From 514bcf713c26d164e2c6017a22123fcfcd5313fd Mon Sep 17 00:00:00 2001 From: Naexon Date: Thu, 16 Mar 2023 14:39:21 +0100 Subject: [PATCH 1/2] Template for the ADRs We adapted an ADR template we found online. Some changes are unique to our template: We are using the date as prefix in the ADR folder for natural ordering. Also, we require a link to the corresponding ADR in deprecated and superseded ADRs. --- docs/adrs/YYYY-MM-DD-template.md | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 docs/adrs/YYYY-MM-DD-template.md diff --git a/docs/adrs/YYYY-MM-DD-template.md b/docs/adrs/YYYY-MM-DD-template.md new file mode 100644 index 0000000..2c75292 --- /dev/null +++ b/docs/adrs/YYYY-MM-DD-template.md @@ -0,0 +1,26 @@ +# Title + +Date: YYYY-MM-DD + +## Status + +What is the status if the ADR? + +Possible options: +* __PROPOSED__ +* __ACCEPTED__ +* __REJECTED__ +* __DEPRECATED__ (include reference to the superseding ADR) +* __SUPERSEDED__ (include reference to the deprecating ADR) + +## Context + +What is the context of this ADR? What is the issue that we are seeing? What is motivating this decision or change? + +## Decision + +What is the change we are proposing? What do we plan on doing to solve the issue? + +## Consequences + +What are the consequences of the change? What will be more difficult? What will be easier? \ No newline at end of file From 52e8a32eda6dd05160c6c99017b0e9606dba81d2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20Hofst=C3=A4tter?= Date: Thu, 16 Mar 2023 17:10:44 +0100 Subject: [PATCH 2/2] public vs private ADR Co-authored-by: Thomas Weber --- .../adrs/2023-03-16-public-vs-private-data.md | 18 +++++++++++++ docs/adrs/2023-03-DD-cicd-solution.md | 26 +++++++++++++++++++ docs/adrs/2023-03-DD-regsitry-solution.md | 26 +++++++++++++++++++ .../2023-03-DD-storage-bucket-solution.md | 26 +++++++++++++++++++ 4 files changed, 96 insertions(+) create mode 100644 docs/adrs/2023-03-16-public-vs-private-data.md create mode 100644 docs/adrs/2023-03-DD-cicd-solution.md create mode 100644 docs/adrs/2023-03-DD-regsitry-solution.md create mode 100644 docs/adrs/2023-03-DD-storage-bucket-solution.md diff --git a/docs/adrs/2023-03-16-public-vs-private-data.md b/docs/adrs/2023-03-16-public-vs-private-data.md new file mode 100644 index 0000000..c58aed6 --- /dev/null +++ b/docs/adrs/2023-03-16-public-vs-private-data.md @@ -0,0 +1,18 @@ +# Decide if source code an data of users can be private. + +Date: 2023-03-16 + +## Status +__PROPOSED__ + +## Context + +The jobs need to access the data and source code of the user in order to create the image and run the task. Private repositories need additional user authentication whereas public ones don't. + +## Decision + +For now we only allow public code repositories and data sources. This means that the code and data of the user is public. This is the easiest way to implement the jobs. We can always change this later. + +## Consequences + +This means that the user has to make the code and data public. This is not a problem for the user, because the user wants to publish the code and data anyway. The user can always make the code and data private later. \ No newline at end of file diff --git a/docs/adrs/2023-03-DD-cicd-solution.md b/docs/adrs/2023-03-DD-cicd-solution.md new file mode 100644 index 0000000..2c75292 --- /dev/null +++ b/docs/adrs/2023-03-DD-cicd-solution.md @@ -0,0 +1,26 @@ +# Title + +Date: YYYY-MM-DD + +## Status + +What is the status if the ADR? + +Possible options: +* __PROPOSED__ +* __ACCEPTED__ +* __REJECTED__ +* __DEPRECATED__ (include reference to the superseding ADR) +* __SUPERSEDED__ (include reference to the deprecating ADR) + +## Context + +What is the context of this ADR? What is the issue that we are seeing? What is motivating this decision or change? + +## Decision + +What is the change we are proposing? What do we plan on doing to solve the issue? + +## Consequences + +What are the consequences of the change? What will be more difficult? What will be easier? \ No newline at end of file diff --git a/docs/adrs/2023-03-DD-regsitry-solution.md b/docs/adrs/2023-03-DD-regsitry-solution.md new file mode 100644 index 0000000..2c75292 --- /dev/null +++ b/docs/adrs/2023-03-DD-regsitry-solution.md @@ -0,0 +1,26 @@ +# Title + +Date: YYYY-MM-DD + +## Status + +What is the status if the ADR? + +Possible options: +* __PROPOSED__ +* __ACCEPTED__ +* __REJECTED__ +* __DEPRECATED__ (include reference to the superseding ADR) +* __SUPERSEDED__ (include reference to the deprecating ADR) + +## Context + +What is the context of this ADR? What is the issue that we are seeing? What is motivating this decision or change? + +## Decision + +What is the change we are proposing? What do we plan on doing to solve the issue? + +## Consequences + +What are the consequences of the change? What will be more difficult? What will be easier? \ No newline at end of file diff --git a/docs/adrs/2023-03-DD-storage-bucket-solution.md b/docs/adrs/2023-03-DD-storage-bucket-solution.md new file mode 100644 index 0000000..2c75292 --- /dev/null +++ b/docs/adrs/2023-03-DD-storage-bucket-solution.md @@ -0,0 +1,26 @@ +# Title + +Date: YYYY-MM-DD + +## Status + +What is the status if the ADR? + +Possible options: +* __PROPOSED__ +* __ACCEPTED__ +* __REJECTED__ +* __DEPRECATED__ (include reference to the superseding ADR) +* __SUPERSEDED__ (include reference to the deprecating ADR) + +## Context + +What is the context of this ADR? What is the issue that we are seeing? What is motivating this decision or change? + +## Decision + +What is the change we are proposing? What do we plan on doing to solve the issue? + +## Consequences + +What are the consequences of the change? What will be more difficult? What will be easier? \ No newline at end of file