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-20 11:31:54 -06:00
parent 412d5d6fca
commit 7deda8c34b
1 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
documentation/src/main/asciidoc/topical/index.adoc
View File

@ -1,9 +1,10 @@
= Topical Guides = Topical Guides
:toc: :toc:
Hibernate documentation is organized into several guides that cover specific topics. Here we link each of those Hibernate documentation is organized into several guides that cover specific topics. This guide provides links to
guides and try to give some direction on where to look. all the guides to give some direction on where to look for information.
NOTE: This is still very much a work in progress. <<helping,Help>> is definitely welcome!
== User Guides == User Guides
@ -21,4 +22,17 @@ guides and try to give some direction on where to look.
== Integrator Guides == Integrator Guides
* The <<registries/ServiceRegistries.adoc#,Service Registries Guide>> discusses Hibernate Service and ServiceRegistry contracts. * The <<registries/ServiceRegistries.adoc#,Service Registries Guide>> discusses Hibernate Service and ServiceRegistry contracts.
* Others coming soon * Others coming soon
[[helping]]
== Helping
* These "topical guides" are developed using Asciidoctor. Meanwhile the legacy Hibernate reference manuals are
written in DocBook. The conversion of knowledge into the "topical guide" format will take time and is an
ongoing process. A huge way to help would be to create topical guide(s) and pull over the relevant information
from the corresponding reference information. See the https://hibernate.atlassian.net/browse/HHH-8606[Jira task] for
a list of ideas
* Reporting/fixing problems. Report any typos or inaccurate information to the
https://hibernate.atlassian.net/browse/HHH[Hibernate ORM Jira] using the +documentation+ component. Follow the same
guidelines for contributing fixes and improvements as for contributing source code.