jboss.org/tools website
Ruby HTML CSS JavaScript Shell
Switch branches/tags
build-production-2018-02-19-14-16-15-2814 build-production-2018-02-13-20-46-46-2811 build-production-2018-01-31-07-44-47-2797 build-production-2018-01-29-07-10-22-2794 build-production-2018-01-15-16-57-24-2773 build-production-2018-01-10-07-44-58-2765 build-production-2017-12-26-12-30-53-2758 build-production-2017-12-13-07-42-28-2751 build-production-2017-11-22-08-57-44-2743 build-production-2017-11-08-14-40-13-2723 build-production-2017-11-06-11-34-26-2720 build-production-2017-10-11-07-51-15-2702 build-production-2017-10-11-07-49-48-2700 build-production-2017-10-10-07-58-13-2696 build-production-2017-10-09-15-22-41-2693 build-production-2017-10-09-08-48-22-2691 build-production-2017-10-06-09-18-09-2688 build-production-2017-09-20-12-46-50-2684 build-production-2017-09-20-07-07-08-2679 build-production-2017-09-20-06-49-03-2676 build-production-2017-09-19-11-27-51-2672 build-production-2017-09-15-13-20-13-2669 build-production-2017-09-14-16-43-51-2666 build-production-2017-09-14-15-10-36-2662 build-production-2017-08-28-21-11-56-2650 build-production-2017-08-26-15-23-00-2648 build-production-2017-08-21-14-53-57-2645 build-production-2017-08-21-14-45-56-2643 build-production-2017-08-21-14-37-21-2641 build-production-2017-08-14-17-06-59-2632 build-production-2017-08-14-16-41-37-2630 build-production-2017-08-09-09-05-49-2624 build-production-2017-08-09-08-38-16-2621 build-production-2017-08-07-15-34-09-2618 build-production-2017-08-04-18-25-30-2614 build-production-2017-07-27-11-52-44-2603 build-production-2017-07-26-16-57-36-2601 build-production-2017-07-20-23-40-34-2596 build-production-2017-07-19-11-10-02-2593 build-production-2017-07-18-15-00-55-2588 build-production-2017-07-17-16-22-29-2583 build-production-2017-07-14-14-38-03-2579 build-production-2017-07-13-13-17-30-2574 build-production-2017-07-07-16-11-41-2571 build-production-2017-07-05-16-33-48-2568 build-production-2017-06-30-16-05-53-2563 build-production-2017-06-30-15-08-22-2561 build-production-2017-06-28-16-21-49-2553 build-production-2017-06-28-15-55-42-2551 build-production-2017-06-07-19-06-46-2543 build-production-2017-06-07-11-09-24-2538 build-production-2017-05-24-14-15-56-2529 build-production-2017-05-24-12-27-25-2526 build-production-2017-05-22-12-17-17-2524 build-production-2017-05-19-12-31-53-2520 build-production-2017-05-18-15-15-24-2517 build-production-2017-05-17-20-06-54-2514 build-production-2017-05-16-14-44-31-2509 build-production-2017-04-27-12-48-59-2495 build-production-2017-04-26-07-49-07-2491 build-production-2017-04-13-09-56-15-2479 build-production-2017-04-05-10-38-11-2477 build-production-2017-03-30-16-56-51-2470 build-production-2017-03-15-22-29-43-2465 build-production-2017-03-15-22-22-18-2463 build-production-2017-03-15-22-19-44-2461 build-production-2017-03-15-21-49-59-2459 build-production-2017-03-01-12-59-39-2448 build-production-2017-02-28-07-22-31-2443 build-production-2017-02-24-11-56-14-2439 build-production-2017-02-23-13-05-03-2432 build-production-2017-02-20-09-17-24-2414 build-production-2017-02-18-23-31-26-2412 build-production-2017-02-13-12-23-01-2409 build-production-2017-02-10-11-04-14-2406 build-production-2017-02-02-14-56-16-2402 build-production-2017-02-02-14-39-02-2399 build-production-2017-01-31-07-36-10-2394 build-production-2017-01-25-19-01-52-2384 build-production-2017-01-25-17-44-53-2373 build-production-2017-01-25-17-31-54-2371 build-production-2017-01-25-17-02-54-2368 build-production-2017-01-25-15-04-21-2366 build-production-2017-01-11-21-55-57-2363 build-production-2017-01-11-21-48-01-2361 build-production-2017-01-09-16-25-45-2354 build-production-2016-12-22-19-22-42-2351 build-production-2016-12-15-11-51-21-2348 build-production-2016-12-12-18-40-12-2337 build-production-2016-12-12-09-14-09-2333 build-production-2016-12-07-23-11-46-2329 build-production-2016-12-07-22-16-15-2327 build-production-2016-12-07-14-45-18-2321 build-production-2016-12-06-13-55-41-2319 build-production-2016-11-18-08-25-02-2310 build-production-2016-11-10-17-11-31-2307 build-production-2016-11-10-10-19-02-2304 build-production-2016-10-20-13-50-19-2291 build-production-2016-10-18-23-28-09-2285 build-production-2016-10-17-07-43-44-2282
Nothing to show
Latest commit b70e488 Feb 19, 2018
pleacu JBTIS 4.5.2.Funbal/ DevstudioIS 11.2.0.GA (#796)
Signed-off-by: Paul Leacu <pleacu@redhat.com>
Permalink
Failed to load latest commit information.
.openshift Fixing issues with Travis task May 2, 2013
_bin first blog import experiment Sep 3, 2012
_config JBTIS 4.5.2.Funbal/ DevstudioIS 11.2.0.GA (#796) Feb 19, 2018
_data/team Add John Steele icons (#784) Jan 15, 2018
_ext JBIDE-24898 replace hardcoded refs to Eclipse Neon and JBT 4.4 with d… Aug 28, 2017
_layouts JBIDE-24670 show all versions of N+N, even on archived pages; add Arc… Jul 20, 2017
_partials JBIDE-18498 - Display the "development release" alert on all alpha/be… Oct 7, 2014
blog JBTIS 4.5.2.Funbal/ DevstudioIS 11.2.0.GA (#796) Feb 19, 2018
cat JBIDE-23302 yet more fixes to solve https links Dec 12, 2016
community product forum urls was broken Jan 26, 2015
documentation JBIDE-25624 - Fuse Tooling N&N 10.3.0.AM1 (JBT 4.5.3.AM1) (#793) Feb 9, 2018
downloads JBIDE-24898 replace hardcoded refs to Eclipse Neon and JBT 4.4 with d… Aug 28, 2017
events Add EclipseCon France 2016 talk events Apr 15, 2016
features renamed to fusetools / Fuse Tooling Jul 14, 2017
fonts/font-awesome Upgrading fontawesome (fixing missing icon in FF) Dec 19, 2014
getinvolved Add text to suspend the JBT CAT program. Refer users to AERI instead. Jul 14, 2016
images JBIDE-16364 - Improve site performances Sep 23, 2014
javascripts JBIDE-23302 yet more fixes to solve https links Dec 12, 2016
stylesheets JBIDE-24670 show all versions of N+N, even on archived pages; add Arc… Jul 20, 2017
usage JBIDE-23302 yet more fixes to solve https links Dec 12, 2016
.ackrc Upgrade to use latest awestruct Apr 8, 2015
.awestruct_ignore Make updatedate in atomizer use last modified git commit for the blog… Sep 6, 2014
.dockerignore docker support for running awestruct. Nov 14, 2014
.gitignore blog on mars beta release Jun 23, 2015
.ruby-gemset Added missing jboss tools/IS downloads and handle entries without dow… Feb 19, 2014
.rultor.yml add rultor specific merge test to rake (properly this time) Jul 20, 2015
.travis.yml add removed stuff back in: cache and bundler_args Sep 14, 2017
Dockerfile Fix Dockefile (nodejs) Aug 29, 2017
Gemfile JBIDE-22670 - tools.jboss.org/downloads refers to devstudio 9.1.0 eve… Jun 28, 2016
Gemfile.lock Updated RedCloth dependency (#778) Dec 21, 2017
Guardfile Working on layout Nov 28, 2012
Rakefile add rultor specific merge test to rake (properly this time) Jul 20, 2015
atom.template.haml ensure atom.news always have one root element Jan 27, 2015
contribute.html.haml Removing empty 'default' layout and fixing missing images on .adoc fe… Dec 3, 2013
dockerrun.sh chmod +x dockerrun.sh Dec 12, 2017
index.html.haml Add text to suspend the JBT CAT program. Refer users to AERI instead. Jul 14, 2016
project.properties JBIDE-23302 yet more fixes to solve https links Dec 12, 2016
readme.adoc JBIDE-23302 more changes to support https:// Dec 12, 2016
survivalguide.adoc JBIDE-23302 yet more fixes to solve https links Dec 12, 2016

readme.adoc

How to build tools.jboss.org

Build Status

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

The simplest way to use this is to use our automatically built docker image. See https://hub.docker.com/r/jbosstools/jbosstools-website/.

   $ docker pull jbosstools/jbosstools-website
   $ git clone https://github.com/jbosstools/jbosstools-website
   $ cd jbosstools-website
   $ docker run -it --rm -p 4242:4242 -v `pwd`:/jbosstools-website jbosstools/jbosstools-website /bin/bash
Warning
On Linux (SELinux, Fedora), you may experience permission issues inside the container on the jbosstools-website folder. Add a trailing :Z to the volume. The command will now be:
   $ docker run -it --rm -p 4242:4242 -v `pwd`:/jbosstools-website:Z jbosstools/jbosstools-website /bin/bash

Now in the Docker you can do:

   $ cd /jbosstools-website
   $ rake clean preview

and you can browse the result at http://$DOCKER_HOST:4242.

Everything else below is if you want to run awestruct "natively".

Prerequisites

  • Get Git

  • Get Ruby 2.2.0 (part of the RVM install if you follow that path - see below)

  • Get RubyGems 1.3.6 or above

  • Get GNU Wget 1.14

  • If on Linux, you might need to install stuff for nokogiri (sudo yum install libxml libxml-devel libxslt libxslt-devel)

  • If on Linux, you need to install node.js for execjs ('sudo yum install nodejs')

  • If on Mac OS, get XCode (needed for native gems)

Installation

Git

Install Git to your system. GitHub’s help page is a good starting point. If you are looking for some tips and tricks, checkout Emmanuel’s blog.

Ruby (via RVM)

Ruby like many other platforms has its dependency hell. We do recommend you use RVM to isolate your ruby runtimes as well as dependencies (gems). The RVM steps are optional though. If you are not going to use RVM have a look at the different installations options you have.

Note: This installation varies per OS, see details on rvm.io.

For Linux/Fedora: \curl -sSL https://get.rvm.io | bash is the simplest and no root required). Note that for 'rvm' to be activated you need to run as a login shell. When running rvm it should tell you if you are running in a proper terminal/login.

  • Set up the isolated environment for the site

# Do *not* run these as root.
# The purpose of using rvm is to have non-root, user isolated and reproducible gem/ruby environment
# During the rvm install it might ask to install system level packages, for these your user need to have sudo permissions
# or you have to run those installs as root seperately and then run rvm install again as a normal user
rvm install 2.2
rvm use 2.2
rvm gemset create jbosstools-website

Note: the project has a .ruby-gemset file which will be used by rvm when you enter the jbosstools-website directory. This file will assume you have the above installed.

Get the source

Next, let’s retrieve the website.

git clone https://github.com/jbosstools/jbosstools-website
cd jbosstools-website

If you see a message like this:

Gemset 'jbosstools-website' does not exist, 'rvm gemset create jbosstools-website' first, or append '--create'.

Then it is because you have rvm installed and forgot to run the rvm setup above.

Install Ruby dependencies

This next step might take some time - it is installing all the required dependencies.

# do *not* run these as root
gem install bundler
bundle install

Note that if someone updates Awestruct or any dependent gem via the Gemfile dependency management, you need to rerun bundle install.

Serve the site locally

  • Run rake preview

  • If you see a message like Could not find a JavaScript runtime. See https://github.com/sstephenson/execjs for a list of available runtimes this means nodejs is not installed.

  • Wait for a message like [2014-01-06 11:48:01] INFO WEBrick::HTTPServer#start: pid=24294 port=4242 to appear in the console (can take a few tens of seconds)

  • Open your browser to http://localhost:4242

Any change will be automatically picked up except for changes to _partials files and changes in front-matters.

Note

You might see warnings at startup as follows:

WARNING: Missing required dependency to activate optional built-in extension coffeescripttransform.rb
  cannot load such file -- coffee-script
Using profile: development
Generating site: http://localhost:4242
Skipping files cache update.
CodeRay::Scanners could not load plugin :bash; falling back to :text
CodeRay::Scanners could not load plugin :bash; falling back to :text
CodeRay::Scanners could not load plugin :bash; falling back to :text
CodeRay::Scanners could not load plugin :bash; falling back to :text
CodeRay::Scanners could not load plugin :bash; falling back to :text
CodeRay::Scanners could not load plugin :bash; falling back to :text
[Listen warning]:
The blocking parameter of Listen::Listener#start is deprecated.
Please use Listen::Adapter#start for a non-blocking listener and Listen::Listener#start! for a blocking one.

That’s ok, it’s not your fault ;) It’s related to some Awestruct limitations.

Next steps

Using you local site, you can have a look at our survival guide to editing this website to get you started.

If you are viewing this page while rendered locally this would be survivalguide.html instead.

Tips & Tricks

How to add a blog ?

To add a blog add a file to the blog folder, following the structure of this template

How to add New and Noteworthy

To add a new and noteworthy add a dir+file to the whatsnew folder, using one of the existing entries as a template.

Take care to ensure you have listed all the proper component and project versions and the site generation will automatically aggregate the news for the full release.

How do I exclude New and Noteworthy content from Final version ?

Sometimes a N&N in earlier versions are not appropriate in the Final release. To avoid having to manually create a full NN you can use a asciidoctor macro to skip content based on the finalnn property being defined.

Example:

ifndef::finalnn[]
== Really cool feature

This awesome feature is very dangerous and might be removed, but
for now it is in there.
endif::finalnn[]

If that is in version 1.0.0.Beta1 NN then it will still be listed in 1.0.0.Beta1 but for the 1.0.0.Final version it will not.

If your changes are not visible…​

completely regenerate the site via:

rake clean[all] preview

If serving the site is slow…​

On Linux, serving the file may be atrociously slow (something to do with WEBRick).

Use the following alternative:

  • Go in your ~/jbosstools-website directory.

  • Run awestruct --auto -P development

  • In parallel, go to the ~/jbosstools-website/_site directory

  • Run python -m SimpleHTTPServer 4242

You should be back to millisecond serving :)

Publishing/Deploying

Publishing of the site is done automatically via Travis CI when you publish to the 'master' or 'production' branch.

Build Status

If Travis build successfully it will automatically publish the result to the proper site.

Profile parameters

In _config/site.yml various profiles are configured. The following table documents some of the important parameters.

Name Values Description

showwip

boolean

if true a banner will be shown on top indicating it is a work in progress.

License

Sample code available on this website is released under EPL.

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. This README.adoc was based on hibernate.org README.adoc