Upgrade docusaurus (tractus-x webpage) to newest version 3.5

[stephanbcbauer]

Overview

This feature will upgrade the Tractus-X website's Docusaurus framework from version 2.2.0 to 3.6.0 to enhance security by addressing vulnerabilities in outdated libraries. The upgrade involves removing deprecated plugins and implementing a new method to display API specifications across different KIT versions.

Explain the topic in 2 sentences

To update Tractus-X’s webpage to Docusaurus 3.6.0, we’ll remove unmaintained plugins and introduce API Hub for consistent API spec presentation across KIT versions, addressing syntax requirements imposed by the new MDX checker.

What's the benefit?

This update improves website security, reduces dependency on outdated plugins, and standardizes the API display across various KIT versions.

What are the Risks/Dependencies?

• Removing the Open API plugin will affect older KITs that use it to generate files for Swagger UI. The transition to API Hub must ensure compatibility with both older and newer KITs.
• The new MDX checker enforces syntax requirements that may require revisions to multiple KITs’ markdown files.
• Certain dependencies or custom components may need adjustments for compatibility with Docusaurus 3.6.0.

Detailed Explanation

This upgrade will:

• Replace the outdated Open API plugin with API Hub, ensuring API spec availability across all KITs.
• Remove the obsolete remote plugin, which is no longer in use.
• Address MDX syntax issues raised by the Docusaurus 3.6.0 checker, with errors resolved in the related KITs’ MDX and MD files.

Current Implementation

The current webpage uses Docusaurus 2.2.0 with an Open API plugin to display Swagger UI for some KITs, and a remote plugin that is no longer in use. Syntax rules for markdown files are less strict, resulting in potential errors when checked with the MDX checker in the new version.

Proposed Improvements

1. Upgrade to Docusaurus 3.6.0.
2. Remove the Open API and remote plugins.
3. Integrate API Hub for consistent API presentation across KIT versions.
4. Resolve MDX checker errors in the related KITs’ MDX and MD files.

Feature Team

Contributor

• @jSchuetz88
• @manojava-gk
• @ybidois
• @stephanbcbauer

Committer

• @stephanbcbauer

User Stories

• [ ] Update the Tractus-X website to Docusaurus 3.6.0 to ensure security and library compatibility.
• [ ] Remove outdated plugins (Open API and remote) to maintain plugin compatibility and security.
• [ ] Transition KITs’ API specifications to be displayed via the new API Hub.
• [ ] Resolve MDX checker errors in KITs’ MDX and MD files for syntax compliance.
• [ ] Provide a reference implementation for setting up the API Hub for KITs’ API specs.
• [ ] Update documentation and guidelines on required MDX syntax for contributors.

Acceptance Criteria

• [ ] Docusaurus core updated to 3.6.0 with deprecated plugins removed
• [ ] All API specs are accessible through the new API Hub
• [ ] MDX checker errors resolved in the related KITs’ MDX and MD files

Test Cases

Test Case 1

Steps

1. Navigate to API documentation for both old and new KITs.
2. Verify API specs are displayed via API Hub.

Expected Result

1. API specs are consistently displayed in both old and new KIT versions.

Test Case 2

Steps

1. Add a dummy kit (or maybe a demo kit) as example and for testing

Expected Result

1. The KIT is displayed correctly without any errors and the correct API version and spec is linked.

Architectural Relevance ⇾ not needed for this upgrade ⇾ content deleted

Additional information

• [X] I am aware that my request may not be developed if no developer can be found for it. I'll try to contribute a developer (bring your own developer)

[stephanbcbauer]

Some hints from Release Management (@ther3sa) and Tractus-X Project Lead (@stephanbcbauer)

• Status currently in Inbox. ⇾ Only features with status backlog are considered in open planning
• Please add missing sections from the feature template, or fill them out
• Please add assignee (overall responsible person who drives the feature)

[stephanbcbauer]

@@jSchuetz88, @manojava-gk, @ybidois sorry for the short notice. I nearly forget to refine my feature. Can you please provide feedback on this? Thx

[jSchuetz88]

Looks good to me, lets do it 👍

[ybidois]

@stephanbcbauer What about adding a second test case about "Adding a dummy kit" and see if it displays correctly along the current kits?

[stephanbcbauer]

@stephanbcbauer What about adding a second test case about "Adding a dummy kit" and see if it displays correctly along the current kits?

Thank you very much.I will add a second test case. What do you think about the overall description? Does it make sense? Is this feature or description? Good quality?

[stephanbcbauer]

@ybidois, @jSchuetz88 added the test case and put the status to Backlog

[manojava-gk]

this looks good to me

[stephanbcbauer]

@manojava-gk, @ybidois deleted you from the committer section, since you are not committers, correct. But i think overall that's an excellent contribution.

[ClosedSourcerer]

Please make sure that the mermaid plugin gets updated as well. Newer version should support chart types: mindmap, block-beta and xychart-beta

[ClosedSourcerer]

@MWADCM @LukasSchmetz We need to change our KIT and migrate the API documentation to the API Hub (For all Released KIT Versions)

[LukasSchmetz]

@MWADCM @LukasSchmetz We need to change our KIT and migrate the API documentation to the API Hub (For all Released KIT Versions)

@ClosedSourcerer Thanks for highlighting. Should we link that to our KIT Maintenance Feature for R25.03?