You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@geode.apache.org by ji...@apache.org on 2016/03/30 00:25:55 UTC
[25/50] [abbrv] incubator-geode git commit: GEODE-54: missing javadocs
GEODE-54: missing javadocs
Create docs landing page for Geode website
Add an href to javadocs
closes #113
Project: http://git-wip-us.apache.org/repos/asf/incubator-geode/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-geode/commit/91b70969
Tree: http://git-wip-us.apache.org/repos/asf/incubator-geode/tree/91b70969
Diff: http://git-wip-us.apache.org/repos/asf/incubator-geode/diff/91b70969
Branch: refs/heads/feature/GEODE-17-3
Commit: 91b70969ac8dc4067241870ab8a66c3c462d67c9
Parents: bec420b
Author: Dave Barnes <db...@pivotal.io>
Authored: Wed Feb 24 15:11:06 2016 -0800
Committer: Swapnil Bawaskar <sb...@pivotal.io>
Committed: Wed Mar 16 17:59:26 2016 -0700
----------------------------------------------------------------------
geode-site/website/README.md | 2 +-
geode-site/website/Rules | 3 --
geode-site/website/content/community/index.html | 2 +-
geode-site/website/content/docs/index.html | 48 ++++++++++++++++++++
geode-site/website/layouts/default.html | 32 -------------
geode-site/website/layouts/footer.html | 2 +-
geode-site/website/layouts/header.html | 2 +-
7 files changed, 52 insertions(+), 39 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/91b70969/geode-site/website/README.md
----------------------------------------------------------------------
diff --git a/geode-site/website/README.md b/geode-site/website/README.md
index a43efb7..6e50821 100644
--- a/geode-site/website/README.md
+++ b/geode-site/website/README.md
@@ -6,7 +6,7 @@ Source files for the website are in ``${geode-project-dir}/geode-site/website/co
Generated files for the website are in ``${geode-project-dir}/geode-site/content``
-The website is updated by a "sync" tool that monitors the __asf-site__ branch of our Git repo, so after to make changes you must push your updated source and generated files to that branch. The content will be published to the [Geode website](http://geode.incubator.apache.org), after a 5-20 minute delay.
+The website is updated by a "sync" tool that monitors the __asf-site__ branch of our Git repo, so after making changes you must push your updated source and generated files to that branch. The content will be published to the [Geode website](http://geode.incubator.apache.org), after a 5-20 minute delay.
## Prerequsites
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/91b70969/geode-site/website/Rules
----------------------------------------------------------------------
diff --git a/geode-site/website/Rules b/geode-site/website/Rules
index e1173df..5369385 100644
--- a/geode-site/website/Rules
+++ b/geode-site/website/Rules
@@ -35,9 +35,6 @@ passthrough /\/(bootstrap|css|font|img|js|static)\/.*/
compile '/docs/*' do
@docs = true
filter :erb
- filter :fenced_code_block
- filter :pandoc
- filter :colorize_syntax, :default_colorizer => :pygmentsrb, :pygmentsrb => { :options => { :startinline => 'True' } }
layout 'docs'
end
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/91b70969/geode-site/website/content/community/index.html
----------------------------------------------------------------------
diff --git a/geode-site/website/content/community/index.html b/geode-site/website/content/community/index.html
index 5c5f25f..5a695b2 100644
--- a/geode-site/website/content/community/index.html
+++ b/geode-site/website/content/community/index.html
@@ -128,7 +128,7 @@ under the License. -->
</div>
<div class="col-md-3">
<h3><a target="_blank" href="https://www.youtube.com/channel/UCaY2q0UlWjAgEGL7uhCLs6A">Geode ClubHouse</a></h3>
- <p>We meet every 15 days online for discussions around specific features, detailing internals and discuss on-going issues on JIRA at the Geode Clubhouse. All meetings are recorded and videos are availabe in our <a href="https://www.youtube.com/channel/UCaY2q0UlWjAgEGL7uhCLs6A">YouTube</a> channel.<p>
+ <p>We meet every 15 days online for discussions around specific features, detailing internals and discuss on-going issues on JIRA at the Geode Clubhouse. All meetings are recorded and videos are available in our <a href="https://www.youtube.com/channel/UCaY2q0UlWjAgEGL7uhCLs6A">YouTube</a> channel.<p>
</div>
</div>
</section>
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/91b70969/geode-site/website/content/docs/index.html
----------------------------------------------------------------------
diff --git a/geode-site/website/content/docs/index.html b/geode-site/website/content/docs/index.html
new file mode 100644
index 0000000..f848dc1
--- /dev/null
+++ b/geode-site/website/content/docs/index.html
@@ -0,0 +1,48 @@
+<!-- Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+"License"); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License. -->
+
+<!-- <div id="map-canvas" style="width: 100%;"></div> -->
+
+<section class="bf-tagline">
+ <div class="container">
+ <div class="row">
+ <br/>
+ <h2>Geode Documentation</h2>
+ </div>
+ </div>
+</section>
+
+
+<section class="bf-docs">
+ <div class="container">
+ <div class="row">
+ <div class="col-md-4">
+ <h3><a href="http://geode.docs.pivotal.io/" style="color: #1275ff;">Apache Geode (incubating) User Documentation</a></h3>
+ <p>Installation Instructions, User Manual, other product docs</p>
+ </div>
+ <div class="col-md-4">
+ <h3><a href="http://geode.incubator.apache.org/releases/10M2SNAP/javadocs/index.html" style="color: #1275ff;">Javadocs</a></h3>
+ <p>API Reference in conventional Javadoc format<p>
+ </div>
+ <div class="col-md-4">
+ <h3><a href="https://cwiki.apache.org/confluence/display/GEODE/Index" style="color: #1275ff;">Apache Geode Wiki</a></h3>
+ <p>Community contributions on various topics<p>
+ </div>
+ </div>
+ </div>
+</section>
+
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/91b70969/geode-site/website/layouts/default.html
----------------------------------------------------------------------
diff --git a/geode-site/website/layouts/default.html b/geode-site/website/layouts/default.html
index 5e5ba68..2e3e2cd 100644
--- a/geode-site/website/layouts/default.html
+++ b/geode-site/website/layouts/default.html
@@ -3,40 +3,8 @@
<%= render 'header', {:docs => @docs, :community => @community} %>
-<% if @docs %>
-<div class="container bf-docs-container">
- <div class="row">
-
- <div class="col-md-9 main-article" role="main">
- <div class="page-article">
- <div class="page-header">
- <h1><%= @item[:title] %></h1>
- <!-- TODO: reenable this when we sync SVN to GitHub
- <small><a target="_blank" href="https://github.com/geode/website/blob/master/content<%= @item.path[0..-2] %>.md">contribute to this article on github</a></small>
- -->
- </div>
- <%= @content %>
- </div>
- </div>
- </div>
- <div class="row">
- <div class="col-md-3"></div>
- <div class="col-md-9">
- <div class="github-callout">
- <strong>Questions?</strong> Please do <a href="/community">ask on the mailing-lists</a>!<br/>
- <!--
- <strong>Found an error?</strong> We’d greatly appreciate a pull request about <a target="_blank" href="https://github.com/geode/website/blob/master/content<%= @item.path[0..-2] %>.md">this article on github</a>.</div>
- -->
- </div>
- </div>
- </div>
-</div>
-<% else %>
-
<%= @content %>
-<% end %>
-
<%= render 'footer' %>
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/91b70969/geode-site/website/layouts/footer.html
----------------------------------------------------------------------
diff --git a/geode-site/website/layouts/footer.html b/geode-site/website/layouts/footer.html
index ae38c13..3d31236 100644
--- a/geode-site/website/layouts/footer.html
+++ b/geode-site/website/layouts/footer.html
@@ -24,7 +24,7 @@
<ul class="nav nav-list">
<li class="nav-header">Resources</li>
<li><a href="http://github.com/apache/incubator-geode" target="_blank">GitHub Code</a></li>
- <li><a href="http://geode.docs.pivotal.io" target="_blank">Docs</a></li>
+ <li><a href="/docs/">Docs</a></li>
<li><a href="https://issues.apache.org/jira/browse/GEODE" target="_blank">JIRA Bug Tracker</a></li>
<li><a href="http://stackoverflow.com/search?q=Apache%20Geode" target="_blank">StackOverflow</a></li>
<li><a href="/community/#live">Live Chat</a></li>
http://git-wip-us.apache.org/repos/asf/incubator-geode/blob/91b70969/geode-site/website/layouts/header.html
----------------------------------------------------------------------
diff --git a/geode-site/website/layouts/header.html b/geode-site/website/layouts/header.html
index 4bffa61..e364fe4 100644
--- a/geode-site/website/layouts/header.html
+++ b/geode-site/website/layouts/header.html
@@ -231,7 +231,7 @@
<nav class="collapse navbar-collapse bf-navbar-collapse" role="navigation">
<ul class="nav navbar-nav navbar-right">
<li class="<%= 'active' if @community %>"><a href="/community/"><span class="icns icon-group"></span></a></li>
- <li><a href="http://geode.docs.pivotal.io" target="_blank"><span class="icns icon-book"></span></a></li>
+ <li class="<%= 'active' if @docs %>"><a href="/docs/"><span class="icns icon-book"></span></a></li>
<li><a href="http://github.com/apache/incubator-geode" target="_blank"><span class="icns icon-github-sign"></span></a></li>
<!--<li><a href="https://trello.com/b/exQmJIOn/usergrid" target="_blank"><span class="icns icon-trello"></span></a></li>-->
<li><a href="https://issues.apache.org/jira/browse/GEODE/"