Skip to content

Commit 04ec9c6

Browse files
marko-bekhtayrodiere
authored andcommitted
HHH-19827 Add missing canonical links
+ rename logging and ServiceRegistries docs to index to match the other ones.
1 parent 399b757 commit 04ec9c6

File tree

11 files changed

+64
-8
lines changed

11 files changed

+64
-8
lines changed

documentation/documentation.gradle

Lines changed: 50 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,13 +265,59 @@ asciidoctorj {
265265

266266
// Topical Guides ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
267267

268+
def renderTopicalLoggingGuideHtmlTask = tasks.register( 'renderTopicalLoggingGuideHtml', AsciidoctorTask ) { task ->
269+
group = "Documentation"
270+
description = 'Renders the Topical Logging Guide in HTML format using Asciidoctor.'
271+
inputs.property "hibernate-version", hibernateVersion
272+
273+
sourceDir = file( 'src/main/asciidoc/topical/logging' )
274+
sources 'index.adoc'
275+
outputDir = project.layout.buildDirectory.file( "asciidoc/topical/html_single/logging" ).get().asFile
276+
277+
resources {
278+
from( 'src/main/asciidoc/topical/' ) {
279+
include '**/images/**'
280+
}
281+
from(rootProject.layout.buildDirectory.dir("unpacked-theme").get()
282+
.dir("hibernate-asciidoctor-theme").dir("asciidoc")) {
283+
include 'css/**'
284+
include 'images/**'
285+
include 'script/**'
286+
}
287+
}
288+
}
289+
290+
def renderTopicalRegistriesGuideHtmlTask = tasks.register( 'renderTopicalRegistriesGuideHtml', AsciidoctorTask ) { task ->
291+
group = "Documentation"
292+
description = 'Renders the Topical Registries Guide in HTML format using Asciidoctor.'
293+
inputs.property "hibernate-version", hibernateVersion
294+
295+
sourceDir = file( 'src/main/asciidoc/topical/registries' )
296+
sources 'index.adoc'
297+
outputDir = project.layout.buildDirectory.file( "asciidoc/topical/html_single/registries" ).get().asFile
298+
299+
resources {
300+
from( 'src/main/asciidoc/topical/' ) {
301+
include '**/images/**'
302+
}
303+
from(rootProject.layout.buildDirectory.dir("unpacked-theme").get()
304+
.dir("hibernate-asciidoctor-theme").dir("asciidoc")) {
305+
include 'css/**'
306+
include 'images/**'
307+
include 'script/**'
308+
}
309+
}
310+
}
311+
312+
268313
def renderTopicalGuideHtmlTask = tasks.register( 'renderTopicalGuideHtml', AsciidoctorTask ) { task ->
269314
group = "Documentation"
270315
description = 'Renders the Topical Guides in HTML format using Asciidoctor.'
271316
inputs.property "hibernate-version", hibernateVersion
272317

273318
sourceDir = file( 'src/main/asciidoc/topical' )
274-
outputDir = new File( "$buildDir/asciidoc/topical/html_single" )
319+
sources 'index.adoc'
320+
outputDir = project.layout.buildDirectory.file( "asciidoc/topical/html_single" ).get().asFile
275321

276322
resources {
277323
from( 'src/main/asciidoc/topical/' ) {
@@ -284,6 +330,9 @@ def renderTopicalGuideHtmlTask = tasks.register( 'renderTopicalGuideHtml', Ascii
284330
include 'script/**'
285331
}
286332
}
333+
334+
dependsOn renderTopicalLoggingGuideHtmlTask
335+
dependsOn renderTopicalRegistriesGuideHtmlTask
287336
}
288337

289338
def renderTopicalGuidesTask = tasks.register( 'renderTopicalGuides', AsciidoctorTask ) { task ->

documentation/src/main/asciidoc/integrationguide/index.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
:toc2:
33
:toclevels: 3
44
:sectanchors:
5+
:html-meta-canonical-link: https://docs.hibernate.org/stable/orm/integrationguide/html_single/
56

67
include::preface.adoc[]
78

documentation/src/main/asciidoc/introduction/index.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
:shared-attributes-dir: {doc-main-dir}/asciidoc/shared
2+
:html-meta-canonical-link: https://docs.hibernate.org/stable/orm/introduction/html_single/
23

34
include::{shared-attributes-dir}/common-attributes.adoc[]
45
include::{shared-attributes-dir}/url-attributes.adoc[]

documentation/src/main/asciidoc/querylanguage/index.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
:shared-attributes-dir: {doc-main-dir}/asciidoc/shared
2+
:html-meta-canonical-link: https://docs.hibernate.org/stable/orm/querylanguage/html_single/
23

34
include::{shared-attributes-dir}/common-attributes.adoc[]
45
include::{shared-attributes-dir}/url-attributes.adoc[]

documentation/src/main/asciidoc/quickstart/guides/index.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
:shared-attributes-dir: {doc-main-dir}/asciidoc/shared
2+
:html-meta-canonical-link: https://docs.hibernate.org/stable/orm/quickstart/html_single/
23

34
include::{shared-attributes-dir}/common-attributes.adoc[]
45
include::{shared-attributes-dir}/url-attributes.adoc[]

documentation/src/main/asciidoc/repositories/index.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
:shared-attributes-dir: {doc-main-dir}/asciidoc/shared
2+
:html-meta-canonical-link: https://docs.hibernate.org/stable/orm/repositories/html_single/
23

34
include::{shared-attributes-dir}/common-attributes.adoc[]
45
include::{shared-attributes-dir}/url-attributes.adoc[]

documentation/src/main/asciidoc/shared/url-attributes.adoc

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,6 @@ include::./common-attributes.adoc[]
1414
:doc-user-guide-url: {doc-version-base-url}/userguide/html_single/Hibernate_User_Guide.html
1515
:doc-javadoc-url: {doc-version-base-url}/javadocs/
1616
:doc-topical-url: {doc-version-base-url}/topical/html_single/
17-
:doc-registries-url: {doc-topical-url}/registries/ServiceRegistries.html
18-
:doc-logging-url: {doc-topical-url}/logging/Logging.html
1917

2018
:report-deprecation-url: {doc-version-base-url}/deprecated/deprecating.txt
2119
:report-dialect-url: {doc-version-base-url}/dialect/dialect.html

documentation/src/main/asciidoc/topical/index.adoc

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
:shared-attributes-dir: {doc-main-dir}/asciidoc/shared
2+
:html-meta-canonical-link: https://docs.hibernate.org/stable/orm/topical/html_single/
23

34
include::{shared-attributes-dir}/common-attributes.adoc[]
45
include::{shared-attributes-dir}/url-attributes.adoc[]
@@ -37,7 +38,7 @@ link:{doc-user-guide-url}[User Guide]::
3738
[[logging]]
3839
== Logging
3940

40-
The link:{doc-logging-url}[Logging Guide] discusses logging in Hibernate.
41+
The xref:logging/index.adoc[Logging Guide] discusses logging in Hibernate.
4142

4243

4344
[[tooling]]
@@ -52,7 +53,7 @@ See the link:{doc-user-guide-url}#tooling[Tooling Guide] for information on:
5253

5354

5455
== Integrator Guides
55-
* The <<registries/ServiceRegistries.adoc#registries-guide,Service Registries Guide>> discusses Hibernate Service and ServiceRegistry contracts.
56+
* The xref:registries/index.adoc#registries-guide[Service Registries Guide] discusses Hibernate Service and ServiceRegistry contracts.
5657
* Others coming soon
5758

5859

documentation/src/main/asciidoc/topical/logging/Logging.adoc renamed to documentation/src/main/asciidoc/topical/logging/index.adoc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
:shared-attributes-dir: {doc-main-dir}/asciidoc/shared
2+
:html-meta-canonical-link: https://docs.hibernate.org/stable/orm/topical/html_single/logging/
23

34
include::{shared-attributes-dir}/common-attributes.adoc[]
45
include::{shared-attributes-dir}/url-attributes.adoc[]

documentation/src/main/asciidoc/topical/registries/ServiceRegistries.adoc renamed to documentation/src/main/asciidoc/topical/registries/index.adoc

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1+
:html-meta-canonical-link: https://docs.hibernate.org/stable/orm/topical/html_single/registries/
2+
13
[[registries-guide]]
24
= Services and Registries
35
:imagesdir: images
4-
:toc:
6+
:toc2:
57

68
Services and Registries are new *as a formalized concept* starting in 4.0. But the functionality provided by
79
the different Services have actually been around in Hibernate much, much longer. What is new is managing them,
@@ -612,4 +614,4 @@ StandardServiceRegistry serviceRegistry = new StandardServiceRegistryBuilder()
612614

613615
== Conclusion
614616

615-
TODO
617+
TODO

0 commit comments

Comments
 (0)