Skip to content
This repository was archived by the owner on Jan 30, 2024. It is now read-only.
6 changes: 6 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
sudo: false
language: ruby
cache: bundler
script: "bundle exec jekyll build"
rvm:
- 2.2.5
37 changes: 37 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,40 @@
# dkdeploy documentation

![Travis CI Build Status](https://travis-ci.org/dkdeploy/dkdeploy.github.io.svg?branch=master)

This repository contains the documentation for dkdeploy. It is powered by [Jekyll](https://jekyllrb.com) 3.1.

## How to build it locally

### Technical Requirements

* OS X or Linux
* Ruby >= 2.2

### Installation

1. Clone this repository
2. Go inside the repository
3. Run `bundle install`
4. Run `bundle exec jekyll build`, the documentation will created within the `_site` folder

Have a look at the [Jekyll documentation](https://jekyllrb.com/docs/usage/) for the numerous ways to build the documentation.

## Contributing

1. Install [git flow](https://github.com/nvie/gitflow)
2. Install [Homebrew](http://brew.sh/)
3. Install [NodeJS](https://nodejs.org) (supported: v0.12.7) via `brew install nodejs`
4. Install [Bower](http://bower.io) (supported: v1.7.9) via `npm install -g bower@1.7.9`
5. If project is not checked out already do `git clone git@github.com:dkdeploy/dkdeploy.github.io.git`
6. Checkout origin develop branch (`git checkout --track -b develop origin/develop`)
7. Git flow initialze `git flow init -d`
8. Create new feature branch (`git flow feature start my-new-feature`)
9. Commit your changes (`git commit -am 'Add some feature'`)

## User Interface: Bower & npm Setup

1. Go into the `foundation` directory
2. Run `npm install`
3. Run `bower install`
4. Run `npm start` to watch changes within the `scss` folder.
2 changes: 1 addition & 1 deletion _data/navigation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -100,4 +100,4 @@
# href: "/faq/"
- title: "Github"
section: "github"
href: "/github.html"
href: "https://github.com/dkdeploy"
13 changes: 0 additions & 13 deletions github.html

This file was deleted.