You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by de...@apache.org on 2013/10/01 15:46:33 UTC
[23/50] [abbrv] git commit: updated refs/heads/replicator-redesign to
066d69b
Make main page a bit nicer and friendly.
Looks weird and empty, but we'll fix it later with more content and redesign.
Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/18735b67
Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/18735b67
Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/18735b67
Branch: refs/heads/replicator-redesign
Commit: 18735b6794fb2a63f37038bb3ebd5fdabe19d643
Parents: de48ff3
Author: Alexander Shorin <kx...@apache.org>
Authored: Thu Sep 12 04:58:16 2013 +0400
Committer: Alexander Shorin <kx...@apache.org>
Committed: Fri Sep 27 22:01:49 2013 +0400
----------------------------------------------------------------------
share/doc/build/Makefile.am | 4 +-
share/doc/src/conf.py | 7 +-
share/doc/src/contents.rst | 38 ++++++++
share/doc/src/index.rst | 38 --------
share/doc/templates/layout.html | 27 ++++++
share/doc/templates/pages/index.html | 156 ++++++++++++++++++++++++++++++
6 files changed, 227 insertions(+), 43 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/couchdb/blob/18735b67/share/doc/build/Makefile.am
----------------------------------------------------------------------
diff --git a/share/doc/build/Makefile.am b/share/doc/build/Makefile.am
index c13f8a2..1030dcd 100644
--- a/share/doc/build/Makefile.am
+++ b/share/doc/build/Makefile.am
@@ -260,7 +260,7 @@ html_files = \
html/index.html \
html/json-structure.html \
html/objects.inv \
- html/genindex.html \
+ html/http-api.html \
html/search.html \
html/searchindex.js
@@ -404,6 +404,8 @@ src_files = \
src_files_html = \
../static/rtd.css \
../templates/pages/download.html \
+ ../templates/pages/index.html \
+ ../templates/layout.html \
../templates/help.html \
../templates/searchbox.html \
../templates/utilities.html
http://git-wip-us.apache.org/repos/asf/couchdb/blob/18735b67/share/doc/src/conf.py
----------------------------------------------------------------------
diff --git a/share/doc/src/conf.py b/share/doc/src/conf.py
index 7c49bbf..bfdcd99 100644
--- a/share/doc/src/conf.py
+++ b/share/doc/src/conf.py
@@ -38,8 +38,6 @@ looks like there is no such file there.''')
source_suffix = ".rst"
-master_doc = "index"
-
nitpicky = True
version = '.'.join([
@@ -79,7 +77,7 @@ html_static_path = ["../static"]
html_title = ' '.join([
project,
version,
- 'Manual'
+ 'Documentation'
])
html_style = "rtd.css"
@@ -91,7 +89,8 @@ html_favicon = "../images/favicon.ico"
html_use_index = False
html_additional_pages = {
- 'download': 'pages/download.html'
+ 'download': 'pages/download.html',
+ 'index': 'pages/index.html'
}
html_context = {}
http://git-wip-us.apache.org/repos/asf/couchdb/blob/18735b67/share/doc/src/contents.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/contents.rst b/share/doc/src/contents.rst
new file mode 100644
index 0000000..f00aed6
--- /dev/null
+++ b/share/doc/src/contents.rst
@@ -0,0 +1,38 @@
+.. Licensed 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.
+
+
+|Apache CouchDB(TM)|_ |release| Documentation
+=============================================
+
+.. toctree::
+ :maxdepth: 3
+ :numbered:
+
+ intro/index
+ install/index
+ config/index
+ replication/index
+ maintenance/index
+ couchapp/index
+ externals
+ query-server/index
+ fauxton/index
+ api/index
+ json-structure
+ contributing
+ whatsnew/index
+ cve/index
+
+.. This is how you get a TM sign into a link. Haha. Seriously.
+.. |Apache CouchDB(TM)| unicode:: Apache U+0020 CouchDB U+2122
+.. _Apache CouchDB(TM): http://couchdb.apache.org/
http://git-wip-us.apache.org/repos/asf/couchdb/blob/18735b67/share/doc/src/index.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/index.rst b/share/doc/src/index.rst
deleted file mode 100644
index f00aed6..0000000
--- a/share/doc/src/index.rst
+++ /dev/null
@@ -1,38 +0,0 @@
-.. Licensed 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.
-
-
-|Apache CouchDB(TM)|_ |release| Documentation
-=============================================
-
-.. toctree::
- :maxdepth: 3
- :numbered:
-
- intro/index
- install/index
- config/index
- replication/index
- maintenance/index
- couchapp/index
- externals
- query-server/index
- fauxton/index
- api/index
- json-structure
- contributing
- whatsnew/index
- cve/index
-
-.. This is how you get a TM sign into a link. Haha. Seriously.
-.. |Apache CouchDB(TM)| unicode:: Apache U+0020 CouchDB U+2122
-.. _Apache CouchDB(TM): http://couchdb.apache.org/
http://git-wip-us.apache.org/repos/asf/couchdb/blob/18735b67/share/doc/templates/layout.html
----------------------------------------------------------------------
diff --git a/share/doc/templates/layout.html b/share/doc/templates/layout.html
new file mode 100644
index 0000000..f5d1f2f
--- /dev/null
+++ b/share/doc/templates/layout.html
@@ -0,0 +1,27 @@
+<!--
+
+Licensed 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.
+
+-->
+
+{% extends "!layout.html" %}
+{{ rellinks.append(('contents', 'Contents', '', 'Contents')) }}
+{%- block rootrellink %}
+ <li><a href="{{ pathto('index') }}">{{ shorttitle|e }}</a>{{ reldelim1 }}</li>
+{%- endblock %}
+{%- block sidebarlogo %}
+ {%- if logo %}
+ <p class="logo"><a href="{{ pathto('index') }}">
+ <img class="logo" src="{{ pathto('_static/' + logo, 1) }}" alt="Logo"/>
+ </a></p>
+ {%- endif %}
+{%- endblock %}
http://git-wip-us.apache.org/repos/asf/couchdb/blob/18735b67/share/doc/templates/pages/index.html
----------------------------------------------------------------------
diff --git a/share/doc/templates/pages/index.html b/share/doc/templates/pages/index.html
new file mode 100644
index 0000000..5d3b9b4
--- /dev/null
+++ b/share/doc/templates/pages/index.html
@@ -0,0 +1,156 @@
+<!--
+
+Licensed 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.
+
+-->
+
+{% extends "defindex.html" %}
+{% block tables %}
+<h2>Meet CouchDB</h2>
+<table class="contentstable" align="center">
+ <tr>
+ <td width="50%">
+ <p class="biglink">
+ <a class="biglink" href="{{ pathto("whatsnew/" + version) }}">
+ What's new in CouchDB {{ version }}?
+ </a>
+ <br />
+ <span class="linkdescr">
+ or browse <a href="{{ pathto("whatsnew/index") }}">all "What's new" documents</a>
+ </span>
+ </p>
+ <p class="biglink">
+ <a class="biglink" href="{{ pathto("intro/why") }}">
+ Why CouchDB?
+ </a>
+ <br />
+ <span class="linkdescr">reasons to use CouchDB is there</span>
+ </p>
+ <td width="50%">
+ <p class="biglink">
+ <a class="biglink" href="{{ pathto("intro/overview") }}">
+ Technical Overview
+ </a>
+ <br />
+ <span class="linkdescr">quick overview about base technologies</span>
+ </p>
+ <p class="biglink">
+ <a class="biglink" href="{{ pathto("intro/consistency") }}">
+ Eventual Consistency
+ </a>
+ <br />
+ <span class="linkdescr">the main conception of document databases</span>
+ </p>
+ </td>
+ </tr>
+</table>
+
+<h2>Getting started</h2>
+<table class="contentstable" align="center">
+ <tr>
+ <td width="50%">
+ <p class="biglink">
+ <a class="biglink" href="{{ pathto("install/index") }}">
+ Installation guides
+ </a>
+ <br />
+ <span class="linkdescr">
+ install CouchDB on <a href="{{ pathto("install/windows") }}">Windows</a>,
+ <a href="{{ pathto("install/macos") }}">MacOS X</a> or
+ <a href="{{ pathto("install/unix") }}">Linux</a> in few minutes.
+ </span>
+ </p>
+ <p class="biglink">
+ <a class="biglink" href="{{ pathto("intro/tour") }}">
+ Tutorial
+ </a>
+ <br />
+ <span class="linkdescr">start using CouchDB with
+ <a href="{{ pathto("intro/futon") }}">Futon</a> and
+ <a href="{{ pathto("intro/curl") }}">cURL</a></span>
+ </p>
+ <p class="biglink">
+ <a class="biglink" href="{{ pathto("intro/api") }}">
+ HTTP API overview
+ </a>
+ <br />
+ <span class="linkdescr">short walk though API basics</span>
+ </p>
+ <td width="50%">
+ <p class="biglink">
+ <a class="biglink" href="{{ pathto("couchapp/views/intro") }}">
+ Guide to Views
+ </a>
+ <br />
+ <span class="linkdescr">how query JSON data with no sql</span>
+ </p>
+ <p class="biglink">
+ <a class="biglink" href="{{ pathto("replication/intro") }}">
+ Data Replication
+ </a>
+ <br />
+ <span class="linkdescr">
+ painless master-master data synchronization
+ </span>
+ </p>
+ <p class="biglink">
+ <a class="biglink" href="{{ pathto("config/index") }}">
+ Configuration Reference
+ </a>
+ <br />
+ <span class="linkdescr">tweak CouchDB like you want</span>
+ </p>
+ </td>
+ </tr>
+</table>
+
+<h2>Developing with CouchDB</h2>
+<table class="contentstable" align="center"><tr>
+ <tr>
+ <td width="50%">
+ <p class="biglink">
+ <a class="biglink" href="{{ pathto("api/index") }}">
+ Complete HTTP API Reference
+ </a>
+ <br />
+ <span class="linkdescr">
+ your favourite bookmark
+ </span>
+ </p>
+ <td width="50%">
+ <p class="biglink">
+ <a class="biglink" href="{{ pathto("couchapp/ddocs") }}">
+ Design Documents
+ </a>
+ <br />
+ <span class="linkdescr">
+ transform, update and validate documents like a rock star
+ </span>
+ </p>
+ </td>
+ </tr>
+</table>
+
+
+<h2>Links</h2>
+<table class="contentstable" align="center"><tr>
+ <td width="50%">
+ <p class="biglink"><a class="biglink" href="{{ pathto("contents") }}">Documentation Contents</a></p>
+ <p class="biglink"><a class="biglink" href="{{ pathto("http-api") }}">HTTP API Index</a></p>
+ <p class="biglink"><a class="biglink" href="{{ pathto("contributing") }}">Contributing to this Documentation</a></p>
+ </td><td width="50%">
+ <p class="biglink"><a class="biglink" href="http://couchdb.org/">CouchDB Web site</a></p>
+ <p class="biglink"><a class="biglink" href="http://couchdb.org/#download">Download</a></p>
+ <p class="biglink"><a class="biglink" href="http://couchdb.org/#mailing-list">Mailing Lists</a></p>
+ </td></tr>
+</table>
+{% endblock %}