Skip to content

Conversation

marko-bekhta
Copy link
Member

@marko-bekhta marko-bekhta commented Oct 8, 2025

  • rename logging and ServiceRegistries docs to index to match the other ones.

I had to split the topical render task as in its current form it wasn't applying the styles to the logging/registries pages.

[Please describe here what your change is about]


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license
and can be relicensed under the terms of the LGPL v2.1 license in the future at the maintainers' discretion.
For more information on licensing, please check here.


https://hibernate.atlassian.net/browse/HHH-19827

+ rename logging and ServiceRegistries docs to index to match the other ones.
@@ -1,5 +1,5 @@
:shared-attributes-dir: {doc-main-dir}/asciidoc/shared
:html-meta-canonical-link: https://docs.jboss.org/hibernate/orm/current/userguide/html_single/Hibernate_User_Guide.html
:html-meta-canonical-link: https://docs.hibernate.org/stable/orm/userguide/html_single/
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Apparently these canonical links are new, so changing them shouldn't have a big effect on SEO.

+1.

Comment on lines +268 to +288
def renderTopicalLoggingGuideHtmlTask = tasks.register( 'renderTopicalLoggingGuideHtml', AsciidoctorTask ) { task ->
group = "Documentation"
description = 'Renders the Topical Logging Guide in HTML format using Asciidoctor.'
inputs.property "hibernate-version", hibernateVersion

sourceDir = file( 'src/main/asciidoc/topical/logging' )
sources 'index.adoc'
outputDir = project.layout.buildDirectory.file( "asciidoc/topical/html_single/logging" ).get().asFile

resources {
from( 'src/main/asciidoc/topical/' ) {
include '**/images/**'
}
from(rootProject.layout.buildDirectory.dir("unpacked-theme").get()
.dir("hibernate-asciidoctor-theme").dir("asciidoc")) {
include 'css/**'
include 'images/**'
include 'script/**'
}
}
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I find it wild to duplicate all this code for every single "root" AsciiDoc file.

Would be nice to have some sort of loop, e.g. ['userguide', 'topical/logging', ...].each { ... }.

But... not today.

@yrodiere yrodiere merged commit 04ec9c6 into hibernate:main Oct 9, 2025
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants