search

jaegertracing / documentation

Documentation/website for the Jaeger Distributed Tracing project.
https://jaegertracing.io/
Apache License 2.0
68 stars 164 forks source link

Migration to docsy theme #746

Open yurishkuro opened 1 month ago

yurishkuro commented 1 month ago

Jaeger website today is using a completely custom theme. This creates a maintenance headache as we run into various layout bugs (e.g. #744, #745). We also have issues with some old dependencies for CASS like bulma (#730).

I looked around in other CNCF projects and noticed that both OpenTelemetry and Kubernetes websites are using https://github.com/google/docsy theme, which is likely much better supported.

Of course, it's not a very trivial job to replace the theme, as we also have plenty of CSS customizations that we would want to keep. So before we really decide to do that we need some investigation, e.g. just trying out enabling the docsy theme and spot-checking what would break in Jaeger as a result, and collect the findings into a report.

One thing we'd need to do is customize the color schemes to match the existing Jaeger website (https://www.docsy.dev/docs/adding-content/lookandfeel/)

Dindihub commented 1 day ago

Hi, @yurishkuro Did you get help with this issue? I worked on a similar project for theupdateframework during my LFX mentorship program Term 2 2024. I would be glad to assist.

yurishkuro commented 1 day ago

@Dindihub We do need help.