devonfw-forge / antora-docs-evaluation

Apache License 2.0
0 stars 3 forks source link

Evaluate alternative solution #14

Open SchettlerKoehler opened 2 years ago

SchettlerKoehler commented 2 years ago

Currently, the docs are generated with asciidoctor and this extension https://github.com/asciidoctor/asciidoctor-extensions-lab/blob/master/lib/multipage-html5-converter.rb This was and is a proof of concept for multipage generation with asciidoctor. This extension was also adapted at some points to fit the needs of devonfw. The version that is currently used with all the cahnges can be found here: https://github.com/devonfw/devonfw.github.io/blob/develop/asciidoctor-extensions/multipage-html5-converter.rb Unfortunately, the use of this proof of concept version prevents us from moving to a newer asciidoctor version because it is not compatible. The good news is, that it looks like some people have picked up this proof of concept and transformed it into something more useable: https://github.com/owenh000/asciidoctor-multipage

As the switch to antora could be very expensive and maybe does not even solve our problems or will create new and different problems, we should evaluate if moving to a new asciidoctor version and the stable extension makes our lives easier.

Acceptance criteria:

maybeec commented 2 years ago

Please also check the devon4j repository as one of the first repos as this currently brings a lot of issues as the asciidoc files are managed in subdirectories which seems to be a problem in link creation for the current multipage version in use.

mustafaokyay commented 2 years ago

Done:

Next Steps:

Not Working:

Current status can be found here: https://github.com/mustafaokyay/asciidoctor-multipage