You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by an...@apache.org on 2013/11/08 19:58:33 UTC
git commit: updated refs/heads/master to 233ba26
Updated Branches:
refs/heads/master 4d96941f6 -> 233ba26a1
is misleading when using the terms 'book' and 'chapter' in the
documentation. Replaced these words with document and others
Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/233ba26a
Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/233ba26a
Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/233ba26a
Branch: refs/heads/master
Commit: 233ba26a111f469878d81d7e43bccf297d897177
Parents: 4d96941
Author: Andy Wenk <an...@apache.org>
Authored: Fri Nov 8 19:41:29 2013 +0100
Committer: Andy Wenk <an...@apache.org>
Committed: Fri Nov 8 19:41:29 2013 +0100
----------------------------------------------------------------------
share/doc/src/api/database/changes.rst | 5 +++--
share/doc/src/couchapp/views/nosql.rst | 4 ++--
share/doc/src/couchapp/views/pagination.rst | 2 +-
share/doc/src/intro/api.rst | 24 ++++++++++++------------
share/doc/src/intro/consistency.rst | 4 ++--
share/doc/src/intro/security.rst | 2 +-
share/doc/src/intro/tour.rst | 12 ++++++------
share/doc/src/intro/why.rst | 16 ++++++++--------
8 files changed, 35 insertions(+), 34 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/couchdb/blob/233ba26a/share/doc/src/api/database/changes.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/api/database/changes.rst b/share/doc/src/api/database/changes.rst
index c414c67..ba99596 100644
--- a/share/doc/src/api/database/changes.rst
+++ b/share/doc/src/api/database/changes.rst
@@ -48,7 +48,8 @@
:query string feed: see :ref:`changes`. Default is ``normal``.
:query string filter: Reference to a :ref:`filter function <filterfun>`
from a design document that will filter whole stream emitting only filtered
- events. See the `section in the book`_ for more information.
+ events. See the section `Change Notifications in the book
+ CouchDB The Definitive Guide`_ for more information.
:query number heartbeat: Period in *milliseconds* after which an empty line is
sent in the results. Only applicable for :ref:`longpoll <changes/longpoll>`
or :ref:`continuous <changes/continuous>` feeds. Overrides any timeout to
@@ -340,7 +341,7 @@ results.
Obviously, `... tum tee tum ...` does not appear in the actual response, but
represents a long pause before the change with seq 6 occurred.
-.. _section in the book: http://guide.couchdb.org/draft/notifications.html
+.. _Change Notifications in the book CouchDB The Definitive Guide: http://guide.couchdb.org/draft/notifications.html
.. _changes/eventsource:
http://git-wip-us.apache.org/repos/asf/couchdb/blob/233ba26a/share/doc/src/couchapp/views/nosql.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/couchapp/views/nosql.rst b/share/doc/src/couchapp/views/nosql.rst
index 3337f9c..876d985 100644
--- a/share/doc/src/couchapp/views/nosql.rst
+++ b/share/doc/src/couchapp/views/nosql.rst
@@ -20,7 +20,7 @@ View Cookbook for SQL Jockeys
This is a collection of some common SQL queries and how to get the same result
in CouchDB. The key to remember here is that CouchDB does not work like an SQL
database at all and that best practices from the SQL world do not translate well
-or at all to CouchDB. This chapter’s “cookbook” assumes that you are familiar
+or at all to CouchDB. This documents’s “cookbook” assumes that you are familiar
with the CouchDB basics such as creating and updating databases and documents.
Using Views
@@ -331,7 +331,7 @@ For example, from a list of integer values that specify the age, calculate the
sum of all years of life for the news headline,
`“786 life years present at event.”` A little contrived, but very simple and
thus good for demonstration purposes. Consider the documents and the map view we
-used earlier in this chapter.
+used earlier in this document.
The reduce function to calculate the total age of all girls is:
http://git-wip-us.apache.org/repos/asf/couchdb/blob/233ba26a/share/doc/src/couchapp/views/pagination.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/couchapp/views/pagination.rst b/share/doc/src/couchapp/views/pagination.rst
index 0d805ae..b40f988 100644
--- a/share/doc/src/couchapp/views/pagination.rst
+++ b/share/doc/src/couchapp/views/pagination.rst
@@ -77,7 +77,7 @@ names that make up one page, and a link for the previous five,
if we’re not on the first page.
We learned how to use the ``startkey``, ``limit``, and ``skip`` parameters in
-earlier chapters. We’ll use these again here. First, let’s have a look at
+earlier documents. We’ll use these again here. First, let’s have a look at
the full result set:
.. code-block:: javascript
http://git-wip-us.apache.org/repos/asf/couchdb/blob/233ba26a/share/doc/src/intro/api.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/intro/api.rst b/share/doc/src/intro/api.rst
index 67c8f5b..3fb413a 100644
--- a/share/doc/src/intro/api.rst
+++ b/share/doc/src/intro/api.rst
@@ -17,18 +17,18 @@
The Core API
============
-This chapter explores the CouchDB in minute detail. It shows all the
+This document explores the CouchDB in minute detail. It shows all the
nitty-gritty and clever bits. We show you best practices and guide you around
common pitfalls.
-We start out by revisiting the basic operations we ran in the last chapter,
-looking behind the scenes. We also show what Futon needs to do behind its
-user interface to give us the nice features we saw earlier.
+We start out by revisiting the basic operations we ran in the previous document
+:ref:`intro/tour`, looking behind the scenes. We also show what Futon needs to
+do behind its user interface to give us the nice features we saw earlier.
-This chapter is both an introduction to the core CouchDB API as well as a
+This document is both an introduction to the core CouchDB API as well as a
reference. If you can't remember how to run a particular request or why some
parameters are needed, you can always come back here and look things up (we
-are probably the heaviest users of this chapter).
+are probably the heaviest users of this document).
While explaining the API bits and pieces, we sometimes need to take a larger
detour to explain the reasoning for a particular request. This is a good
@@ -322,7 +322,7 @@ The last two lines are curl telling us that it kept the TCP connection it
opened in the beginning open for a moment, but then closed it after it
received the entire response.
-Throughout the book, we'll show more requests with the ``-v`` option,
+Throughout the documents, we'll show more requests with the ``-v`` option,
but we'll omit some of the headers we've seen here and include only those
that are important for the particular request.
@@ -496,12 +496,12 @@ work, and less code is always good because the ratio of defects per lines of
code is static.
The revision system also has positive effects on replication and storage
-mechanisms, but we'll explore these later in the book.
+mechanisms, but we'll explore these later in the documents.
.. warning::
The terms *version* and *revision* might sound familiar (if you are
- programming without version control, drop this book right now and start
+ programming without version control, stop reading this guide right now and start
learning one of the popular systems). Using new versions for document changes
works a lot like version control, but there's an important difference:
**CouchDB does not guarantee that older versions are kept around**.
@@ -636,8 +636,8 @@ In a simple :method:`POST` request, you tell CouchDB the *source* and the
document revisions are on *source* that are not yet on *target*, and will
proceed to move the missing documents and revisions over.
-We'll take an in-depth look at replication later in the book; in this
-chapter, we'll just show you how to use it.
+We'll take an in-depth look at replication in the document :ref:`replication/intro`;
+in this document, we'll just show you how to use it.
First, we'll create a target database. Note that CouchDB won't automatically
create a target database for you, and will return a replication failure if
@@ -747,7 +747,7 @@ operations::
requests don't look very RESTy to the trained eye. What's up with that?
While CouchDB's core database, document, and attachment API are RESTful,
not all of CouchDB's API is. The replication API is one example. There are
- more, as we'll see later in the book.
+ more, as we'll see later in the documents.
Why are there RESTful and non-RESTful APIs mixed up here? Have the developers
been too lazy to go REST all the way? Remember, REST is an architectural
http://git-wip-us.apache.org/repos/asf/couchdb/blob/233ba26a/share/doc/src/intro/consistency.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/intro/consistency.rst b/share/doc/src/intro/consistency.rst
index d10040b..96519c3 100644
--- a/share/doc/src/intro/consistency.rst
+++ b/share/doc/src/intro/consistency.rst
@@ -17,8 +17,8 @@
Eventual Consistency
====================
-In the previous chapter, we saw that CouchDB's flexibility allows us to
-evolve our data as our applications grow and change. In this chapter,
+In the previous document :ref:`intro/why`, we saw that CouchDB's flexibility allows us to
+evolve our data as our applications grow and change. In this topic,
we'll explore how working "with the grain" of CouchDB promotes simplicity in
our applications and helps us naturally build scalable, distributed systems.
http://git-wip-us.apache.org/repos/asf/couchdb/blob/233ba26a/share/doc/src/intro/security.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/intro/security.rst b/share/doc/src/intro/security.rst
index 4a4b17e..bc4a679 100644
--- a/share/doc/src/intro/security.rst
+++ b/share/doc/src/intro/security.rst
@@ -17,7 +17,7 @@
Security
********
-In this chapter, we'll look at the basic security mechanisms in CouchDB: the
+In this document, we'll look at the basic security mechanisms in CouchDB: the
`Admin Party`, `Basic Authentication`, `Cookie Authentication`; how CouchDB
handles users and protects their credentials.
http://git-wip-us.apache.org/repos/asf/couchdb/blob/233ba26a/share/doc/src/intro/tour.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/intro/tour.rst b/share/doc/src/intro/tour.rst
index b8f9975..061f79f 100644
--- a/share/doc/src/intro/tour.rst
+++ b/share/doc/src/intro/tour.rst
@@ -17,7 +17,7 @@
Getting Started
===============
-In this chapter, we'll take a quick tour of CouchDB's features,
+In this document, we'll take a quick tour of CouchDB's features,
familiarizing ourselves with Futon, the built-in administration interface.
We'll create our first document and experiment with CouchDB views.
@@ -28,7 +28,7 @@ All Systems Are Go!
We'll have a very quick look at CouchDB's bare-bones Application Programming
Interface (API) by using the command-line utility curl. Please note that this
is not the only way of talking to CouchDB. We will show you plenty more
-throughout the rest of the book. What's interesting about curl is that it
+throughout the rest of the documents. What's interesting about curl is that it
gives you control over raw HTTP requests, and you can see exactly what is
going on "underneath the hood" of your database.
@@ -175,8 +175,8 @@ To load Futon in your browser, visit::
http://127.0.0.1:5984/_utils/
If you're running version 0.9 or later, you should see something similar to
-:ref:`intro/tour-01`. In later chapters, we'll focus on using CouchDB from
-server-side languages such as Ruby and Python. As such, this chapter is a great
+:ref:`intro/tour-01`. In later documents, we'll focus on using CouchDB from
+server-side languages such as Ruby and Python. As such, this document is a great
opportunity to showcase an example of natively serving up a dynamic web
application using nothing more than CouchDB's integrated web server, something
you may wish to do with your own applications.
@@ -282,7 +282,7 @@ should look like :ref:`intro/tour-04` document in Futon".
You'll notice that the document's _rev has changed. We'll go into more detail
-about this in later chapters, but for now, the important thing to note is
+about this in later documents, but for now, the important thing to note is
that _rev acts like a safety feature when saving a document. As long as you
and CouchDB agree on the most recent _rev of a document, you can successfully
save your changes.
@@ -534,7 +534,7 @@ Wrapping Up
Now that you've seen most of Futon's features, you'll be prepared to dive in
and inspect your data as we build our example application in the next few
-chapters. Futon's pure JavaScript approach to managing CouchDB shows how it's
+documents. Futon's pure JavaScript approach to managing CouchDB shows how it's
possible to build a fully featured web application using only CouchDB's HTTP
API and integrated web server.
http://git-wip-us.apache.org/repos/asf/couchdb/blob/233ba26a/share/doc/src/intro/why.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/intro/why.rst b/share/doc/src/intro/why.rst
index 1b902d8..8a76c48 100644
--- a/share/doc/src/intro/why.rst
+++ b/share/doc/src/intro/why.rst
@@ -18,11 +18,11 @@ Why CouchDB?
============
Apache CouchDB is one of a new breed of database management systems.
-This chapter explains why there's a need for new systems as well as the
+This topic explains why there's a need for new systems as well as the
motivations behind building CouchDB.
As CouchDB developers, we're naturally very excited to be using CouchDB.
-In this chapter we'll share with you the reasons for our enthusiasm.
+In this topic we'll share with you the reasons for our enthusiasm.
We'll show you how CouchDB's schema-free document model is a better fit
for common applications, how the built-in query engine is a powerful way
to use and process your data, and how CouchDB's design lends itself
@@ -32,9 +32,8 @@ to modularization and scalability.
Relax
=====
-If there's one word to describe CouchDB, it is *relax*. It is in the title of
-this book, it is the byline to CouchDB's official logo,
-and when you start CouchDB, you see::
+If there's one word to describe CouchDB, it is *relax*. It is the byline
+to CouchDB's official logo and when you start CouchDB, you see::
Apache CouchDB has started. Time to relax.
@@ -198,7 +197,7 @@ performance hit, CouchDB lets you build these systems.
There are a multitude of knobs you could turn to make a system work better in
one area, but you'll affect another area when doing so. One example would be
-the CAP theorem discussed in the next chapter. To give you an idea of other
+the CAP theorem discussed in :ref:`intro/consistency`. To give you an idea of other
things that affect storage systems, see :ref:`Figure 2 <intro/why-figure-02>`
and :ref:`Figure 3 <intro/why-figure-03>`.
@@ -311,5 +310,6 @@ less powerful than today's phones.
Wrapping Up
===========
-The next chapter further explores the distributed nature of CouchDB. We
-should have given you enough bites to whet your interest. Let's go!
+The next document :ref:`intro/consistency` further explores the distributed nature
+of CouchDB. We should have given you enough bites to whet your interest.
+Let's go!