[18/18] storm git commit: add README.md for docs/website

[pt...@apache.org]

add README.md for docs/website


Project: http://git-wip-us.apache.org/repos/asf/storm/repo
Commit: http://git-wip-us.apache.org/repos/asf/storm/commit/65d828a0
Tree: http://git-wip-us.apache.org/repos/asf/storm/tree/65d828a0
Diff: http://git-wip-us.apache.org/repos/asf/storm/diff/65d828a0

Branch: refs/heads/master
Commit: 65d828a0488f710737bcfdbed857ab37994279c0
Parents: 98014a5
Author: P. Taylor Goetz <pt...@gmail.com>
Authored: Fri Dec 5 12:27:20 2014 -0500
Committer: P. Taylor Goetz <pt...@gmail.com>
Committed: Fri Dec 5 12:27:20 2014 -0500

----------------------------------------------------------------------
 docs/README.md | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/storm/blob/65d828a0/docs/README.md
----------------------------------------------------------------------
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..b990bba
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,38 @@
+# Apache Storm Website and Documentation
+This is the source for the Storm website and documentation. It is statically generated using [jekyll](http://jekyllrb.com).
+
+
+## Site Generation
+First install jekyll (assuming you have ruby installed):
+
+```
+gem install jekyll
+```
+
+Generate the site, and start a server locally:
+```
+cd docs
+jekyll serve -w
+```
+
+The `-w` option tells jekyll to watch for changes to files and regenerate the site automatically when any content changes.
+
+Point your browser to http://localhost:4000
+
+By default, jekyll will generate the site in a `_site` directory.
+
+
+## Publishing the Website
+In order to publish the website, you must have committer access to Storm's subversion repository.
+
+The Storm website is published using Apache svnpubsub. Any changes committed to subversion will be automatically published to storm.apache.org.
+
+To publish changes, tell jekyll to generate the site in the `publish` directory of subversion, then commit the changes:
+
+
+```
+cd docs
+jekyll build -d /path/to/svn/repo/publish
+cd /path/to/svn/repo/publish
+svn commit
+```