Skip to content
Permalink
Browse files
Update website build instructions - replace deprecated 'nanoc autocom…
…pile' command with 'nanoc compile' plus 'nanoc view'. Add adsf gem. Fix numbering of steps.
  • Loading branch information
davebarnes97 committed Feb 24, 2016
1 parent fffab45 commit 94489c006137701eb824daa0efb7c58c0a09575d
Showing 1 changed file with 12 additions and 8 deletions.
@@ -23,7 +23,7 @@ Install Pygments (Python-based syntax coloring library):
Install Nanoc and other Ruby Gems needed:

$ sudo gem install nanoc -v 3.8.0
$ sudo gem install pygments.rb htmlentities pandoc-ruby nokogiri rack mime-types
$ sudo gem install pygments.rb htmlentities pandoc-ruby nokogiri rack mime-types adsf

## How to change/update the website

@@ -35,20 +35,24 @@ If you are changing the actual content of the site, then find Markdown file that

If you need to change the layout or styling of the site, then you will probably need to change an HTML, JS or CSS file under the ``content`` directory.

## 2. Test your changes locally

To test locally, you can use the autocompiler (will build changes on every request) and check the website at [http://0.0.0.0:3000](http://0.0.0.0:3000)

$ nanoc autocompile

## 3. Publish your changes to the site
### 2. Generate the site

Run the nanoc compiler to generate the site. It is configured via the ``nanoc.yaml`` to place website files into the ``content`` directory at the top

$ nanoc compile

Run ``git status`` and you should see your changes plus some update files under the ``${geode-project-dir}/content`` directory.

### 3. Test your changes locally

To test locally, use the view command to start a local web server. Check the website at [http://0.0.0.0:3000](http://0.0.0.0:3000)

$ nanoc view

To make changes, stop the web server, edit files, recompile, and view again.

### 4. Publish your changes to the site

Once you are happy with your changes, commit them, merge to the __asf-site__ branch and push.

The site should update in 5-10 minutes and if not [file a JIRA against the INFRA project](https://issues.apache.org/jira/browse/INFRA) or ask for advice on the Infrastructure project's HipChat room [#asfinfra](https://www.hipchat.com/g4P84gemn).

0 comments on commit 94489c0

Please sign in to comment.