Skip to content

Commit

Permalink
Update README.markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
weppos committed Mar 27, 2018
1 parent d0fcb79 commit 08dc77a
Showing 1 changed file with 25 additions and 15 deletions.
40 changes: 25 additions & 15 deletions README.markdown
Expand Up @@ -6,28 +6,34 @@ This is the [DNSimple Help site](https://support.dnsimple.com) built with [nanoc

Ruby 2, or higher, is required to build the site. Dependencies are managed using Bundler.

$ git clone https://github.com/dnsimple/dnsimple-support.git
$ cd dnsimple-support
$ bundle
```shell
git clone git@github.com:dnsimple/dnsimple-support.git
cd dnsimple-support
bundle
```

For a list of `nanoc` commands type

$ nanoc --help
```shell
nanoc --help
```

## Development

`nanoc` ships with an autocompiler that automatically compiles changed files on every HTTP request.

$ bundle exec nanoc live
```shell
bundle exec nanoc live

Loading site… done
Thin web server (v1.7.0 codename Dunder Mifflin)
Maximum connections set to 1024
Listening on 0.0.0.0:3000, CTRL+C to stop
Loading site… done
Thin web server (v1.7.0 codename Dunder Mifflin)
Maximum connections set to 1024
Listening on 0.0.0.0:3000, CTRL+C to stop

14:26:35 - INFO - Compilation succeeded.
14:26:35 - INFO - Guard is now watching at '~/projects/dnsimple-support'
```

14:26:35 - INFO - Compilation succeeded.
14:26:35 - INFO - Guard is now watching at '~/projects/dnsimple-support'

### Managing categories

You can add/remove/edit categories by editing the file `priorities/categories.yaml`.
Expand All @@ -50,9 +56,13 @@ To publish the site manually you will need Java (as the static deployer is writt

Add a `.env` file with following variables, replacing `ACCESS_ID` and `ACCESS_KEY` with the real values.

S3_ID=ACCESS_ID
S3_SECRET=ACCESS_KEY
```
S3_ID=ACCESS_ID
S3_SECRET=ACCESS_KEY
```

Finally, run:

$ rake publish
```shell
rake publish
```

0 comments on commit 08dc77a

Please sign in to comment.