README.md

OpenCrowbar Documentation README

This is not the documentation you are looking for. it is a pointer to the real documentation in the documentation directory

Looking for Crowbar Resources?

The Crowbar website has links to all information and is our recommended starting place.

Specific Crowbar Documentation

We track Crowbar documentation with the code so that we can track versions of documentation with the code. It is located in the /doc directory.

Background

Crowbar documentation is distributed into multiple places under the /doc directory of each Crowbar module (aka "barclamps"). When the modules are installed, Crowbar combines all the /doc directories into a master documentation set. These directories are structured into subdirectories for general topics. This structure is common across all barclamps in the Crowbar project

Please, do NOT add documentation in locations besides =/doc=! If necessary, expand this README to include pointers to important /doc information.

Short Term notes for OpenCrowbar Development Environment

1. cd crowbar/rails
2. bundle install --verbose
3. script/rails generate delayed_job:active_record
4. script/rails generate rails_settings:migration
5. rake db:create db:migrate
6. script/delayed_job --queue=NodeRoleRunner -n 2 start
7. rails s Puma development
8. use Crowbar!
   1. http://localhost:3000
   2. run the BDD test environment (see /doc/devguide/testing/bdd)
9. script/delayed_job stop