Skip to content

[26.06] Requirements KIT - new KIT template (Incubating) - #1547

Open
manourym wants to merge 17 commits into
eclipse-tractusx:mainfrom
manourym:26.06-requirements-kit
Open

[26.06] Requirements KIT - new KIT template (Incubating)#1547
manourym wants to merge 17 commits into
eclipse-tractusx:mainfrom
manourym:26.06-requirements-kit

Conversation

@manourym

Copy link
Copy Markdown
Contributor

Description

This change updates the Requirements KIT to the new KIT template (graduated).
In the initial PR some fields still need to be filled out.
It introduces the industry extensions, showing that currently all information are cross-industry use cases.

It is a a first update for eclipse-tractusx/sig-release#1550

Pre-review checks

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

@manourym
manourym force-pushed the 26.06-requirements-kit branch from 061677f to 68e3013 Compare May 26, 2026 14:34
@matbmoser

Copy link
Copy Markdown
Contributor
image

There are some broken links

@matbmoser

Copy link
Copy Markdown
Contributor

But great KIT!

@matbmoser matbmoser left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

That's very cool! Much more organized!

@github-project-automation github-project-automation Bot moved this from Inbox to In Progress in Tractus-X Webpage Jun 8, 2026
@matbmoser

Copy link
Copy Markdown
Contributor

I have changed the lifecycle from this KIT from Sandbox to Incubating (In Progress)

@matbmoser matbmoser left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Oh I forgot one thing, please update the change log :)

@matbmoser

Copy link
Copy Markdown
Contributor

I am asking the master builder to review.

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

I’m the KIT Master Builder — your Eclipse Tractus-X KIT architect and reviewer.

This PR updates the Requirements KIT to the newer KIT template structure, introduces an initial industry extension section (automotive), and adjusts the kit’s master-data maturity metadata. It also adds REUSE metadata and a newly licensed image asset.

Changes:

  • Reworked the Requirements KIT docs structure by adding a template-aligned Adoption View, a new Development View, and an Industry Extensions section.
  • Added REUSE metadata and licensing sidecar files for image assets under the Requirements KIT.
  • Updated kit master data (maturity) and regenerated the nav items output.

✅ What I Like

  • The new Adoption/Development View pages follow the template’s overall layout (frontmatter + KIT logo block + Notice footer).
  • The Industry Extensions scaffolding is in place and wired into the folder structure with _category_.json.

⚠️ Changes I Need You to Make

  • Fix the license header mismatch in industry-extensions/automotive/Overview.md (Apache-2.0 header vs CC-BY Notice). This is a compliance issue (TRG 7.07).
  • Replace placeholder REUSE entries ([XXXX] [YOUR COMPANY]) with real SPDX copyright lines for the Requirements KIT image resources.
  • Fix the invalid JSON example in the Development View (trailing commas).

💡 My Suggestions

  • Either reference the newly added requirements_customer-journey.png from the docs or remove it to avoid carrying unused large binaries.
  • Clarify whether the KIT is actually “graduated” (as stated in the PR description) or still “Incubating” (as in kitsData.js).

📋 Checklist Results

  • Legal/compliance (TRG 7.07): Fail (license header mismatch + REUSE placeholders)
  • Docs correctness: Fail (invalid JSON example)
  • Structure/template alignment: Pass with changes

Reviewed changes

Copilot reviewed 8 out of 11 changed files in this pull request and generated 5 comments.

Show a summary per file
File Description
utils/generated/kitNavItems.js Regenerated nav items (hash update and category listing changes).
docs-kits/kits/requirements-kit/software-development-view.md Removes the old Software Development View page (replaced by new structure).
docs-kits/kits/requirements-kit/development-view/development-view.md Adds new template-aligned Development View content (needs JSON example fix + heading consistency).
docs-kits/kits/requirements-kit/adoption-view/adoption-view.md Updates Adoption View to new template and expands content (has minor text issues).
docs-kits/kits/requirements-kit/industry-extensions/_category_.json Adds Industry Extensions navigation category.
docs-kits/kits/requirements-kit/industry-extensions/automotive/_category_.json Adds Automotive Extension navigation category.
docs-kits/kits/requirements-kit/industry-extensions/automotive/Overview.md Adds automotive extension page (needs CC-BY header alignment).
docs-kits/kits/requirements-kit/resources/img/REUSE.toml Adds REUSE metadata (must replace placeholders).
docs-kits/kits/requirements-kit/resources/img/requirements_customer-journey.png Adds image asset (currently appears unused).
docs-kits/kits/requirements-kit/resources/img/requirements_customer-journey.png.license Adds image license sidecar file.
data/kitsData.js Updates Requirements KIT maturity metadata (needs alignment with PR description intent).
Comments suppressed due to low confidence (2)

docs-kits/kits/requirements-kit/adoption-view/adoption-view.md:312

  • Typo: “tother” should be “together”.
    docs-kits/kits/requirements-kit/adoption-view/adoption-view.md:301
  • The CX-0154 description in the standards table is cut off (“This includes parameters of”), which reads like an unfinished sentence.

Comment thread docs-kits/kits/requirements-kit/resources/img/REUSE.toml
Comment thread data/kitsData.js
@manourym manourym changed the title [26.06] Requirements KIT - new KIT template (Graduation) [26.06] Requirements KIT - new KIT template (Incubating) Jun 10, 2026
@manourym
manourym requested a review from matbmoser June 10, 2026 21:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: Todo

Development

Successfully merging this pull request may close these issues.

3 participants