Hibernate
/
hibernate-orm
mirror of https://github.com/hibernate/hibernate-orm
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

HHH-8720 - Create an index for the topical guides

This commit is contained in:
Steve Ebersole 2013-11-19 14:11:05 -06:00
parent 834a71bc6d
commit 475aba7c0f
2 changed files with 41 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
documentation/documentation.gradle
View File

@ -113,19 +113,26 @@ File[] dirList(File dir) {
// asciidoctor ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ // asciidoctor ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
task generateRegistryGuideHtml(type: org.asciidoctor.gradle.AsciidoctorTask, group: 'Documentation') { task asciidoctor(type: org.asciidoctor.gradle.AsciidoctorTask, group: 'Documentation') {
description = 'Generates the ServiceRegistry topical guide in HTML format.' description = 'Generates the Asciidoc(tor) topical guides in HTML format.'
backend = 'html5' backend = 'html5'
sourceDir = file( 'src/main/asciidoc/topical/registries' ) sourceDir = file( 'src/main/asciidoc/topical' )
outputDir = new File("$buildDir/asciidoc/topical/html") outputDir = new File("$buildDir/asciidoc/topical/html")
} }
task generateMetamodelgenGuideHtml(type: org.asciidoctor.gradle.AsciidoctorTask, group: 'Documentation') { //task generateRegistryGuideHtml(type: org.asciidoctor.gradle.AsciidoctorTask, group: 'Documentation') {
description = 'Generates the Metamodel Generator topical guide in HTML format.' // description = 'Generates the ServiceRegistry topical guide in HTML format.'
backend = 'html5' // backend = 'html5'
sourceDir = file( 'src/main/asciidoc/topical/metamodelgen' ) // sourceDir = file( 'src/main/asciidoc/topical/registries' )
outputDir = new File("$buildDir/asciidoc/topical/html") // outputDir = new File("$buildDir/asciidoc/topical/html")
} //}
//
//task generateMetamodelgenGuideHtml(type: org.asciidoctor.gradle.AsciidoctorTask, group: 'Documentation') {
// description = 'Generates the Metamodel Generator topical guide in HTML format.'
// backend = 'html5'
// sourceDir = file( 'src/main/asciidoc/topical/metamodelgen' )
// outputDir = new File("$buildDir/asciidoc/topical/html")
//}
tasks.withType(org.asciidoctor.gradle.AsciidoctorTask) { docTask -> tasks.withType(org.asciidoctor.gradle.AsciidoctorTask) { docTask ->
options = [ options = [
@ -139,7 +146,7 @@ tasks.withType(org.asciidoctor.gradle.AsciidoctorTask) { docTask ->
} }
// - aggregator // - aggregator
task asciidoctor(type: Task, group: 'Documentation') //task asciidoctor(type: Task, group: 'Documentation')
asciidoctor.dependsOn generateRegistryGuideHtml, generateMetamodelgenGuideHtml //asciidoctor.dependsOn generateRegistryGuideHtml, generateMetamodelgenGuideHtml
buildDocs.dependsOn asciidoctor buildDocs.dependsOn asciidoctor

23
documentation/src/main/asciidoc/topical/index.adoc Normal file
View File

@ -0,0 +1,23 @@
= Topical Guides
:toc:
Hibernate documentation is organized into several guides that cover specific topics. Here we link each of those
guides and try to give some direction on where to look.
== User Guides
Coming soon
== Tooling
* See the <<metamodelgen/MetamodelGenerator.adoc#,Metamodel Generator Guide>> for details on generating a JPA "Static Metamodel"
* Guide on the Gradle plugin coming soon
* Guide on the Ant tasks coming soon
* Guide on the Maven plugin coming soon
== Integrator Guides
* The <<registries/ServiceRegistries.adoc#,Service Registries Guide>> discusses Hibernate Service and ServiceRegistry contracts.
* Others coming soon