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

chore(products/repositories): adapt/update whole list of products/repositories #968

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

Conversation

stephanbcbauer
Copy link
Member

@stephanbcbauer stephanbcbauer commented Jul 7, 2024

Description

The main purpose for this PR is to update our product list. It's old and not up to date. The initial idea was to publish all our active products in this list. Since we are always asking about the responsible committer for each repository, I tried to update the list for each repository depending on the committers' contribution to the repository.

What is needed in this PR @eclipse-tractusx/automotive-tractusx-committers, please have a look at your product, repositories or where you are listed as committer. Is this correct? Is there a description or something missing within your product? Should we describe something more in detail? Would be happy about your sugestions.

Goal

If this PR is merged (hopefully we can do this) we would have a list of all products/repositories and the related committer which is responsible for this product/repository.

Pre-review checks

Please ensure to do as many of the following checks as possible, before asking for committer review:

@stephanbcbauer stephanbcbauer added documentation Improvements or additions to documentation enhancement New feature or request labels Jul 7, 2024
@stephanbcbauer stephanbcbauer requested a review from a team July 7, 2024 19:08
@stephanbcbauer stephanbcbauer self-assigned this Jul 7, 2024
Copy link
Contributor

@tom-rm-meyer-ISST tom-rm-meyer-ISST left a comment

Choose a reason for hiding this comment

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

reviewed for puris / myself

utils/products.js Outdated Show resolved Hide resolved
utils/products.js Outdated Show resolved Hide resolved
utils/products.js Outdated Show resolved Hide resolved
utils/products.js Outdated Show resolved Hide resolved
utils/products.js Outdated Show resolved Hide resolved
utils/products.js Outdated Show resolved Hide resolved
utils/products.js Outdated Show resolved Hide resolved
utils/products.js Outdated Show resolved Hide resolved
utils/products.js Outdated Show resolved Hide resolved
utils/products.js Outdated Show resolved Hide resolved
utils/products.js Outdated Show resolved Hide resolved
utils/products.js Outdated Show resolved Hide resolved
utils/products.js Outdated Show resolved Hide resolved
@matbmoser
Copy link
Contributor

Ok, I have updated our Digital Product Pass product description and configurations. I also removed the eco pass kit repo, since it is not really a product and it is archived.

matbmoser
matbmoser previously approved these changes Jul 8, 2024
Copy link
Contributor

@matbmoser matbmoser left a comment

Choose a reason for hiding this comment

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

At least from my side I can approve the merge.

Copy link
Contributor

@SebastianBezold SebastianBezold left a comment

Choose a reason for hiding this comment

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

If this list was generated by a script or similar, it should maybe be re-run without taking archived repos into account.
I already suggested in the past, that if this list is maintained here, we should maybe automate it with the same logic as the TRG dashboard is generated: https://eclipse-tractusx.github.io/sig-release/
This dashboard already groups repos to products and also ignores archived repos. SIGs and supporting repos are also already separated.
Maybe both approaches (website + dashboard) can be combined, so that there is no duplication and manual effort.

@almadigabor and @tomaszbarwicki: Could you two please double check this PR explicitly? You are referenced in a lot of product, where I guess you did TRG checks or merged contributions. I guess you are not actually involved in all of the products

utils/products.js Outdated Show resolved Hide resolved
utils/products.js Outdated Show resolved Hide resolved
utils/products.js Outdated Show resolved Hide resolved
utils/products.js Outdated Show resolved Hide resolved
utils/products.js Outdated Show resolved Hide resolved
utils/products.js Outdated Show resolved Hide resolved
utils/products.js Outdated Show resolved Hide resolved
utils/products.js Outdated Show resolved Hide resolved
utils/products.js Outdated Show resolved Hide resolved
utils/products.js Outdated Show resolved Hide resolved
utils/products.js Outdated Show resolved Hide resolved
@almadigabor
Copy link
Contributor

If this list was generated by a script or similar, it should maybe be re-run without taking archived repos into account. I already suggested in the past, that if this list is maintained here, we should maybe automate it with the same logic as the TRG dashboard is generated: https://eclipse-tractusx.github.io/sig-release/ This dashboard already groups repos to products and also ignores archived repos. SIGs and supporting repos are also already separated. Maybe both approaches (website + dashboard) can be combined, so that there is no duplication and manual effort.

@almadigabor and @tomaszbarwicki: Could you two please double check this PR explicitly? You are referenced in a lot of product, where I guess you did TRG checks or merged contributions. I guess you are not actually involved in all of the products

Hey @SebastianBezold, I had a look at the products where I'm listed as committer and added comments where I see fit.

@stephanbcbauer
Copy link
Member Author

stephanbcbauer commented Sep 25, 2024

Thank you, @eclipse-tractusx/automotive-tractusx-committers for your review and feedback.

