Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 2,478 Commits
_config		_config
_data		_data
_ext		_ext
_layouts		_layouts
_partials		_partials
_scripts		_scripts
_spec		_spec
community		community
design		design
dot-well-known		dot-well-known
dtd		dtd
images		images
javascripts		javascripts
metadata		metadata
ogm		ogm
orm		orm
others		others
presentations		presentations
reactive		reactive
repositories		repositories
search		search
shards		shards
stylesheets		stylesheets
tools		tools
validator		validator
xsd		xsd
.awestruct_ignore		.awestruct_ignore
.gitignore		.gitignore
.nojekyll		.nojekyll
404.html.haml		404.html.haml
CNAME		CNAME
Gemfile		Gemfile
Gemfile.lock		Gemfile.lock
Guardfile		Guardfile
Jenkinsfile		Jenkinsfile
LICENSE.txt		LICENSE.txt
NOTICE.txt		NOTICE.txt
README.adoc		README.adoc
Rakefile		Rakefile
google3584525ea82891db.html.haml		google3584525ea82891db.html.haml
google9616cdec3070007c.html.haml		google9616cdec3070007c.html.haml
hibernate-configuration-2.0.dtd		hibernate-configuration-2.0.dtd
hibernate-configuration-3.0.dtd		hibernate-configuration-3.0.dtd
hibernate-configuration.dtd		hibernate-configuration.dtd
hibernate-generic.dtd		hibernate-generic.dtd
hibernate-mapping-1.1.dtd		hibernate-mapping-1.1.dtd
hibernate-mapping-2.0.dtd		hibernate-mapping-2.0.dtd
hibernate-mapping-3.0.dtd		hibernate-mapping-3.0.dtd
hibernate-mapping.dtd		hibernate-mapping.dtd
hibernate-reverse-engineering-3.0.dtd		hibernate-reverse-engineering-3.0.dtd
index.html.haml		index.html.haml
nhibernate.html.haml		nhibernate.html.haml
robots.txt.haml		robots.txt.haml
survival-guide.adoc		survival-guide.adoc
tabcontent.html		tabcontent.html

Repository files navigation

How to build hibernate.org

A bit of Git, a bit of Ruby and you will get your local hibernate.org served.

Table of Contents

Get the source

> git clone git@github.com:hibernate/hibernate.org.git> cd hibernate.org

Set up the build environment — the easy way

The easiest way to set up a build environment is to use docker.

Seehttps://github.com/hibernate/awestruct-build-env.

Set up the build environment — the hard way

If you want to run everything directly on your machine without using Docker, first good luck,and then you’ll need to reproduce the environment detailed inhttps://github.com/hibernate/awestruct-build-env/blob/main/Dockerfile.

Setup awestruct

> rake setup

Serve the site locally

rake preview

Point your browser tohttp://localhost:4242

Tips & Tricks

How to edit/publish content

Refer to thisguide

Which other tasks exist in the Rake build file?

> rake --tasks

This will list the available tasks with a short description

I am getting errors when trying to executeawestruct directly

You need to usebundle exec <command> to make sure you get all required Gems. Check theRakefileto see how the different awestruct calls are wrapped.

If you are getting error after an update

> rake clean[all]> rake setup> rake preview

If your changes are not visible…

Panic! Then completely regenerate the site via:

> rake clean preview

License

The content of this repository is released under theASL 2.0.

By submitting a "pull request" or otherwise contributing to this repository, youagree to license your contribution under the respective licenses mentioned above.