This repository has been archived by the owner on Sep 19, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: add decision record about template repo (#194)
- Loading branch information
1 parent
74b1238
commit e80af3c
Showing
1 changed file
with
22 additions
and
0 deletions.
There are no files selected for viewing
22 changes: 22 additions & 0 deletions
22
developer/decision-records/2024-08-16-new-template-repo/README.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
# Creation of a template repository for EDC adoption projects | ||
|
||
## Decision | ||
|
||
The EDC project will provide a _template repository_ for easy adoption. This template will show how to build an EDC runtime, using Hashicorp Vault and PostgreSQL persistence. It will also contain an exemplary custom extension. | ||
|
||
## Rationale | ||
|
||
With the large number of modules the EDC project publishes, creating a custom launcher or app that uses them correctly | ||
may seem like a daunting task at times. | ||
To make it easier for adopters to get started, we'll provide a [GitHub Template Repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/creating-a-template-repository). | ||
|
||
## Approach | ||
|
||
The template repository will contain: | ||
- a launcher, based on Hashicorp Vault and PostgreSQL | ||
- minimal configuration | ||
- a get-started guide | ||
- some basic CI/CD workflows | ||
- an exemplary custom extension | ||
|
||
_For this, we will re-purpose the [Template-Basic](https://github.com/eclipse-edc/Template-Basic) repository that we already have, and that didn't really get used so far. |