DataStaxDocs / datastax-streaming-docs-site

The "playbook" repo holding antora build directions as well as the docs home page for streaming
1 stars 0 forks source link

DOC-3701: Migrate to official @asciidoctor/tabs extension #99

Closed eric-schneider closed 1 year ago

eric-schneider commented 1 year ago

JIRA: DOC-3701

🚨🚨 DO NOT MERGE UNTIL A NEW UI BUNDLE IS RELEASED CONTAINING https://github.com/riptano/antora-ui-docs/pull/81 🚨🚨

This PR updates the backend for generating tabs blocks. It removes the local (and very outdated) tabs-block.js script and replaces it with the official Asciidoctor Tabs extension. Our implementation follows the "Using a Dedicated UI Project" method, which involves: 1.) updating the UI bundle, and 2.) updating the Antora playbook and its list of dependencies in package.json. This PR implements the latter, while https://github.com/riptano/antora-ui-docs/pull/81 implements the former. Therefore, this PR must be merged immediately after https://github.com/riptano/antora-ui-docs/pull/81 gets released in the latest UI bundle.

No changes to the tabs block behavior are expected as a result of these changes. Likewise, no changes to the tabs block syntax should be required. Basic sanity testing has so far shown this to be true.