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: initial release for modular production kit #495

Merged

Conversation

dominikoeh
Copy link
Contributor

@dominikoeh dominikoeh commented Nov 15, 2023

Description

This Pull Request introduces the first version of the Modular Production Kit in the Resiliency Domain in anticipation of the 23.12 release. It includes the Changelog, Adoption and Software Development View as wells as a white paper.

The content of the pull request is created by the Modular Production Team @wehrstedt-jan

Pre-review checks

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

@maximilianong @danielmiehle @SebastianBezold

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.

Cannot say much about the content, but maybe some general questions:

  • Is it possible to get SVG versions of the images provided? This would ensure, that we can maintain the images.
  • Where does the modular-production-onboarding.pdf come from? Is there an editable "raw" form of it. This is also related to maintainability of the contents
  • Is it commonly agreed in KITs, that directory names contain spaces? I see that quite often, but find it uncomfortable, especially when it comes to linking. If the directory structure is present in URLs and links, the spaces always have to be URL encoded to %20 and so on.

All in all the PR looks good to me, but the image and PDF topic should be address somehow (maybe afterwards). The spaces in directories topic is just food for thought 😁

@dominikoeh
Copy link
Contributor Author

Cannot say much about the content, but maybe some general questions:

  • Is it possible to get SVG versions of the images provided? This would ensure, that we can maintain the images.
  • Where does the modular-production-onboarding.pdf come from? Is there an editable "raw" form of it. This is also related to maintainability of the contents
  • Is it commonly agreed in KITs, that directory names contain spaces? I see that quite often, but find it uncomfortable, especially when it comes to linking. If the directory structure is present in URLs and links, the spaces always have to be URL encoded to %20 and so on.

All in all the PR looks good to me, but the image and PDF topic should be address somehow (maybe afterwards). The spaces in directories topic is just food for thought 😁

  1. will check for SVGs of the images
  2. The raw version currently is a Word document
  3. For the creation of the KIT I checked the repository and the wiki since the spaces looked strange at first; yet the wiki also has examples containing them https://github.com/eclipse-tractusx/eclipse-tractusx.github.io/wiki/How-to-create-a-KIT-website%3F

@dominikoeh
Copy link
Contributor Author

PNG files have been replaced with SVG files

@SebastianBezold
Copy link
Contributor

PNG files have been replaced with SVG files

Ok cool thank you. Looks good from my side. I'll add @danielmiehle and @maximilianong to the reviewers section.
In case you did not know yet @dominikoeh, you can ask for review, when you have "triage" privileges. You'll get these privileges, when you are added as "Project Contributor". This role can be granted to you by any committer and we also prepared an issue template for it

Copy link
Contributor

@danielmiehle danielmiehle left a comment

Choose a reason for hiding this comment

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

LGTM

@danielmiehle
Copy link
Contributor

@maximilianong we should update the how to create a KIT page concerning the directory names and spaces.

@maximilianong maximilianong merged commit 64d9dbc into eclipse-tractusx:main Dec 7, 2023
2 checks passed
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.

4 participants