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

Updated kit structure #1167

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

Conversation

Grand-Thibault
Copy link
Contributor

Description

  • Removing inconsistencies in the KIT structure

Pre-review checks

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

Copy link
Member

@stephanbcbauer stephanbcbauer left a comment

Choose a reason for hiding this comment

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

please see comments

```

6. To generate the `OpenAPI` based documentation of your KIT, please publish the API on SwaggerHub
8. To generate the `OpenAPI` based documentation of your KIT, please publish the API on SwaggerHub
Copy link
Member

Choose a reason for hiding this comment

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

We have to change this because here the API-Hub should be used instead of swagger hub. i think this needs to be mentioned? Are you in this topic?

https://github.com/eclipse-tractusx/api-hub/tree/main

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Nope, please change accordingly.

Copy link
Member

Choose a reason for hiding this comment

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

On my ToDo List

@Grand-Thibault
Copy link
Contributor Author

Grand-Thibault commented Feb 27, 2025

@stephanbcbauer I guess we should also add a folder for images etc. How should it be called? assets? resources?

I saw taht for some KITs images are stored in the static folder. What is the right way?

@stephanbcbauer
Copy link
Member

@stephanbcbauer I guess we should also add a folder for images etc. How should it be called? assets? resources?

I saw taht for some KITs images are stored in the static folder. What is the right way?

Not sure if we already talked about it. static folder should be only used, if there is no need to version the pictures/diragramms.

e.g. Icons are normaly in the static folder (within the rrot)

Copy link
Member

@jSchuetz88 jSchuetz88 left a comment

Choose a reason for hiding this comment

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

"We" maybe should add the /asset/ folder for images and other files in the description?

  • See comment below.

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.

3 participants