Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feat: Update management-domains Federated Catalog documentation. #1530

Open
wants to merge 6 commits into
base: main
Choose a base branch
from

Conversation

bmg13
Copy link

@bmg13 bmg13 commented Sep 3, 2024

WHAT

Suggestion update for Federated Catalog usage documentation.

WHY

To keep Federated Catalog documentation up-to-date.

FURTHER NOTES

Still in draft since is part of a larger Federated Catalog changes that are still to be aligned.

Management Deployments Documentation was based in this one https://github.com/eclipse-edc/Connector/blob/main/docs/developer/management-domains/management-domains.md#type-2c-catalog-servercontrol-plane-with-data-plane-runtime

Related with
eclipse-tractusx/sig-release#736
#1585

@bmg13 bmg13 marked this pull request as ready for review September 4, 2024 11:22

![type 2b](https://github.com/eclipse-edc/Connector/blob/main/docs/developer/management-domains/distributed.type2.b.svg)
### Deployment Topologies
Copy link
Contributor

@paullatzelsperger paullatzelsperger Sep 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think there is much value in copy-pasting documentation content that is already present in the upstream repo. In particular image material might be copyrighted there, so I'm not sure we even could legally copy it without attribution.

Instead, I would document how to set up a catalog server, i.e. which assets must be added there, how the resulting federated catalog looks like (flattened vs hierarchical), etc.

Copy link
Contributor

This pull request is stale because it has been open for 7 days with no activity.

@github-actions github-actions bot added stale and removed stale labels Sep 19, 2024
Copy link

sonarcloud bot commented Sep 26, 2024

@ndr-brt ndr-brt self-requested a review September 27, 2024 06:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Open
Development

Successfully merging this pull request may close these issues.

2 participants