diff options
author | Alexander Shorin <kxepal@apache.org> | 2013-09-12 04:58:16 +0400 |
---|---|---|
committer | Alexander Shorin <kxepal@apache.org> | 2013-09-27 22:01:49 +0400 |
commit | 18735b6794fb2a63f37038bb3ebd5fdabe19d643 (patch) | |
tree | 5044a2b02b1e840f7fc74ee7872601e7d845aee2 | |
parent | de48ff311b223563b302b5e93bd9feba66543c47 (diff) | |
download | couchdb-18735b6794fb2a63f37038bb3ebd5fdabe19d643.tar.gz |
Make main page a bit nicer and friendly.
Looks weird and empty, but we'll fix it later with more content and redesign.
-rw-r--r-- | share/doc/build/Makefile.am | 4 | ||||
-rw-r--r-- | share/doc/src/conf.py | 7 | ||||
-rw-r--r-- | share/doc/src/contents.rst (renamed from share/doc/src/index.rst) | 0 | ||||
-rw-r--r-- | share/doc/templates/layout.html | 27 | ||||
-rw-r--r-- | share/doc/templates/pages/index.html | 156 |
5 files changed, 189 insertions, 5 deletions
diff --git a/share/doc/build/Makefile.am b/share/doc/build/Makefile.am index c13f8a25d..1030dcd95 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 diff --git a/share/doc/src/conf.py b/share/doc/src/conf.py index 7c49bbf89..bfdcd9930 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 = {} diff --git a/share/doc/src/index.rst b/share/doc/src/contents.rst index f00aed6be..f00aed6be 100644 --- a/share/doc/src/index.rst +++ b/share/doc/src/contents.rst diff --git a/share/doc/templates/layout.html b/share/doc/templates/layout.html new file mode 100644 index 000000000..f5d1f2f54 --- /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 %} diff --git a/share/doc/templates/pages/index.html b/share/doc/templates/pages/index.html new file mode 100644 index 000000000..5d3b9b435 --- /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 %} |