search

tulios / kafkajs

A modern Apache Kafka client for node.js
https://kafka.js.org
MIT License
3.76k stars 528 forks source link

Migrate to Docusaurus v2 #963

Open Nevon opened 4 years ago

Nevon commented 4 years ago

Is your feature request related to a problem? Please describe. Docusaurus v1 is not going to be receiving updates going forward, so eventually we will need to migrate to v2. Until recently, versioning wasn't supported in v2, which was a blocker for us, but now it seems it is available.

What prompted this issue is that configuring retries is quite tricky without graphing it to understand how it behaves. The chart in the docs is generated via gnuplot, but obviously it's not interactive so it can't be used to tweak the values and see the result. If we had the ability to embed custom react components into the page, we could make this a lot better.

Describe the solution you'd like

Additional context

I would love community contribution on this one. I don't see myself finding the time to prioritise this.

j-a-h-i-r commented 3 years ago

I would love to help with this. Can you give some instructions on where to start?

Nevon commented 3 years ago

Hey! That would be very much appreciated. I think the easiest way would be to just fork the project and get familiar with how the current docs are generated. It's a pretty standard Docusaurus 1 setup, except that we use versioned docs.

From there, I would look at Docusaurus' documentation on migrations to see what the best way to go about them is, and then follow that, see what breaks, fix it and repeat until we have our new documentation working according to the requirements I put in this issue.

I think the biggest hurdle is going to be making sure that old URLs work and that all the old versions of the documentation are still available. Not sure what has changed in Docusaurus 2 in that regard. We build the website on every master build and push to github pages. I suspect nothing really needs to change there, unless maybe some command has changed slightly.

j-a-h-i-r commented 3 years ago

Thanks for the clarification. I don't have any prior experience with docusaurus, so I'm currently reviewing the docs. I was able to follow the migration guide and fix the compilation errors. There are more issues to fix. So, once it's in a workable state, I'll create a PR.

j-a-h-i-r commented 3 years ago

https://github.com/tulios/kafkajs/pull/1054 created to keep track of the migration to v2 of docusaurus

wokayme commented 2 years ago

@j-a-h-i-r, @Nevon Maybe Can I help somehow with migration ;) I see that PR is in progress for a quite long time and recently I work with KafkaJS at work and not working sidebar on the right (scroll to exact sections) on some page of documentation makes me irritated ;) So I think I can help in some way instead investing time in fixing old solution ;)