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

Docusaurus kits #780

Closed
wants to merge 15 commits into from
Closed

Docusaurus kits #780

wants to merge 15 commits into from

Conversation

bcronin90
Copy link

@bcronin90 bcronin90 commented Feb 27, 2023

Add documentation kit for use in Docusaurus.

There is one pain point right now: Significant parts of the docusaurus documentation are similar or identical to existing documentation. If anyone has a smart idea how to de-duplicate this, please tell me.

Brendan Cronin brendan.cronin@mercedes-benz.com, Mercedes-Benz Tech Innovation GmbH, legal info/Impressum

# Business Prerequisites

## BPN

Copy link
Author

Choose a reason for hiding this comment

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

@stephanbcbauer This needs to be added

Choose a reason for hiding this comment

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

@bcronin90 i had a discussion with Daniel Miehle. This is something which should be on another layer. So not in the connectorKit. This file can be deleted

Copy link
Author

Choose a reason for hiding this comment

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

I think it'd be sensible to at least link to this information. If I wanted to set up an EDC right now, I frankly wouldn't know where to get a BPN.


The architecture of the EDC combines various services that are necessary for the above principles:

- An interface to the Identity Provider service, currently IDSA's Dynamic Attribute Provisioning System (DAPS). This central service provides the identity and the corresponding authentication of the participants in the data exchange. (There is no authorization at this point). Decentralized solutions will also be supported in the future.
Copy link
Author

Choose a reason for hiding this comment

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

In the context of EDC, I would call the contract agreement and its policies an authorization. Though the enforcement of these is kind of intransparent. Maybe the others can comment on this?

Choose a reason for hiding this comment

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

In EDC there is access policy (not advertised) and usage policy (advertised), which is codified by a ContractDefinition. The union of those determines if a client can acquire an asset. HTH.

@bcronin90 bcronin90 marked this pull request as ready for review March 2, 2023 08:02
@bcronin90 bcronin90 requested a review from a team March 2, 2023 08:02
Copy link
Contributor

@DominikPinsel DominikPinsel left a comment

Choose a reason for hiding this comment

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

Great PR :) Will merge after the open comments are resolved!

@@ -0,0 +1,42 @@
---
Copy link
Contributor

Choose a reason for hiding this comment

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

Maybe we can document how these files are generated. There is a release documentation started at /docs/release. The idea is to have

  • a checklist of things to do, before releasing a software
  • a how to release the software

So this should be the right place

Choose a reason for hiding this comment

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

@DominikPinsel yes and no :) the problem here…. the files are not generated within our repository. They are created via docusaurus plug-ins.?

https://www.npmjs.com/package/docusaurus-plugin-openapi-docs

Copy link
Author

Choose a reason for hiding this comment

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

I'll document it based on that.

bcronin90 and others added 14 commits March 16, 2023 08:52
Signed-off-by: Brendan Cronin <brendan.cronin@mercedes-benz.com>
Signed-off-by: Brendan Cronin <brendan.cronin@mercedes-benz.com>
Signed-off-by: Brendan Cronin <brendan.cronin@mercedes-benz.com>
Signed-off-by: Brendan Cronin <brendan.cronin@mercedes-benz.com>
Signed-off-by: Brendan Cronin <brendan.cronin@mercedes-benz.com>
Signed-off-by: Brendan Cronin <brendan.cronin@mercedes-benz.com>
Signed-off-by: Brendan Cronin <brendan.cronin@mercedes-benz.com>
Signed-off-by: Brendan Cronin <brendan.cronin@mercedes-benz.com>
Co-authored-by: bcronin90 <90203222+bcronin90@users.noreply.github.com>
Signed-off-by: Brendan Cronin <brendan.cronin@mercedes-benz.com>
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

Signed-off-by: Brendan Cronin <brendan.cronin@mercedes-benz.com>
@bcronin90
Copy link
Author

Now that this repo has been declared dead effective immediately, what should happen to PRs like this? @stefan-ettl

@ndr-brt
Copy link
Contributor

ndr-brt commented Mar 17, 2023

Now that this repo has been declared dead effective immediately, what should happen to PRs like this? @stefan-ettl

You can re-create the PR on https://github.com/catenax-ng/tx-tractusx-edc
I went with git format-patch and git apply and it was pretty smooth

@bcronin90
Copy link
Author

Now that this repo has been declared dead effective immediately, what should happen to PRs like this? @stefan-ettl

You can re-create the PR on https://github.com/catenax-ng/tx-tractusx-edc I went with git format-patch and git apply and it was pretty smooth

Should I be able to push a branch to tractusx-edc? Because I get a 403. Or do I need to rebase a branch from here onto their main and then PR from that?

@ndr-brt
Copy link
Contributor

ndr-brt commented Mar 22, 2023

Now that this repo has been declared dead effective immediately, what should happen to PRs like this? @stefan-ettl

You can re-create the PR on https://github.com/catenax-ng/tx-tractusx-edc I went with git format-patch and git apply and it was pretty smooth

Should I be able to push a branch to tractusx-edc? Because I get a 403. Or do I need to rebase a branch from here onto their main and then PR from that?

the 403 is an unauthorized error so it's not related to the "different history", but yeah, it should be pretty easy to do adding the tx-tractusx-edc as a remote (or adding product-edc to tx-tractusx-edc as a remote) then soft resetting the branch on another branch based on tractusx history.

@florianrusch-zf
Copy link
Contributor

I closed this PR, because we already moved to https://github.com/eclipse-tractusx/tractusx-edc/

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants