How to we represent the Tractus-X CHANGELOG on the website #844
SebastianBezold
started this conversation in
General
Replies: 1 comment 3 replies
-
option a 👍 |
Beta Was this translation helpful? Give feedback.
3 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
Current Situation
The Tractus-X CHANGELOG is currently presented as a menu item in the "Versions" top-level navigation.
It is maintained as a Docusaurus page. The contents are manually copied from eclipse-tractusx/tractus-x-release CHANGELOG.
There is also a configuration section, that targets the eclipse-tractusx/tractus-x-release CHANGELOG as remote-content
Potential Problems
Apparently, the CHANGELOG cannot be used as-is, since it will cause Docusaurus build errors. See comments and build history in #842.
The behavior of the remote-content-plugin is not yet clear to me. When running a build locally, it actually deletes the file, instead of pulling the newest version. Maybe this is related to the build issue and it is doing a fail-safe?!
Another obvious problem is, that we could simply forget to update the CHANGELOG after a release, if we have to do it manually
Suggestions
a) Remove the duplicated CHANGELOG from our website completely and instead create a page with general release information and a Link to the CHANGELOG in tractus-x-release
b) Keep the duplicated CHANGELOG and remove the remote-content-plugin config. This would remove the kind of unknown behavior, but would keep the manual effort. Especially the manual adaptation to fix Docusaurus build errors
So I am in favor of a), but would put it to a vote
Beta Was this translation helpful? Give feedback.
All reactions