Commit Graph

168 Commits

Author SHA1 Message Date
Gavin King 429f5beff6 HHH-18948 move the EventMonitor SPI to its own namespace 2024-12-16 22:58:02 +01:00
Gavin King 46430a4698 remove additional modules which don't contain APIs from the generated Javadoc
These modules don't contain APIs which are called by users or implemented by
integrators. Including them in the generated Javadoc results in confusion
for users and makes the Javadoc much more difficult to navigate and consume.

In particular, we definitely don't want packages like these included in the
main Javadoc distribution for Hibernate ORM:

  org.hibernate.testing.orm.domain.gambit
  org.hibernate.testing.orm.domain.helpdesk

"Good documentation" isn't about having the maximum possible quantity of
documentation; it's about having documentation where people actually have a
hope of finding what they're looking for. In general, generated Javadoc is
entirely useless except when we've actually taken time to actually write
meaningful and readable prose. If all I need is a list of classes and their
methods, my IDE is quite capable of presenting that information to me.

Worse, documentation for things that aren't API appears to invite users to
interact with these things, which is precisely what we don't want them to do!

I'm leaving Envers alone, but I'm honestly not even sure if the Envers packages
belong here, since it doesn't look like anyone has actually spent much time
writing Javadoc for these packages. If Envers Javadoc is useful, it would be
better to put it in a separate Javadoc build, IMO.
2024-12-16 22:57:29 +01:00
Gavin King 5efd37a4d8 HHH-18902 completely remove Vibur
it has not been updated in 5 years
2024-12-03 08:35:29 +01:00
Gavin King 90ff5e712a HHH-18902 completely remove Proxool
it has not been updated in 20 years!
2024-12-03 08:35:29 +01:00
Gavin King 05852b706f
more cleanups to dependencies () 2024-12-01 13:37:51 +01:00
Steve Ebersole dd8e186416 HHH-18644 - New and improved hibernate-maven-plugin 2024-10-22 08:50:09 -05:00
Steve Ebersole 4f9035e9f8 HHH-18545 - Document "characteristics" of settings 2024-09-30 09:47:30 -05:00
Gavin King e086674878 rename hibernate-jpamodelgen to hibernate-processor 2024-08-15 13:52:24 -05:00
Christian Beikov e4a0b6988f Switch to a okhttp-digest version that is available on Maven central 2024-07-16 11:07:51 +02:00
Christian Beikov 1da18451ce Update asciidoctor plugins to 4.0.2 2024-07-15 19:27:12 +02:00
Gavin King 431cf992ec
include the Repositories documentation in the docs build ()
Signed-off-by: Gavin King <gavin@hibernate.org>
2024-04-15 22:13:16 +02:00
Gavin King 9ba2803440
documentation for Hibernate Data Repositories ()
documentation for Hibernate Data Repositories

Signed-off-by: Gavin King <gavin@hibernate.org>
2024-04-15 21:22:27 +02:00
Steve Ebersole ffbae4c736 Fix User Guide settings section 2023-12-20 19:49:08 -06:00
Marco Belladelli ac637ea8af HHH-17425 Introduce some new dialect-specific config params 2023-11-23 14:33:40 +01:00
Christian Beikov 49cfb2a611 HHH-17259 Fix Gradle task dependency issue 2023-09-29 10:42:55 +02:00
Yoann Rodière 7f19de0332 HHH-17259 Add a "compatibility" section to the user guide 2023-09-26 14:46:16 +02:00
Steve Ebersole 32f635e752 HHH-16962 - General documentation improvements
https://hibernate.atlassian.net/browse/HHH-16962
2023-09-01 11:40:43 -05:00
Steve Ebersole a2d45a2679 HHH-16962 - General documentation improvements
HHH-17141 - Prepare for 6.3.0 release

