Deploy documentation module


#1

Hi, I’m working in a ticket referred to the documentation module and I need to know how to deploy that module to see my changes locally before pushing to the remote repo.
Thanks in advance for your time. Best regards


#2

Do you mean how to render the User Guide?

Just run this task in the documentation folder:

> gradlew clean rUG

Afterward, the User Guide can be found at this path:

hibernate-orm\documentation\target\asciidoc\userguide\html_single\Hibernate_User_Guide.html

#3

Thanks, it worked perfectly, except that I ran the command with the gradle itself, no with the wrapper

$ gradle clean rUG

BTW rUGis the abbreviation for read User Guide or something? do you know in which script is it defined?


#4

In Gradle, you can use abbreviations.

So for testClasses, you get tC. For renderUserGuide, you get rUG.