You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by wo...@apache.org on 2017/07/05 06:30:37 UTC
[couchdb-documentation] branch master updated: couchapps -> ddocs
This is an automated email from the ASF dual-hosted git repository.
wohali pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/couchdb-documentation.git
The following commit(s) were added to refs/heads/master by this push:
new 4670c71 couchapps -> ddocs
4670c71 is described below
commit 4670c710115a8e7bb6f1f9e7fdfb132276cda24b
Author: Joan Touzet <jo...@atypical.net>
AuthorDate: Wed Jul 5 02:20:06 2017 -0400
couchapps -> ddocs
* remove all references to couchapps in the documentation
* include an explanation as to why this change has been made
---
NOTICE | 4 +--
src/contents.rst | 2 +-
src/couchapp/index.rst | 30 ------------------
src/{couchapp => ddocs}/ddocs.rst | 0
src/ddocs/index.rst | 46 ++++++++++++++++++++++++++++
src/{couchapp => ddocs}/views/collation.rst | 0
src/{couchapp => ddocs}/views/index.rst | 0
src/{couchapp => ddocs}/views/intro.rst | 0
src/{couchapp => ddocs}/views/joins.rst | 0
src/{couchapp => ddocs}/views/nosql.rst | 0
src/{couchapp => ddocs}/views/pagination.rst | 0
src/intro/index.rst | 26 ++++++++--------
templates/pages/index.html | 4 +--
13 files changed, 63 insertions(+), 49 deletions(-)
diff --git a/NOTICE b/NOTICE
index 40f4289..f093282 100644
--- a/NOTICE
+++ b/NOTICE
@@ -18,11 +18,11 @@ This product also includes the following third-party components:
Copyright 2008-2010, Paul Joseph Davis <pa...@gmail.com>
- * src/couchapp/views/intro.rst src/couchapp/views/nosql.rst src/couchapp/views/pagination.rst
+ * src/ddocs/views/intro.rst src/ddocs/views/nosql.rst src/ddocs/views/pagination.rst
Copyright 2013, Creative Commons Attribution license
- * src/couchapp/views/joins.rst (Using View Collation)
+ * src/ddocs/views/joins.rst (Using View Collation)
Copyright 2007, Christopher Lenz <cm...@gmail.com>
diff --git a/src/contents.rst b/src/contents.rst
index 29b947f..786d126 100644
--- a/src/contents.rst
+++ b/src/contents.rst
@@ -23,7 +23,7 @@
config/index
replication/index
maintenance/index
- couchapp/index
+ ddocs/index
externals
query-server/index
fauxton/index
diff --git a/src/couchapp/index.rst b/src/couchapp/index.rst
deleted file mode 100644
index e0938f5..0000000
--- a/src/couchapp/index.rst
+++ /dev/null
@@ -1,30 +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.
-
-.. _couchapp:
-
-========
-CouchApp
-========
-
-`CouchApps`_ are web applications served directly from CouchDB, mostly driven by
-JavaScript and HTML5. If you can fit your application into those constraints,
-then you get CouchDB's scalability and flexibility "for free" (and deploying
-your app is as simple as replicating it to the production server).
-
-.. _CouchApps: http://couchapp.org/
-
-.. toctree::
- :maxdepth: 2
-
- ddocs
- views/index
diff --git a/src/couchapp/ddocs.rst b/src/ddocs/ddocs.rst
similarity index 100%
rename from src/couchapp/ddocs.rst
rename to src/ddocs/ddocs.rst
diff --git a/src/ddocs/index.rst b/src/ddocs/index.rst
new file mode 100644
index 0000000..858d758
--- /dev/null
+++ b/src/ddocs/index.rst
@@ -0,0 +1,46 @@
+.. 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.
+
+.. _indexes:
+
+================
+Design Documents
+================
+
+CouchDB supports special documents within databases known as "design
+documents". These documents, mostly driven by JavaScript you write, are used
+to build indexes, validate document updates, format query results, and filter
+replications.
+
+.. toctree::
+ :maxdepth: 2
+
+ ddocs
+ views/index
+
+*Note*: Previously, the functionality provided by CouchDB's design documents,
+in combination with document attachments, was referred to as "CouchApps." The
+general principle was that entire web applications could be hosted in CouchDB,
+without need for an additional application server.
+
+Use of CouchDB as a combined standalone database and application server is no
+longer recommended. There are significant limitations to a pure CouchDB web
+server application stack, including but not limited to: fully-fledged
+fine-grained security, robust templating and scaffolding, complete developer
+tooling, and most importantly, a thriving ecosystem of developers, modules and
+frameworks to choose from.
+
+The developers of CouchDB believe that web developers should pick "the right
+tool for the right job". Use CouchDB as your database layer, in conjunction
+with any number of other server-side web application frameworks, such as the
+entire Node.JS ecosystem, Python's Django and Flask, PHP's Drupal, Java's
+Apache Struts, and more.
diff --git a/src/couchapp/views/collation.rst b/src/ddocs/views/collation.rst
similarity index 100%
rename from src/couchapp/views/collation.rst
rename to src/ddocs/views/collation.rst
diff --git a/src/couchapp/views/index.rst b/src/ddocs/views/index.rst
similarity index 100%
rename from src/couchapp/views/index.rst
rename to src/ddocs/views/index.rst
diff --git a/src/couchapp/views/intro.rst b/src/ddocs/views/intro.rst
similarity index 100%
rename from src/couchapp/views/intro.rst
rename to src/ddocs/views/intro.rst
diff --git a/src/couchapp/views/joins.rst b/src/ddocs/views/joins.rst
similarity index 100%
rename from src/couchapp/views/joins.rst
rename to src/ddocs/views/joins.rst
diff --git a/src/couchapp/views/nosql.rst b/src/ddocs/views/nosql.rst
similarity index 100%
rename from src/couchapp/views/nosql.rst
rename to src/ddocs/views/nosql.rst
diff --git a/src/couchapp/views/pagination.rst b/src/ddocs/views/pagination.rst
similarity index 100%
rename from src/couchapp/views/pagination.rst
rename to src/ddocs/views/pagination.rst
diff --git a/src/intro/index.rst b/src/intro/index.rst
index fe3bb72..681af9a 100644
--- a/src/intro/index.rst
+++ b/src/intro/index.rst
@@ -18,23 +18,21 @@ Introduction
CouchDB is a database that completely embraces the web. Store your data with
JSON documents. Access your documents with your web browser, :ref:`via HTTP
-<api/basics>`. :ref:`Query <api/doc>`, :ref:`combine <views>`,
-and :ref:`transform <listfun>` your documents with :ref:`JavaScript
-<query-server/js>`. CouchDB works well with modern web and mobile apps. You can
-even serve web apps directly out of CouchDB. And you can distribute your data,
-or your apps, efficiently using CouchDB’s :ref:`incremental replication
-<replication/intro>`. CouchDB supports master-master setups with
+<api/basics>`. :ref:`Query <api/doc>`, :ref:`combine <views>`, and
+:ref:`transform <listfun>` your documents with :ref:`JavaScript
+<query-server/js>`. CouchDB works well with modern web and mobile apps. You
+can distribute your data, efficiently using CouchDB’s :ref:`incremental
+replication <replication/intro>`. CouchDB supports master-master setups with
:ref:`automatic conflict <replication/conflicts>` detection.
CouchDB comes with a suite of features, such as on-the-fly document
-transformation and real-time :ref:`change notifications <changes>`, that makes
-:ref:`web app <couchapp>` development a breeze. It even comes with an easy
-to use web administration console. You guessed it,
-served up directly out of CouchDB! We care a lot about `distributed scaling`_.
-CouchDB is highly available and partition tolerant, but is also :ref:`eventually
-consistent <intro/consistency>`. And we care *a lot* about your data.
-CouchDB has a fault-tolerant storage engine that puts the safety of your data
-first.
+transformation and real-time :ref:`change notifications <changes>`, that make
+web development a breeze. It even comes with an easy to use web administration
+console, served directly out of CouchDB! We care a lot about `distributed
+scaling`_. CouchDB is highly available and partition tolerant, but is also
+:ref:`eventually consistent <intro/consistency>`. And we care *a lot* about
+your data. CouchDB has a fault-tolerant storage engine that puts the safety
+of your data first.
In this section you'll learn about every basic bit of CouchDB, see upon what
conceptions and technologies it built and walk through short tutorial that
diff --git a/templates/pages/index.html b/templates/pages/index.html
index 099ea86..2ffe358 100644
--- a/templates/pages/index.html
+++ b/templates/pages/index.html
@@ -93,7 +93,7 @@ specific language governing permissions and limitations under the License.
</p>
<td width="50%">
<p class="biglink">
- <a class="biglink" href="{{ pathto("couchapp/views/intro") }}">
+ <a class="biglink" href="{{ pathto("ddocs/views/intro") }}">
Guide to Views
</a>
<br />
@@ -118,7 +118,7 @@ specific language governing permissions and limitations under the License.
</span>
</p>
<p class="biglink">
- <a class="biglink" href="{{ pathto("couchapp/ddocs") }}">
+ <a class="biglink" href="{{ pathto("ddocs/ddocs") }}">
Design Documents
</a>
<br />
--
To stop receiving notification emails like this one, please contact
['"commits@couchdb.apache.org" <co...@couchdb.apache.org>'].