Giter VIP home page Giter VIP logo

hibernate.org's Introduction

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 [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.

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.

hibernate.org's People

Contributors

yrodiere avatar gsmet avatar emmanuelbernard avatar davided avatar sanne avatar sebersole avatar hferentschik avatar dreab8 avatar gunnarmorling avatar gbadner avatar cheyenneweaver avatar unibrew avatar brmeyer avatar hibernate-ci avatar vladmihalcea avatar marko-bekhta avatar beikov avatar mbladel avatar gavinking avatar fax4ever avatar apat59 avatar misselvexu avatar lightguard avatar naros avatar insectengine avatar jrenaat avatar newtonm avatar leslieyork avatar adamw avatar xcoulon avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.