buzzardo / steeltoe-site

Content for http://steeltoe.io

Steeltoe Main Site

It is built using Middleman

Install Dependencies

Uses Gemfile to pull in necessary dependencies.

Prerequisite Ruby must be installed

bundle install

Local testing of Steeltoe site

This will build the docs locally.

middleman build

This will spin up development server with a build of the local documentation.

middleman serve

Visit site locally at http://localhost:4567

Instructions for Updating Documentation Staging Site

All documentation will be updated in the dev branch. Once the documentation looks correct in the Steeltoe Staging site, the dev branch should be merged into master. This will be the production site at steeltoe.io

Branches and Builds

Branch Build (1.x)

The 1.x branch will build with dev and master branches. There is no staging for the 1.x branch, so all commits will kick off a production build or staging build. The 1.x documentation will be available at Steeltoe Staging 1.x and Steeltoe.io 1.x

Development Build (dev)

Any commit to the dev branch is automatically built and added to the Steeltoe Staging site.

Production Build (master)

Important: Pushing the to the remote master branch will update the main Steeltoe.io site.

Any commit to the master branch is automatically built and added to the Steeltoe.io site.