calcite-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jh...@apache.org
Subject calcite git commit: Instructions for Avatica site
Date Mon, 07 Mar 2016 20:47:07 GMT
Repository: calcite
Updated Branches:
  refs/heads/master d3f1969cb -> a547222bd


Instructions for Avatica site


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

Branch: refs/heads/master
Commit: a547222bd331640c38b1ab474085f64f0242db98
Parents: d3f1969
Author: Julian Hyde <jhyde@apache.org>
Authored: Mon Mar 7 12:40:20 2016 -0800
Committer: Julian Hyde <jhyde@apache.org>
Committed: Mon Mar 7 12:45:10 2016 -0800

----------------------------------------------------------------------
 avatica/site/README.md   | 34 ++++++++++++++--------------------
 avatica/site/_config.yml |  2 +-
 site/README.md           | 17 +++++++++++++----
 3 files changed, 28 insertions(+), 25 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/calcite/blob/a547222b/avatica/site/README.md
----------------------------------------------------------------------
diff --git a/avatica/site/README.md b/avatica/site/README.md
index ea3f212..bd80bf1 100644
--- a/avatica/site/README.md
+++ b/avatica/site/README.md
@@ -17,25 +17,24 @@ limitations under the License.
 {% endcomment %}
 -->
 
-# Apache Calcite docs site
+# Apache Calcite Avatica site
 
-This directory contains the code for the Apache Calcite web site,
-[calcite.apache.org](https://calcite.apache.org/).
+This directory contains the code for the
+[Avatica web site](https://calcite.apache.org/avatica),
+a sub-directory of the
+[Apache Calcite web site](https://calcite.apache.org).
 
 ## Setup
 
-1. `cd site`
-2. `svn co https://svn.apache.org/repos/asf/calcite/site target`
-3. `sudo apt-get install rubygems ruby2.1-dev zlib1g-dev` (linux)
-4. `sudo gem install bundler github-pages jekyll jekyll-oembed`
-5. `bundle install`
+1. Set up Calcite web site as described in its
+   [README](../site/README.md).
 
 ## Add javadoc
 
-1. `cd ..`
+1. `cd avatica`
 2. `mvn -DskipTests site`
-3. `rm -rf site/target/apidocs site/target/testapidocs`
-4. `mv target/site/apidocs target/site/testapidocs site/target`
+3. `rm -rf ../site/target/avatica/apidocs ../site/target/avatica/testapidocs`
+4. `mv target/site/apidocs target/site/testapidocs ../site/target/avatica`
 
 ## Running locally
 
@@ -43,15 +42,10 @@ Before opening a pull request, you can preview your contributions by
 running from within the directory:
 
 1. `bundle exec jekyll serve`
-2. Open [http://localhost:4000](http://localhost:4000)
+2. Open [http://localhost:4000/avatica](http://localhost:4000/avatica)
 
 ## Pushing to site
 
-1. `cd site/target`
-2. `svn status`
-3. You'll need to `svn add` any new files
-4. `svn ci`
-
-Within a few minutes, svnpubsub should kick in and you'll be able to
-see the results at
-[calcite.apache.org](https://calcite.apache.org/).
+Push the Calcite site, which includes `avatica` as a sub-directory,
+as described in its
+[README](../site/README.md).

http://git-wip-us.apache.org/repos/asf/calcite/blob/a547222b/avatica/site/_config.yml
----------------------------------------------------------------------
diff --git a/avatica/site/_config.yml b/avatica/site/_config.yml
index c765da2..69affb7 100644
--- a/avatica/site/_config.yml
+++ b/avatica/site/_config.yml
@@ -18,7 +18,7 @@ permalink: /news/:year/:month/:day/:title/
 excerpt_separator: ""
 
 repository: https://github.com/apache/calcite
-destination: target
+destination: ../../site/target/avatica
 exclude: [README.md,Gemfile*]
 keep_files: [".git", ".svn", "apidocs", "testapidocs"]
 

http://git-wip-us.apache.org/repos/asf/calcite/blob/a547222b/site/README.md
----------------------------------------------------------------------
diff --git a/site/README.md b/site/README.md
index ea3f212..3b247a5 100644
--- a/site/README.md
+++ b/site/README.md
@@ -47,11 +47,20 @@ running from within the directory:
 
 ## Pushing to site
 
-1. `cd site/target`
-2. `svn status`
-3. You'll need to `svn add` any new files
-4. `svn ci`
+1. `cd site`
+2. `svn co https://svn.apache.org/repos/asf/calcite/site target`
+3. `cd target`
+4. `svn status`
+5. You'll need to `svn add` any new files
+6. `svn ci`
 
 Within a few minutes, svnpubsub should kick in and you'll be able to
 see the results at
 [calcite.apache.org](https://calcite.apache.org/).
+
+This process also publishes Avatica's web site. Avatica's web site has
+separate source (under `avatica/site`) but configures Jekyll to
+generate files to `site/target/avatica`, which becomes an
+[avatica](http://calcite.apache.org/avatica)
+sub-directory when deployed. See
+[Avatica site README](../avatica/site/README.md).


Mime
View raw message