Skip to content

Commit

Permalink
Update the readme for the site.
Browse files Browse the repository at this point in the history
  • Loading branch information
omalley committed May 13, 2015
1 parent 70a1e68 commit 8f399e4
Showing 1 changed file with 18 additions and 3 deletions.
21 changes: 18 additions & 3 deletions site/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,25 @@
# Apache ORC docs site

This directory contains the code for the Apache ORC docs site, [orc.apache.org](https://orc.apache.org/).
This directory contains the code for the Apache ORC web site,
[orc.apache.org](https://orc.apache.org/).

## Setup

1. `cd site`
2. `git clone https://git-wip-us.apache.org/repos/asf/orc.git -b asf-site target`
3. `sudo gem install bundler`
4. `sudo gem install github-pages jeykll`
4. `bundle install`

## Running locally

You can preview your contributions before opening a pull request by running from within the directory:
1. `gem install bundler`
2. `bundle install`
3. `bundle exec jekyll serve`

## Pushing to site

1. `cd site/target`
2. `git status`
3. You'll need to `git add` any new files
4. `git commit -a`
5. `git push origin asf-site`

0 comments on commit 8f399e4

Please sign in to comment.