https://hibernate.atlassian.net/browse/HHH-16962
https://hibernate.atlassian.net/browse/HHH-17141
2023-08-29 13:20:19 -05:00
Steve Ebersole fd961cebb1 HHH-17082 - Improve documentation of configuration settings
https://hibernate.atlassian.net/browse/HHH-17082
2023-08-28 10:19:37 -05:00
Steve Ebersole a6b43a6a45 HHH-17047 - Follow up tasks for Gradle 8.2 upgrade
- toolchains
- lazy Task creation
- documentation (documentation/ and release/) tasks
2023-08-14 07:57:49 -05:00
marko-bekhta ffa2ee1443 HHH-17047 - Follow up tasks for Gradle 8.2 upgrade
- tweak how see additional links section is rendered
- update external javadoc links
2023-08-14 07:57:49 -05:00
Steve Ebersole 9e2108e7d7 HHH-17047 - Follow up tasks for Gradle 8.2 upgrade
- toolchains
- lazy Task creation
- documentation (documentation/ and release/) tasks
2023-08-14 07:57:48 -05:00
Steve Ebersole d3a1bd70ae HHH-17047 - Follow up tasks for Gradle 8.2 upgrade
- toolchains
- lazy Task creation
- documentation (documentation/ and release/) tasks
2023-08-14 07:57:48 -05:00
Steve Ebersole d8d1113293 HHH-17047 - Follow up tasks for Gradle 8.2 upgrade
- toolchains
- lazy Task creation
- documentation (documentation/ and release/) tasks
2023-08-14 07:57:44 -05:00
Andrea Boriero 345598aab6 Fix documentation build error with Gradle 8 2023-08-04 14:49:21 +02:00
Gavin King 7cf4fd0626
update the QuickStart guide ()
* update the code examples in the quickstart

* update the quickstart document

* slightly restructure the quickstart document
2023-06-15 23:52:49 +02:00
Gavin f3fddf02da split up chapters of HQL 2023-05-27 22:33:12 +02:00
Gavin 4c8ed70a69 split + rewrite query language chapter to new HQL guide document 2023-05-27 22:33:12 +02:00
Gavin 2276e2049d integrate rouge source highlighter into adoc build
this is needed because prettify does not seem to
work for the PDF output (I have not dug deep)
2023-05-16 20:16:38 +02:00
Gavin bc85a250ef compile introduction to PDF 2023-05-13 21:08:47 +02:00
Gavin 2841388335 fix build 2023-05-13 21:08:47 +02:00
Gavin King 46ac4c07cf initial blurbs for Introduction document 2023-05-13 21:08:47 +02:00
Steve Ebersole c6389efb1b Add a Dialect report
Also added
* H2Dialect#getMinimumSupportedVersion
* DerbyDialect#getMinimumSupportedVersion
2023-04-27 11:28:35 -05:00
Steve Ebersole 4b8167c7fd PublishMigrationGuide task 2023-04-01 09:37:40 -05:00
Andrea Boriero 570ccae476 HHH-16097 Move all tests from documentation into hibernate-core 2023-03-24 07:43:13 -05:00
marko-bekhta 5d61b03b20 HHH-16217 Use only rendered Javadocs for collecting configuration properties 2023-03-01 13:26:49 -06:00
marko-bekhta 8fa8b23d63 Add tasks to process sources and collect config properties 2023-01-26 00:43:38 -06:00
Steve Ebersole 51a50bed43 Add a deprecated.txt report to published docs collecting union of `@Deprecated` and `@Remove` 2022-12-22 16:55:02 -06:00
Andrea Boriero e80fb85dae HHH-15420 Getting Started Guide Code does not build 2022-08-02 15:47:14 +02:00
Andrea Boriero e3d524fe5e HHH-15396 Quick Start guide, hibernate-tutorials.zip link is broken 2022-07-13 13:54:28 +02:00
Christian Beikov c18e611ed6 HHH-15200 Add support for the SQLXML type 2022-05-05 09:07:37 +02:00
Steve Ebersole 69e57404c6 HHH-15226 - Publish a Gradle platform (Maven Bom++) for Hibernate ORM
- plus use Gradle version catalogs as opposed to `libraries.gradle`
- dropped OSGi manifest entries for hibernate-envers - they were broken and we decided we no longer support OSGi
2022-04-26 14:41:04 -05:00
Steve Ebersole ad828a0a4a release announcement, doc artifacts 2022-03-31 11:01:06 -05:00
Christian Beikov a9d1035806 Do some renaming for consistency and update documentation for new SQL types 2022-03-29 19:31:53 +02:00
Steve Ebersole 6ab1cd3434 fix problem with release.gradle 2022-03-16 11:36:11 -05:00
Steve Ebersole f82d381fe3 Gradle build clean-ups
- re-organize release task definitions to avoid use of subproject iteration
2022-03-15 12:15:56 -05:00
Steve Ebersole 741b6b71f1 logging report 2022-03-11 14:45:43 -06:00
Steve Ebersole e16fbb6c31 report-tasks 2022-03-09 12:28:13 -06:00
Steve Ebersole ac4a792f84 render migration guide using asciidoctor and publish with docs 2022-03-08 11:26:55 -06:00
Steve Ebersole 5436f441ae move remaining tests from o.h.test to o.h.orm.test 2022-01-26 17:06:53 -06:00