malliaridis opened a new pull request, #2550: URL: https://github.com/apache/solr/pull/2550
https://issues.apache.org/jira/browse/SOLR-16198 # Description This PR introduces tabbed sections again in the documentation by using [@asciidoctor/tabs](https://github.com/asciidoctor/asciidoctor-tabs). # Solution The changes add a new dependency to @asciidoctor/tabs that is installed during antora setup. The javascript for controlling the tabs (provided by asciidoctor/tabs) is added to the UI bundle via `supplemental_files` and loaded via the `footer-content.hbs`. Custom styles are used to better match the current documentation design. I tried to follow the instructions from [Asciidoctor/Tabs - How to Use with Antora](https://github.com/asciidoctor/asciidoctor-tabs/blob/main/docs/use-with-antora.adoc). See https://github.com/apache/solr/commit/643a76c3812984491b341548dec7dccf0765d0b1 for a clearer overview of the changes related to the addition of the library. # Tests I have reviewed the generated documentation for correctness via the Gradle task `buildLocalSite` and by enabling the local UI via `SOLR_REF_GUIDE_BUILD_LOCAL_UI=true`. # Checklist - [x] I have reviewed the guidelines for [How to Contribute](https://github.com/apache/solr/blob/main/CONTRIBUTING.md) and my code conforms to the standards described there to the best of my ability. - [ ] I have created a Jira issue and added the issue ID to my pull request title. - [x] I have given Solr maintainers [access](https://help.github.com/en/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork) to contribute to my PR branch. (optional but recommended) - [x] I have developed this patch against the `main` branch. - [ ] I have run `./gradlew check`. - [ ] I have added tests for my changes. - [x] I have added documentation for the [Reference Guide](https://github.com/apache/solr/tree/main/solr/solr-ref-guide) # Additiona Information Since it is my first time working with ASCIIDoc and the documentation, I am not sure if the necessary changes are sufficient for the dependency to be correctly added and loaded in the public documentation on release. I assume that the task `setOfficialAntoraYaml` needs also to be run, but I didn't commit any changes made by the task. I tried to keep the changes minimal, but since it is a notation hassle the changes spread across multiple files. Additionally, the library supports documentation-wide tab-synchronization via the session, but I didn't tested or turned it on yet. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: issues-unsubscr...@solr.apache.org For additional commands, e-mail: issues-h...@solr.apache.org
