tribuo-site

This repo hosts the website for the Tribuo Java Machine Learning Library. Please visit the Tribuo GitHub Repo to report issues.

Updating the website

The tribuo-site relies on having the tribuo repo present as a submodule. When cloning this repo, be sure to use git clone --recurse-submodules <url>.

Some of the content in the site is generated automatically from the Tribuo repo. This is done by running two scripts (which should be re-run any time the tribuo repo is updated to prepare a website update):

$ bin/importDocs.sh
$ bin/importTutorials.sh

Finally, changes to tribuo.css or notebook.css must be shrunk down into the .min.css files. This can be done with a tool such as CSSO. If your IDE supports it, you can have it watch the .css files and automatically generate the minified files whenever they change.

To test locally

The first time you check out the code, you'll want to install the dependencies with

$ bundle install  # Just the first time

Then you can generate the site and run the web server with

$ bundle exec jekyll serve

Now, open localhost:4000 in your browser.

Contributing

This project welcomes contributions from the community. Before submitting a pull request, please review our contribution guide. Portions of this repository such as the documentation and tutorials are generated by processing the Tribuo repository, and as such any updates to that content should be integrated into the Tribuo repo first and then this repo should be regenerated.

Security

Please consult the security guide for our responsible security vulnerability disclosure process.