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
• Set up the build environment — the easy way
• Set up the build environment — the hard way
  • Setup awestruct
• Serve the site locally
• Tips & Tricks
  • How to edit/publish content
  • Which other tasks exist in the Rake build file?
  • I am getting errors when trying to execute awestruct directly
  • If you are getting error after an update
  • If your changes are not visible…​
• License
• Acknowledgements

Get the source

> git clone [email protected]: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.

See https://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 in https://github.com/hibernate/awestruct-build-env/blob/main/Dockerfile.

Setup awestruct

> rake setup

Serve the site locally

rake preview

Point your browser to http://localhost:4242

Tips & Tricks

How to edit/publish content

Refer to this guide

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 execute awestruct directly

You need to use bundle exec <command> to make sure you get all required Gems. Check the Rakefile to 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 the ASL 2.0.

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

Acknowledgements

This website uses JBoss Community Bootstrap.