You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@cloudstack.apache.org by se...@apache.org on 2015/05/11 20:52:50 UTC

cloudstack-www git commit: new README

Repository: cloudstack-www
Updated Branches:
  refs/heads/asf-site cae23d478 -> c616feb06


new README


Project: http://git-wip-us.apache.org/repos/asf/cloudstack-www/repo
Commit: http://git-wip-us.apache.org/repos/asf/cloudstack-www/commit/c616feb0
Tree: http://git-wip-us.apache.org/repos/asf/cloudstack-www/tree/c616feb0
Diff: http://git-wip-us.apache.org/repos/asf/cloudstack-www/diff/c616feb0

Branch: refs/heads/asf-site
Commit: c616feb06f609d5ab7c4f3b22c9c04503f80cd89
Parents: cae23d4
Author: Sebastien Goasguen <ru...@gmail.com>
Authored: Mon May 11 20:52:45 2015 +0200
Committer: Sebastien Goasguen <ru...@gmail.com>
Committed: Mon May 11 20:52:45 2015 +0200

----------------------------------------------------------------------
 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/cloudstack-www/blob/c616feb0/README.md
----------------------------------------------------------------------
diff --git a/README.md b/README.md
index bbbb623..c65d913 100644
--- a/README.md
+++ b/README.md
@@ -1,2 +1,27 @@
 Source of Apache CloudStack Web site
 ====================================
+
+This is built using [middleman](https://middlemanapp.com)
+
+    $ gem install middleman
+
+All sources are in the `/source` directory
+
+Build the site with:
+
+    $ middleman build
+
+To serve it locally:
+
+    $ middleman server
+
+To publish your changes, commit the build into the asf-site directory
+
+GOTCHA, *TODO*, the `build` directory needs to be renamed `content` in the asf-site branch for the site to be served properly.
+
+*TODO* check the `build.sh` script and make it better, simple build that stages all changes to `/content`
+
+Use GitHub PR to make changes.
+
+*TODO* Add gitHUB PR contribution instructions and better build instructions for committers
+