Hi Marco,
no we do not want to replace Docusaurus. We want to upgrade Docusaurus to a new version, since the one we currently use (v2.2.0) was released roughly a year ago. There
is even a new
major release v3.0.0 out now.
But the issue currently is, that the upgrade is blocked because of a single plugin -> docusaurus-openapi-docs. This plugin is used in almost all KIT pages, but has no
relevance to the rest of the website.
Upgrading Docusaurus would break the current KIT pages though.
To get rid of that problem, there already has been a proposal in the past, to opt for SwaggerHub as a replacement for the locally rendered openAPI files.
This would mean, the openAPi specs have to be published to SwaggerHub (we have a technical user for that already) and link to SwaggerHub instead of using the plugin.
I also think this issue is special, because we do not have a clear group of maintainer, like Gabor mentioned.
So I hope we can find a good solution, that enables everyone to provide KIT content, while also preventing the underlying
frameworks and dependencies from rotting.
Cheers,
Sebastian
Mit freundlichen Grüßen / Kind regards
Sebastian Bezold
Software Engineer
Mercedes-Benz Tech Innovation GmbH
(ehemals/formerly Daimler TSS GmbH)
Wilhelm-Runge-Straße 11
89081 Ulm/Germany
Sebastian.Bezold@xxxxxxxxxxxxxxxxx
www.mercedes-benz-techinnovation.com
![signature_3255497109](jpgdeqjfYzRoo.jpg)
Mercedes-Benz Tech Innovation GmbH
Sitz und Registergericht/Domicile and Register Court: Ulm, HRB-Nr./Commercial Register No.: 3844
Geschäftsführung/Management:
Daniel Geisel (Vorsitzender/Chairperson), Isabelle Krautwald
Von: tractusx-dev <tractusx-dev-bounces@xxxxxxxxxxx> im Auftrag von "Gora Marco (BD/TBC3) via tractusx-dev" <tractusx-dev@xxxxxxxxxxx>
Antworten an: tractusx developer discussions <tractusx-dev@xxxxxxxxxxx>
Datum: Donnerstag, 16. November 2023 um 14:33
An: tractusx developer discussions <tractusx-dev@xxxxxxxxxxx>
Cc: "Gora Marco (BD/TBC3)" <Marco.Gora@xxxxxxxxx>
Betreff: Re: [tractusx-dev] Maintaining eclipse-tractusx.github.io and dependencies
[**EXTERNAL E-MAIL**]
Hi Gabor,
as I understand, you want to replace the whole framework due to bad maintenance of plugins?
Or is it just a replacement of the openAPI specs to swagger hub (aka a separate page for api specs)?
If it is just about creating static webpages for the specs, then
Redoc could be a potential candidate as well.
Alternatively if an integrated solution is preferred,
Hugo is a static page generator which I use a lot and adore.
Also there is a
shortcode provided by the community to render openAPI specs in Hugo (based on Swagger UI as far as I can see).
Mit freundlichen Grüßen / Best regards
Marco Gora
Solution Architect
IoT Consulting Berlin (BD/TBC3)
Bosch.IO GmbH | Ullsteinstr. 128 | 12109 Berlin | GERMANY |
www.bosch.io
Tel. +49 30 726112-268 | Mobile +49 173 4697512 | Fax +49 30 726112-100 |
Marco.Gora@xxxxxxxx
Registered Office: Berlin, Registration Court: Amtsgericht Charlottenburg; HRB 148411 B
Chairman of the Supervisory Board: Stefan Koss; Managing Directors: Dr. Andreas Nauerz, Yvonne Reckling
From:
tractusx-dev <tractusx-dev-bounces@xxxxxxxxxxx> on behalf of Gabor.Almadi--- via tractusx-dev <tractusx-dev@xxxxxxxxxxx>
Date: Thursday, 16. November 2023 at 11:34
To: tractusx-dev@xxxxxxxxxxx <tractusx-dev@xxxxxxxxxxx>
Cc: Gabor.Almadi@xxxxxxxxxxxxx <Gabor.Almadi@xxxxxxxxxxxxx>
Subject: [tractusx-dev] Maintaining eclipse-tractusx.github.io and dependencies
Hello All,
I’d like to discuss the situation of the
eclipse-tractusx.github.io repo and website with you. As you might know this app is based on
Docusaurus and many plugins and it is really hard to maintain at the moment. We are facing compatibility issues between different dependencies and therefore we are unable to upgrade them for a while now. This could lead
to outdated components and also security issues. The main blocker here is the
docusaurus-openpi-docs plugin which is maintained by a small group of people and gets updates very rarely and can’t keep up with the releases of Docusaurus. This plugin is used to display OpenAPI documentation on the website like
here. My suggestion would be to investigate to the move to
SwaggerHub with these pages and then we could get rid of the blocking dependencies and be able to keep the app up-to-date. There is already an
open issue on GitHub where we talk about this issue, feel free to add your comments/ideas there too.
Another topic I’d like to talk about is that currently there is no actual maintainer of this page. Everybody is responsible for their own part/section but there is no team/person looking over the whole repo to drive development like the one mentioned
above. We should really address this as a community.
Best regards,