Admittedly the thing I love about our setup, is that you can simply update the 
website for our stuff in the development environment we’ve already got open.
Current everything is working fine, and I don’t actually see the need to change 
anything right now.
The Maven folks will finish the site plugin 4.0.0 some day and then the 
asciidoctor folks will provide an updated plugin.
I know we suck at updating our documentation … for that I just updated at least 
the updating of our driver options to run automatically.

Would this still work with docsaurus?

I’m definitely not blocking any change, if the team wants to … I just don’t 
really see a need to do so and I’m not going to invest more weekends in fixing 
stuff because of such a switch.

Chris



Von: Lukas Ott <ott.lukas...@gmail.com>
Datum: Montag, 16. September 2024 um 14:56
An: dev@plc4x.apache.org <dev@plc4x.apache.org>
Betreff: Switching from asciidoctor to docusaurus for improving / changing our 
website setup
Hi PLC4X developers,

After Chris did a great job on cleaning up dependencies and trying to
update a lot of POMs it ended up in this comment related to
https://github.com/apache/plc4x/pull/1423 and
https://github.com/apache/plc4x/pull/1419

"Yeah ... updating asciidoctor and the site plugin is a HUGE mess ...
especially with the update of the doxia tools ... This seems to break
EVERYTHING. Unfortunately the asciidoctor folks are planning on updating
and releasing the asciidoctor plugin as soon as the site plugin in version
4 is finally released.
asciidoctor/asciidoctor-maven-plugin#685
See also related PR for updating the site plugin: #1419" - cdutz

IMHO Dominik Riemer from the https://streampipes.apache.org/ team have neat
setup with:
https://github.com/facebook/docusaurus

As soon as they push things to https://github.com/apache/streampipes
It updates documentation on the website:
https://github.com/apache/streampipes-website which is then deployed:
https://streampipes.apache.org/

Dominik offered to support us with the initial setup and I would vote for
it.

If this mail gets no objections after 72 hours I would ask Dominik to spin
up a PR request to get started migrating to the docusaurus approach.

Please comment and give feedback! Thank you!

Cheers
Lukas

Reply via email to