Bean Validation website
HTML Other
Failed to load latest commit information.
1.0 Convert certified to asciidoc for 1.0 Feb 10, 2016
1.1 Fix incorrect relative link usage in Asciidoc files Mar 9, 2016
_config Remove unused properties from configuration Feb 16, 2016
_ext Use relative extension for links instead of base_url, except for Atom… Feb 16, 2016
_layouts Use relative extension for links instead of base_url, except for Atom… Feb 16, 2016
_partials Use relative extension for links instead of base_url, except for Atom… Feb 16, 2016
_scripts
contribute
downloads Providing article on Bean Validation for download Dec 18, 2012
fonts Add FontAwesome fonts files Feb 9, 2016
images Fixes after review Feb 8, 2016
latest-draft/spec Add folder latest-draft/spec Feb 12, 2016
news Bean Validation 2.0 announcement Jul 15, 2016
proposals Convert BVAL-508 to Asciidoc Feb 24, 2016
stylesheets
.awestruct_ignore Do not copy Rakefile, Gemfile and co in _site Aug 26, 2014
.gitignore Add .bundle to gitignore Aug 25, 2014
.htaccess
404.html.haml Initial commit Jul 22, 2011
CNAME Add beanvalidation.org CNAME file Feb 16, 2016
Gemfile Additional dependencies for sassc Feb 12, 2016
Gemfile.lock Additional dependencies for sassc Feb 12, 2016
Guardfile BVAL-473 Adding Guardfile for live reload Jan 17, 2014
README.md BVAL-480 Adding README.md to explain how to build the site Jun 13, 2014
Rakefile Fixes after review Feb 8, 2016
favicon.ico
glossary.md
index.adoc Fix incorrect relative link usage in Asciidoc files Mar 9, 2016
licensing.md Using patternfly.org template Feb 8, 2016
roadmap.md BVAL-214 Initial proposal Feb 24, 2016

README.md

How to build beanvalidation.org

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

Prerequisites

  • Get Git
  • Get a Ruby > 1.9
  • Get RVM to manage separate Ruby environments (optional - you should know what and why you do it)

Installation

Get the source

> git clone https://github.com/beanvalidation/beanvalidation.org.git
> cd beanvalidation.org

Rake

Make sure Rake is available. It is often installed per default.

> rake --version
rake, version 0.9.6

If you get command not found:

gem install rake

Bundler

Make sure Bundler is available. It manages your Ruby gems locally to the project and prevents version conflicts between different Ruby projects. To quote from the website:

Bundler provides a consistent environment for Ruby projects by tracking and installing the exact gems and versions that are needed.

> bundle -v
Bundler version 1.6.2

If you get command not found:

gem install bundler

Install dependencies

rake setup[local]
rake check

Serve the site locally

rake preview

Point your browser to http://localhost:4242

Tips & Tricks

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