1
- # Federated Catalog
1
+ # EDC Federated Catalog
2
+
3
+ [ ![ documentation] ( https://img.shields.io/badge/documentation-8A2BE2?style=flat-square )] ( https://eclipse-edc.github.io )
4
+ [ ![ discord] ( https://img.shields.io/badge/discord-chat-brightgreen.svg?style=flat-square&logo=discord )] ( https://discord.gg/n4sD9qtjMQ )
5
+ [ ![ latest version] ( https://img.shields.io/maven-central/v/org.eclipse.edc/boot?logo=apache-maven&style=flat-square&label=latest%20version )] ( https://search.maven.org/artifact/org.eclipse.edc/boot )
6
+ [ ![ license] ( https://img.shields.io/github/license/eclipse-edc/FederatedCatalog?style=flat-square&logo=apache )] ( https://www.apache.org/licenses/LICENSE-2.0 )
7
+ <br >
8
+ [ ![ build] ( https://img.shields.io/github/actions/workflow/status/eclipse-edc/FederatedCatalog/verify.yaml?branch=main&logo=GitHub&style=flat-square&label=ci )] ( https://github.com/eclipse-edc/FederatedCatalog/actions/workflows/verify.yaml?query=branch%3Amain )
9
+ [ ![ snapshot build] ( https://img.shields.io/github/actions/workflow/status/eclipse-edc/FederatedCatalog/trigger_snapshot.yml?branch=main&logo=GitHub&style=flat-square&label=snapshot-build )] ( https://github.com/eclipse-edc/FederatedCatalog/actions/workflows/trigger_snapshot.yml )
10
+ [ ![ nightly build] ( https://img.shields.io/github/actions/workflow/status/eclipse-edc/Release/nightly.yaml?branch=main&logo=GitHub&style=flat-square&label=nightly-build )] ( https://github.com/eclipse-edc/Release/actions/workflows/nightly.yaml )
11
+
12
+ ---
2
13
3
14
The Federated Catalog (FC) represents the aggregated catalogs of multiple participants in a dataspace. To achieve that,
4
15
the FC employs a set of crawlers, that periodically scrape the dataspace requesting the catalog from each participant in
@@ -13,6 +24,11 @@ handling etc., while adding specific functionality using the EDC extensibility m
13
24
14
25
This repository contains all components needed to build and run a standalone version of the Federated Catalog.
15
26
27
+ ## Documentation
28
+
29
+ Base documentation can be found on the [ documentation website] ( https://eclipse-edc.github.io ) . \
30
+ Developer documentation can be found under [ docs/developer] ( docs/developer/README.md ) .
31
+
16
32
## Quick start
17
33
18
34
A basic launcher configured with in-memory stores (i.e. no persistent storage) can be
@@ -78,16 +94,11 @@ detail [here](docs/developer/architecture/federated-catalog-apis.md).
78
94
- Generalization of the Crawler class
79
95
- Additional informational endpoints to the [ Catalog API] ( docs/developer/architecture/federated-catalog-apis.md )
80
96
81
- ## Other documentation
82
-
83
- Developer documentation can be found under [ docs/developer] ( docs/developer ) , where the main concepts and decisions are
84
- captured as [ decision records] ( docs/developer/decision-records ) .
85
-
86
97
## References
87
98
88
99
- Decentralized Claims Protocol (DCP): https://projects.eclipse.org/projects/technology.dataspace-dcp
89
100
- EDC Connector: https://github.com/eclipse-edc/Connector
90
101
91
102
## Contributing
92
103
93
- See [ how to contribute] ( https://github.com/eclipse-edc/docs /blob/main/CONTRIBUTING.md ) for details .
104
+ See [ how to contribute] ( https://github.com/eclipse-edc/eclipse-edc.github.io /blob/main/CONTRIBUTING.md ) .
0 commit comments