From 7deda8c34bfeed28c72517e6cbe78a622ef3e739 Mon Sep 17 00:00:00 2001 From: Steve Ebersole Date: Wed, 20 Nov 2013 11:31:54 -0600 Subject: [PATCH] HHH-8720 - Create an index for the topical guides --- .../src/main/asciidoc/topical/index.adoc | 20 ++++++++++++++++--- 1 file changed, 17 insertions(+), 3 deletions(-) diff --git a/documentation/src/main/asciidoc/topical/index.adoc b/documentation/src/main/asciidoc/topical/index.adoc index 7005d92c0e..1cf2e3b4c2 100644 --- a/documentation/src/main/asciidoc/topical/index.adoc +++ b/documentation/src/main/asciidoc/topical/index.adoc @@ -1,9 +1,10 @@ = 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. +Hibernate documentation is organized into several guides that cover specific topics. This guide provides links to +all the guides to give some direction on where to look for information. +NOTE: This is still very much a work in progress. <> is definitely welcome! == User Guides @@ -21,4 +22,17 @@ guides and try to give some direction on where to look. == Integrator Guides * The <> discusses Hibernate Service and ServiceRegistry contracts. -* Others coming soon \ No newline at end of file +* 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. \ No newline at end of file