Hopefully, I changed everything like expected. @almadigabor @tomaszbarwicki on your side, I am still not sure, please have a look again. Thank you very much.

Copy link
Contributor

@tom-rm-meyer-ISST tom-rm-meyer-ISST left a comment

Choose a reason for hiding this comment

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

Walked through in more detail. I proposed productDescription for central or non-committer repos.

Also there are non-existing repos listed, I would remove or split.

{
productName: "IDS Essential Services",
productDescription: "The project provides additional services to enable an IDSA-infrastructure within the Catena-X dataspace.",
productDescription:
"The project provides additional services to enable an IDSA-infrastructure within the Catena-X dataspace.",
githubRepo: [
"https://github.com/eclipse-tractusx/daps-registration-service",
Copy link
Contributor

Choose a reason for hiding this comment

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

Aren't the daps and its registration service ready for deprecation?

},
{
productName: "managed-identity-wallet",
productDescription: "TBD",
Copy link
Contributor

Choose a reason for hiding this comment

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

committers available, thus product description MUST be set

productName: "Generic Data Services",
productDescription: "The project provides an easy-to-use service which enables small and medium sized companies to provide their data in the Catena-X dataspace via an EDC (e.g., CSV-Upload).",
productName: "managed-service-orchestrator",
productDescription: "TBD",
Copy link
Contributor

Choose a reason for hiding this comment

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

committers available, thus product description MUST be set

productName: "Item Relationship Service",
productDescription: "The project provides a service for ad-hoc data chains across n-tier values chains for different use cases based on the EDC.",
productName: "managed-simple-data-exchanger",
productDescription: "TBD",
Copy link
Contributor

Choose a reason for hiding this comment

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

committers available, thus product description MUST be set

},

{
productName: "Semantic Layer & Digital Twin",
Copy link
Contributor

Choose a reason for hiding this comment

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

Where does this project come from? It has been a team and this is a summary of all products belonging to the team.

What's this list's target? If it's about listing products and repositories I would expect them to be separated because e.g. an adopter does not need to use all of these services to have one application runnint (e.g. frontend, backend, documentation, etc. for portal). Then only the leading repository of the .tractusx needs to be listed.

},
{
productName: "vas-country-risk",
productDescription: "TBD",
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
productDescription: "TBD",
productDescription: "The Catena-X Country Risk project is a web application that calculates a risk score per country based on information regarding corruption, political stability, economic risk, and social and structural figures.",

@@ -1,152 +1,372 @@
export const products = [
{
productName: "api-hub",
productDescription: "TBD",
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
productDescription: "TBD",
productDescription: "Welcome to the API Hub repository, a centralized location for hosting and viewing API documentation for the Tractus-X organization. This repository automates the collection of OpenAPI specifications from GitHub releases, generates Swagger UI documentation, and publishes it on GitHub Pages.",

hasBoard: true,
showVersion: true,
},
{
Copy link
Contributor

Choose a reason for hiding this comment

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

This product forwards to another github project & repo, likely as this has been moved to be handled by the EF working groups more independent of Eclipse Tractus-X.

Recommend removing

Copy link
Contributor

Choose a reason for hiding this comment

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

"https://github.com/eclipse-tractusx/policy-hub"
],
productName: "tractusx-profiles",
productDescription: "TBD",
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
productDescription: "TBD",
productDescription: "Defines Credential and Policy Profiles for Tractus-X.",

showVersion: true,
},
{
productName: "quality-dashboard",
Copy link
Contributor

Choose a reason for hiding this comment

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

product not available

Copy link
Contributor

Choose a reason for hiding this comment

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

I assume the app-dashboard but that's not a product

@stephanbcbauer
Copy link
Member Author

Walked through in more detail. I proposed productDescription for central or non-committer repos.

Also there are non-existing repos listed, I would remove or split.

Will have a look. Thx @tom-rm-meyer-ISST

Copy link
Contributor

@evegufy evegufy left a comment

Choose a reason for hiding this comment

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

could you please also update the PR description, for instance the following statement is obsolete:

If there wasn't an active committer, I put @evegufy and myself as responsible committer. Of course, we can adapt this. I also deleted the committer, where we already know they are not present after the end of consortium.

hasBoard: true,
showVersion: true,
},
{
Copy link
Contributor

Choose a reason for hiding this comment

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

Comment on lines 87 to 88
"https://github.com/eclipse-tractusx/daps-registration-service",
"https://github.com/eclipse-tractusx/daps-helm-chart",
Copy link
Contributor

Choose a reason for hiding this comment

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

the two repos should be removed and the product be changed to Self-Description Factory.

showVersion: true,
},
{
productName: "quality-dashboard",
Copy link
Contributor

Choose a reason for hiding this comment

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

I assume the app-dashboard but that's not a product

@matbmoser
Copy link
Contributor

LGTM we should merge this ASAP, in worst case another PR should be created

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants