Skip to content
This repository was archived by the owner on Jan 30, 2024. It is now read-only.

Commit 71ca528

Browse files
authored
Merge pull request #7 from dkdeploy/release/1.1
Release/1.1
2 parents 895b64f + c8a4864 commit 71ca528

File tree

4 files changed

+44
-14
lines changed

4 files changed

+44
-14
lines changed

.travis.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
sudo: false
2+
language: ruby
3+
cache: bundler
4+
script: "bundle exec jekyll build"
5+
rvm:
6+
- 2.2.5

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,40 @@
11
# dkdeploy documentation
22

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

5+
This repository contains the documentation for dkdeploy. It is powered by [Jekyll](https://jekyllrb.com) 3.1.
6+
7+
## How to build it locally
8+
9+
### Technical Requirements
10+
11+
* OS X or Linux
12+
* Ruby >= 2.2
13+
14+
### Installation
15+
16+
1. Clone this repository
17+
2. Go inside the repository
18+
3. Run `bundle install`
19+
4. Run `bundle exec jekyll build`, the documentation will created within the `_site` folder
20+
21+
Have a look at the [Jekyll documentation](https://jekyllrb.com/docs/usage/) for the numerous ways to build the documentation.
22+
23+
## Contributing
24+
25+
1. Install [git flow](https://github.com/nvie/gitflow)
26+
2. Install [Homebrew](http://brew.sh/)
27+
3. Install [NodeJS](https://nodejs.org) (supported: v0.12.7) via `brew install nodejs`
28+
4. Install [Bower](http://bower.io) (supported: v1.7.9) via `npm install -g bower@1.7.9`
29+
5. If project is not checked out already do `git clone git@github.com:dkdeploy/dkdeploy.github.io.git`
30+
6. Checkout origin develop branch (`git checkout --track -b develop origin/develop`)
31+
7. Git flow initialze `git flow init -d`
32+
8. Create new feature branch (`git flow feature start my-new-feature`)
33+
9. Commit your changes (`git commit -am 'Add some feature'`)
34+
35+
## User Interface: Bower & npm Setup
36+
37+
1. Go into the `foundation` directory
38+
2. Run `npm install`
39+
3. Run `bower install`
40+
4. Run `npm start` to watch changes within the `scss` folder.

_data/navigation.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,4 +100,4 @@
100100
# href: "/faq/"
101101
- title: "Github"
102102
section: "github"
103-
href: "/github.html"
103+
href: "https://github.com/dkdeploy"

github.html

Lines changed: 0 additions & 13 deletions
This file was deleted.

0 commit comments

Comments
 (0)