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 2016/09/09 14:30:32 UTC
documentation commit: updated refs/heads/master to c4e7cd9
Repository: couchdb-documentation
Updated Branches:
refs/heads/master b427c8b1f -> c4e7cd929
Futon -> Fauxton; remove Windows build instructions
Project: http://git-wip-us.apache.org/repos/asf/couchdb-documentation/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb-documentation/commit/c4e7cd92
Tree: http://git-wip-us.apache.org/repos/asf/couchdb-documentation/tree/c4e7cd92
Diff: http://git-wip-us.apache.org/repos/asf/couchdb-documentation/diff/c4e7cd92
Branch: refs/heads/master
Commit: c4e7cd92910e3940b2bde904b3bce2041c36bf9d
Parents: b427c8b
Author: Joan Touzet <wo...@apache.org>
Authored: Fri Sep 9 10:30:12 2016 -0400
Committer: Joan Touzet <wo...@apache.org>
Committed: Fri Sep 9 10:30:12 2016 -0400
----------------------------------------------------------------------
src/api/server/common.rst | 4 +-
src/config/http-handlers.rst | 2 +-
src/config/http.rst | 6 +-
src/config/query-servers.rst | 7 +-
src/couchapp/views/intro.rst | 4 +-
src/install/windows.rst | 192 +-------------------------------------
src/intro/api.rst | 2 +-
src/intro/futon.rst | 178 -----------------------------------
src/intro/index.rst | 3 +-
src/intro/security.rst | 8 +-
src/intro/tour.rst | 178 ++++++++++++-----------------------
templates/pages/index.html | 2 +-
templates/utilities.html | 2 +-
13 files changed, 76 insertions(+), 512 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/c4e7cd92/src/api/server/common.rst
----------------------------------------------------------------------
diff --git a/src/api/server/common.rst b/src/api/server/common.rst
index ac58401..debd856 100644
--- a/src/api/server/common.rst
+++ b/src/api/server/common.rst
@@ -952,13 +952,13 @@ is as follows:
.. http:get:: /_utils
:synopsis: Redirects to /_utils/
- Accesses the built-in Futon administration interface for CouchDB.
+ Accesses the built-in Fauxton administration interface for CouchDB.
:>header Location: New URI location
:code 301: Redirects to :get:`/_utils/`
.. http:get:: /_utils/
- :synopsis: CouchDB administration interface (Futon)
+ :synopsis: CouchDB administration interface (Fauxton)
:>header Content-Type: :mimetype:`text/html`
:>header Last-Modified: Static files modification timestamp
http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/c4e7cd92/src/config/http-handlers.rst
----------------------------------------------------------------------
diff --git a/src/config/http-handlers.rst b/src/config/http-handlers.rst
index 7124303..a59fc1a 100644
--- a/src/config/http-handlers.rst
+++ b/src/config/http-handlers.rst
@@ -117,7 +117,7 @@ Global HTTP Handlers
.. config:option:: _utils
- The :ref:`_utils <api/server/utils>` handler serves `Futon`'s web
+ The :ref:`_utils <api/server/utils>` handler serves `Fauxton`'s web
administration page::
[httpd_global_handlers]
http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/c4e7cd92/src/config/http.rst
----------------------------------------------------------------------
diff --git a/src/config/http.rst b/src/config/http.rst
index b79eb7e..42d6275 100644
--- a/src/config/http.rst
+++ b/src/config/http.rst
@@ -253,10 +253,8 @@ Secure Socket Level Options
shell> chmod 600 privkey.pem couchdb.pem
shell> chown couchdb privkey.pem couchdb.pem
- Now, you need to edit CouchDB's configuration, either by editing your
- ``local.ini`` file or using the ``/_config`` API calls or the
- configuration screen in Futon. Here is what you need to do in
- ``local.ini``, you can infer what needs doing in the other places.
+ Now, you need to edit CouchDB's configuration, by editing your
+ ``local.ini`` file. Here is what you need to do.
At first, :option:`enable the HTTPS daemon <daemons/httpsd>`::
http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/c4e7cd92/src/config/query-servers.rst
----------------------------------------------------------------------
diff --git a/src/config/query-servers.rst b/src/config/query-servers.rst
index 88f2344..85b267e 100644
--- a/src/config/query-servers.rst
+++ b/src/config/query-servers.rst
@@ -131,15 +131,12 @@ Native Erlang Query Server
[native_query_servers]
erlang = {couch_native_process, start_link, []}
- To see these changes you will also need to restart the server. To test out
- using :ref:`Erlang views <query-server/erlang>`, visit the `Futon` admin
- interface, create a new database and open a temporary view. You should now
- be able to select ``erlang`` from the language drop-down.
+ To see these changes you will also need to restart the server.
Let's try an example of map/reduce functions which count the total
documents at each number of revisions (there are x many documents at
version "1", and y documents at "2"... etc). Add a few documents to the
- database, then enter the following functions as a temporary view:
+ database, then enter the following functions as a view:
.. code-block:: erlang
http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/c4e7cd92/src/couchapp/views/intro.rst
----------------------------------------------------------------------
diff --git a/src/couchapp/views/intro.rst b/src/couchapp/views/intro.rst
index 3ffaa66..6ac36cd 100644
--- a/src/couchapp/views/intro.rst
+++ b/src/couchapp/views/intro.rst
@@ -431,8 +431,8 @@ on the ``rereduce`` parameter:
This is the reduce view used by the example app to count comments, while
utilizing the map to output the comments, which are more useful than just
``1`` over and over. It pays to spend some time playing around with map and
-reduce functions. Futon is OK for this, but it doesn\u2019t give full access to all
-the query parameters. Writing your own test code for views in your language
+reduce functions. Fauxton is OK for this, but it doesn\u2019t give full access to
+all the query parameters. Writing your own test code for views in your language
of choice is a great way to explore the nuances and capabilities of CouchDB\u2019s
incremental MapReduce system.
http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/c4e7cd92/src/install/windows.rst
----------------------------------------------------------------------
diff --git a/src/install/windows.rst b/src/install/windows.rst
index 52d843b..b5ab0b1 100644
--- a/src/install/windows.rst
+++ b/src/install/windows.rst
@@ -37,7 +37,7 @@ This is the simplest way to go.
- Verify installation settings
- Install CouchDB
-#. `Open up Futon`_ (if you hadn't selected autostart CouchDB after
+#. `Open up Fauxton`_ (if you hadn't selected autostart CouchDB after
installation, you have to start it first manually)
#. It's time to Relax!
@@ -59,7 +59,7 @@ This is the simplest way to go.
In this case, make sure you backup of your `local.ini` config and CouchDB
database/index files.
-.. _Open up Futon: http://localhost:5984/_utils
+.. _Open up Fauxton: http://localhost:5984/_utils
.. _CouchDB web site: http://couchdb.org/
.. _archive: http://archive.apache.org/dist/couchdb/binary/win/
.. _the latest Windows binaries: http://couchdb.org/#download
@@ -67,192 +67,6 @@ This is the simplest way to go.
Installation from sources
=========================
-If you're Windows geek, this section is for you!
-
-Dependencies
-------------
-
-You should have the following installed:
-
-* `Erlang OTP (>=14B01, <R17) <http://erlang.org/>`_
-* `ICU (>=4.*) <http://icu-project.org/>`_
-* `OpenSSL (>0.9.8r) <http://www.openssl.org/>`_
-* `Mozilla SpiderMonkey (=1.8.5) <http://www.mozilla.org/js/spidermonkey/>`_
-* `Cygwin <http://www.cygwin.com/>`_
-* `Microsoft SDK 7.0 or 7.1 <http://www.microsoft.com/en-us/download/details.aspx?id=8279>`_
-* `libcurl (>=7.20) <http://curl.haxx.se/libcurl/>`_
-* `help2man <http://www.gnu.org/s/help2man/>`_
-* `Python (>=2.7) for docs <http://python.org/>`_
-* `Python Sphinx (>=1.1.3) <http://pypi.python.org/pypi/Sphinx>`_
-
-You will only need libcurl if you plan to run the JavaScript test suite. And
-help2man is only need if you plan on installing the CouchDB man pages.
-Python and Sphinx are only required for building the online documentation.
-
-General Notes
--------------
-
-* When installing Cygwin, be sure to select all the `development` tools.
-
-* When installing Erlang, you must build it from source.
-
-* The CouchDB build requires a number of the Erlang build scripts.
-
-* All dependent libraries should be built with the same version of
- Microsoft SDK.
-
-* Do not try to link against libraries built with, or included in,
- Cygwin or MingW. They are not compatible with the Erlang/OTP or CouchDB
- build scripts.
-
-* ICU version 4.6 and later will build cleanly using MSBuild.
-
-* Python and Sphinx are optional for building the online documentation.
- Use cygwin-provided Python and install Sphinx via easy_install or pip.
- Further information is here http://pypi.python.org/pypi/setuptools#id4
-
-Setting Up Cygwin
------------------
-
-Before starting any Cygwin terminals, run::
-
- set CYGWIN=nontsec
-
-To set up your environment, run::
-
- [VS_BIN]/vcvars32.bat
-
-Replace ``[VS_BIN]`` with the path to your Visual Studio `bin` directory.
-
-You must check that:
-
-* The ``which link`` command points to the Microsoft linker.
-
-* The ``which cl`` command points to the Microsoft compiler.
-
-* The ``which mc`` command points to the Microsoft message compiler.
-
-* The ``which mt`` command points to the Microsoft manifest tool.
-
-* The ``which nmake`` command points to the Microsoft make tool.
-
-If you do not do this, the build may fail due to Cygwin ones found in `/usr/bin`
-being used instead.
-
-Building Erlang
----------------
-
-You must include Win32 OpenSSL, built statically from source. Use
-exactly the same version as required by the Erlang/OTP build process.
-
-However, you can skip the GUI tools by running::
-
- echo "skipping gs" > lib/gs/SKIP
-
- echo "skipping ic" > lib/ic/SKIP
-
- echo "skipping jinterface" > lib/jinterface/SKIP
-
-Follow the rest of the Erlang instructions as described.
-
-After running::
-
- ./otp_build release -a
-
-You should run::
-
- ./release/win32/Install.exe -s
-
-This will set up the release/win32/bin directory correctly. The CouchDB
-installation scripts currently write their data directly into this
-location.
-
-To set up your environment for building CouchDB, run::
-
- eval `./otp_build env_win32`
-
-To set up the `ERL_TOP` environment variable, run::
-
- export ERL_TOP=[ERL_TOP]
-
-Replace ``[ERL_TOP]`` with the Erlang source directory name.
-
-Remember to use `/cygdrive/c/` instead of `c:/` as the directory prefix.
-
-To set up your path, run::
-
- export PATH=$ERL_TOP/release/win32/erts-5.8.5/bin:$PATH
-
-If everything was successful, you should be ready to build CouchDB.
-
-Relax.
-
-Building CouchDB
-----------------
-
-Note that `win32-curl` is only required if you wish to run the developer
-tests.
-
-The documentation step may be skipped using ``--disable-docs`` if you wish.
-
-Once you have satisfied the dependencies you should run::
-
- ./configure \
- --with-js-include=/cygdrive/c/path_to_spidermonkey_include \
- --with-js-lib=/cygdrive/c/path_to_spidermonkey_lib \
- --with-win32-icu-binaries=/cygdrive/c/path_to_icu_binaries_root \
- --with-erlang=$ERL_TOP/release/win32/usr/include \
- --with-win32-curl=/cygdrive/c/path/to/curl/root/directory \
- --with-openssl-bin-dir=/cygdrive/c/openssl/bin \
- --with-msvc-redist-dir=/cygdrive/c/dir/with/vcredist_platform_executable \
- --disable-init \
- --disable-launchd \
- --prefix=$ERL_TOP/release/win32
-
-This command could take a while to complete.
-
-If everything was successful you should see the following message::
-
- You have configured Apache CouchDB, time to relax.
-
-Relax.
-
-To install CouchDB you should run::
-
- make install
-
-If everything was successful you should see the following message::
-
- You have installed Apache CouchDB, time to relax.
-
-Relax.
-
-To build the .exe installer package, you should run::
-
- make dist
-
-Alternatively, you may run CouchDB directly from the build tree, but
-to avoid any contamination do not run `make dist` after this.
-
-First Run
----------
-
-You can start the CouchDB server by running::
-
- $ERL_TOP/release/win32/bin/couchdb.bat
-
-When CouchDB starts it should eventually display the following message::
-
- Apache CouchDB has started, time to relax.
-
-Relax.
-
-To check that everything has worked, point your web browser to::
-
- http://127.0.0.1:5984/_utils/index.html
-
-From here you should run the verification tests in Firefox.
-
.. seealso::
`Glazier: Automate building of CouchDB from source on Windows
- <https://github.com/dch/glazier>`_
+ <https://git1-us-west.apache.org/repos/asf?p=couchdb-glazier.git;a=tree>`_
http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/c4e7cd92/src/intro/api.rst
----------------------------------------------------------------------
diff --git a/src/intro/api.rst b/src/intro/api.rst
index 7472ecf..9727182 100644
--- a/src/intro/api.rst
+++ b/src/intro/api.rst
@@ -21,7 +21,7 @@ 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 previous document
-:ref:`intro/tour`, looking behind the scenes. We also show what Futon needs to
+:ref:`intro/tour`, looking behind the scenes. We also show what Fauxton needs to
do behind its user interface to give us the nice features we saw earlier.
This document is both an introduction to the core CouchDB API as well as a
http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/c4e7cd92/src/intro/futon.rst
----------------------------------------------------------------------
diff --git a/src/intro/futon.rst b/src/intro/futon.rst
deleted file mode 100644
index 2d11ffb..0000000
--- a/src/intro/futon.rst
+++ /dev/null
@@ -1,178 +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.
-
-.. _intro/futon:
-
-===================================
-Futon: Web GUI Administration Panel
-===================================
-
-Futon is a native web-based interface built into CouchDB. It provides a basic
-interface to the majority of the functionality, including the ability to create,
-update, delete and view documents and views, provides access to the
-configuration parameters, and an interface for initiating replication.
-
-The default view is the Overview page which provides you with a list of the
-databases. The basic structure of the page is consistent regardless of the
-section you are in. The main panel on the left provides the main interface to
-the databases, configuration or replication systems. The side panel on the
-right provides navigation to the main areas of Futon interface:
-
-.. figure:: ../../images/futon-overview.png
- :align: center
- :alt: Futon Overview
-
- Futon Overview
-
-The main sections are:
-
-- Overview
-
- The main overview page, which provides a list of the databases and
- provides the interface for querying the database and creating and
- updating documents. See :ref:`futon-management`.
-
-- Configuration
-
- An interface into the configuration of your CouchDB installation. The
- interface allows you to edit the different configurable parameters.
- For more details on configuration, see :ref:`config` section.
-
-- Replicator
-
- An interface to the replication system, enabling you to initiate replication
- between local and remote databases. See :ref:`futon-replication`.
-
-- Status
-
- Displays a list of the running background tasks on the server.
- Background tasks include view index building, compaction and
- replication. The Status page is an interface to the
- :ref:`Active Tasks <api/server/active_tasks>` API call.
-
-- Verify Installation
-
- The Verify Installation allows you to check whether all of the
- components of your CouchDB installation are correctly installed.
-
-- Test Suite
-
- The Test Suite section allows you to run the built-in test suite.
- This executes a number of test routines entirely within your browser
- to test the API and functionality of your CouchDB installation. If
- you select this page, you can run the tests by using the Run All
- button. This will execute all the tests, which may take some time.
-
-.. _futon-management:
-
-Managing Databases and Documents
-================================
-
-You can manage databases and documents within Futon using the main
-Overview section of the Futon interface.
-
-To create a new database, click the Create Database ELLIPSIS button. You
-will be prompted for the database name, as shown in the figure below.
-
-.. figure:: ../../images/futon-createdb.png
- :align: center
- :alt: Creating a Database
-
- Creating a Database
-
-Once you have created the database (or selected an existing one), you will be
-shown a list of the current documents. If you create a new document, or select
-an existing document, you will be presented with the edit document display.
-
-Editing documents within Futon requires selecting the document and then
-editing (and setting) the fields for the document individually before
-saving the document back into the database.
-
-For example, the figure below shows the editor for a single document, a
-newly created document with a single ID, the document ``_id`` field.
-
-.. figure:: ../../images/futon-editdoc.png
- :align: center
- :alt: Editing a Document
-
- Editing a Document
-
-To add a field to the document:
-
-1. Click Add Field.
-
-2. In the fieldname box, enter the name of the field you want to create.
- For example, \u201ccompany\u201d.
-
-3. Click the green tick next to the field name to confirm the field name change.
-
-4. Double-click the corresponding Value cell.
-
-5. Enter a company name, for example \u201cExample\u201d.
-
-6. Click the green tick next to the field value to confirm the field value.
-
-7. The document is still not saved as this point. You must explicitly
- save the document by clicking the Save Document button at the top of
- the page. This will save the document, and then display the new
- document with the saved revision information (the ``_rev`` field).
-
- .. figure:: ../../images/futon-editeddoc.png
- :align: center
- :alt: Edited Document
-
- Edited Document
-
-The same basic interface is used for all editing operations within Futon.
-You *must* remember to save the individual element (fieldname, value)
-using the green tick button, before then saving the document.
-
-.. _futon-replication:
-
-Configuring Replication
-=======================
-
-When you click the Replicator option within the Tools menu you are
-presented with the Replicator screen. This allows you to start
-replication between two databases by filling in or selecting the
-appropriate options within the form provided.
-
-.. figure:: ../../images/futon-replform.png
- :align: center
- :alt: Replication Form
-
- Replication Form
-
-To start a replication process, either the select the local database or
-enter a remote database name into the corresponding areas of the form.
-Replication occurs from the database on the left to the database on the
-right.
-
-If you are specifying a remote database name, you must specify the full
-URL of the remote database (including the host, port number and database
-name). If the remote instance requires authentication, you can specify
-the username and password as part of the URL, for example
-``http://username:pass@remotehost:5984/demo``.
-
-To enable continuous replication, click the Continuous checkbox.
-
-To start the replication process, click the Replicate button. The
-replication process should start and will continue in the background. If
-the replication process will take a long time, you can monitor the
-status of the replication using the Status option under the Tools menu.
-
-Once replication has been completed, the page will show the information
-returned when the replication process completes by the API.
-
-The Replicator tool is an interface to the underlying replication API.
-For more information, see :ref:`api/server/replicate`. For more information on
-replication, see :ref:`replication`.
http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/c4e7cd92/src/intro/index.rst
----------------------------------------------------------------------
diff --git a/src/intro/index.rst b/src/intro/index.rst
index c96e87f..fe3bb72 100644
--- a/src/intro/index.rst
+++ b/src/intro/index.rst
@@ -29,7 +29,7 @@ or your apps, efficiently using CouchDB\u2019s :ref:`incremental replication
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 :ref:`web administration console <intro/futon>`. You guessed it,
+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.
@@ -51,5 +51,4 @@ teach how to use CouchDB.
tour
api
security
- futon
curl
http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/c4e7cd92/src/intro/security.rst
----------------------------------------------------------------------
diff --git a/src/intro/security.rst b/src/intro/security.rst
index 4d1d6ff..0330547 100644
--- a/src/intro/security.rst
+++ b/src/intro/security.rst
@@ -436,15 +436,11 @@ CouchDB should respond with:
{"ok":true,"name":"jan","roles":[]}
Hooray! You may wonder why this was so complex - we need to retrieve user's
-document, add a special field to it, and post it back. Where is that one big
-button that changes the password without worrying about the document's content?
-Actually, :ref:`Futon <intro/futon>` has one such thing at the bottom right
-corner if you are logged in. Using that will hide all the implementation details
-described above and keep it really simple for you.
+document, add a special field to it, and post it back.
.. note::
There is no password confirmation for API request: you should implement it
- on your application layer like Futon does.
+ in your application layer.
Users Public Information
------------------------
http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/c4e7cd92/src/intro/tour.rst
----------------------------------------------------------------------
diff --git a/src/intro/tour.rst b/src/intro/tour.rst
index ea512c7..d328034 100644
--- a/src/intro/tour.rst
+++ b/src/intro/tour.rst
@@ -16,8 +16,7 @@
Getting Started
===============
-In this document, we'll take a quick tour of CouchDB's features,
-familiarizing ourselves with Futon, the built-in administration interface.
+In this document, we'll take a quick tour of CouchDB's features.
We'll create our first document and experiment with CouchDB views.
All Systems Are Go!
@@ -155,22 +154,23 @@ keep in mind that "under the hood" everything is being done by the
application exactly as you have been doing here manually.
Everything is done using GET, PUT, POST, and DELETE with a URI.
-Welcome to Futon
-================
+.. _intro/tour/fauxton:
+
+Welcome to Fauxton
+==================
After having seen CouchDB's raw API, let's get our feet wet by playing with
-Futon, the built-in administration interface. Futon provides full access to
-all of CouchDB's features and makes it easy to work with some of the more
-complex ideas involved. With Futon we can create and destroy databases; view
+Fauxuton, the built-in administration interface. Fauxuton provides full access
+to all of CouchDB's features and makes it easy to work with some of the more
+complex ideas involved. With Fauxton we can create and destroy databases; view
and edit documents; compose and run MapReduce views; and trigger replication
between databases.
-To load Futon in your browser, visit::
+To load Fauxuton 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 documents, we'll focus on using CouchDB from
+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
@@ -179,35 +179,26 @@ you may wish to do with your own applications.
The first thing we should do with a fresh installation of CouchDB is run the
test suite to verify that everything is working properly. This assures us
that any problems we may run into aren't due to bothersome issues with our
-setup. By the same token, failures in the Futon test suite are a red flag,
+setup. By the same token, failures in the Fauxton test suite are a red flag,
telling us to double-check our installation before attempting to use a
potentially broken database server, saving us the confusion when nothing
seems to be working quite like we expect!
-.. _intro/tour-01:
-
-.. figure:: ../../images/intro-tour-01.png
- :align: center
- :alt: The Futon welcome screen
-
- Figure 1. The Futon welcome screen
-
-Some common network configurations cause the replication test to fail when
-accessed via the localhost address. You can fix this by accessing CouchDB via
-127.0.0.1, e.g. http://127.0.0.1:5984/_utils/.
+To validate your installation, click on the `Verify` link on the left-hand
+side, then press the green `Verify Installation` button. All tests should
+pass with a check mark. If any fail, re-check your installation steps.
Your First Database and Document
================================
-Creating a database in Futon is simple. From the overview page,
+Creating a database in Fauxton is simple. From the overview page,
click "Create Database." When asked for a name, enter hello-world and click
the Create button.
-After your database has been created, Futon will display a list of all its
-documents. This list will start out empty (:ref:`intro/tour-03`), so let's
-create our first document. Click the "New Document" link and then the Create
-button in the pop up. Make sure to leave the document ID blank,
-and CouchDB will generate a UUID for you.
+After your database has been created, Fauxton will display a list of all its
+documents. This list will start out empty, so let's
+create our first document. Click the plus sign next to "All Documents" and
+select the "New Doc" link. CouchDB will generate a UUID for you.
For demoing purposes, having CouchDB assign a UUID is fine. When you write
your first programs, we recommend assigning your own UUIDs. If you rely on
@@ -217,51 +208,29 @@ never find out about the first one because only the second one will be
reported back. Generating your own UUIDs makes sure that you'll never end up
with duplicate documents.
-Futon will display the newly created document, with its _id and _rev as the
-only fields. To create a new field, click the "Add Field" button. We'll call
-the new field hello. Click the green check icon (or hit the Enter key) to
-finalize creating the hello field. Double-click the hello field's value
-(default null) to edit it.
-
-You can experiment with other JSON values; e.g., ``[1, 2, "c"]`` or
-``{"foo": "bar"}``. Once you've entered your values into the document,
-make a note of its ``_rev`` attribute and click "Save Document." The result
-should look like :ref:`intro/tour-04`.
-
-.. _intro/tour-03:
+Fauxton will display the newly created document, with its _id field. To create
+a new field, simply use the editor to write valid JSON. Add a new field by
+appending a comma to the ``_id`` value, then adding the text::
-.. figure:: ../../images/intro-tour-03.png
- :align: center
- :alt: An empty database in Futon
+ "hello": "my new value"
- Figure 3. An empty database in Futon
+Click the green Create Document button to finalize creating the
+document.
-.. _intro/tour-04:
-
-.. figure:: ../../images/intro-tour-04.png
- :align: center
- :alt: A "hello world" document in Futon
-
- Figure 4. A "hello world" document in Futon
+You can experiment with other JSON values; e.g., ``[1, 2, "c"]`` or
+``{"foo": "bar"}``.
-You'll notice that the document's _rev has changed. We'll go into more detail
+You'll notice that the document's _rev has been added. We'll go into more detail
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.
-Futon also provides a way to display the underlying JSON data,
-which can be more compact and easier to read, depending on what sort of data
-you are dealing with. To see the JSON version of our "hello world" document,
-click the Source tab. The result should look like :ref:`intro/tour-05`.
-
-.. _intro/tour-05:
-
-.. figure:: ../../images/intro-tour-05.png
- :align: center
- :alt: The JSON source of a "hello world" document in Futon
-
- Figure 5. The JSON source of a "hello world" document in Futon
+For clarity, you may want to display the contents of the document in the all
+document view. To enable this, from the upper-right corner of the window,
+select Options, then check the Include Docs option. Finally, press the Run
+Query button. The full document should be displayed along with the ``_id``
+and ``_rev`` values.
Running a Query Using MapReduce
===============================
@@ -295,7 +264,7 @@ keys.
Before we can run an example MapReduce view, we'll need some data to run it
on. We'll create documents carrying the price of various supermarket items as
found at different shops. Let's create documents for apples, oranges,
-and bananas. (Allow CouchDB to generate the _id and _rev fields.) Use Futon
+and bananas. (Allow CouchDB to generate the _id and _rev fields.) Use Fauxton
to create documents that have a final JSON structure that looks like this:
.. code-block:: javascript
@@ -311,16 +280,6 @@ to create documents that have a final JSON structure that looks like this:
}
}
-This document should look like :ref:`intro/tour-06` when entered into Futon.
-
-.. _intro/tour-06:
-
-.. figure:: ../../images/intro-tour-06.png
- :align: center
- :alt: An example document with apple prices in Futon
-
- Figure 6. An example document with apple prices in Futon
-
OK, now that that's done, let's create the document for oranges:
.. code-block:: javascript
@@ -353,17 +312,14 @@ And finally, the document for bananas:
Imagine we're catering a big luncheon, but the client is very price-sensitive.
To find the lowest prices, we're going to create our first view,
-which shows each fruit sorted by price. Click "hello-world" to return to the
-hello-world overview, and then from the "View" select field choose "Temporary
-view\u2026" to create a new view.
+which shows each fruit sorted by price. Click "All Documents" to return to the
+hello-world overview, and then from the "All Documents" plus sign, click "New
+View" to create a new view.
-.. figure:: ../../images/intro-tour-07.png
- :align: center
- :alt: A temporary view in Futon
+Name the design document ``_design/myDesignDoc``, and set the Index name
+to ``prices``.
- Figure 7. A temporary view in Futon
-
-Edit the map function, on the left, so that it looks like the following:
+Edit the map function, on the right, so that it looks like the following:
.. code-block:: javascript
@@ -381,22 +337,16 @@ Edit the map function, on the left, so that it looks like the following:
This is a JavaScript function that CouchDB runs for each of our documents as
it computes the view. We'll leave the reduce function blank for the time being.
-Click "Run" and you should see result rows like in :ref:`intro/tour-08`,
+Click "Run" and you should see result rows,
with the various items sorted by price. This map function could be even more
useful if it grouped the items by type so that all the prices for bananas were
next to each other in the result set. CouchDB's key sorting system allows any
valid JSON object as a key. In this case, we'll emit an array of [item, price]
so that CouchDB groups by item type and price.
-.. _intro/tour-08:
-
-.. figure:: ../../images/intro-tour-08.png
- :align: center
- :alt: The results of running a view in Futon
-
- Figure 8. The results of running a view in Futon
-
-Let's modify the view function so that it looks like this:
+Let's modify the view function (click the wrench icon next to the Views >
+prices Design Document on the left, then select Edit) so that it looks like
+this:
.. code-block:: javascript
@@ -419,16 +369,7 @@ further resource usage. For this reason, it's important to check for the
existence of any fields before you use them. In this case,
our map function will skip the first "hello world" document we created
without emitting any rows or encountering any errors. The result of this
-query should look like :ref:`intro/tour-09`.
-
-.. _intro/tour-09:
-
-.. figure:: ../../images/intro-tour-09.png
- :align: center
- :alt: The results of running a view after grouping by item type and price
-
- Figure 9. The results of running a view after grouping by item type and
- price
+query should now be displayed.
Once we know we've got a document with an item type and some prices,
we iterate over the item's prices and emit key/values pairs. The key is an
@@ -449,25 +390,22 @@ efficient access to data within a range of keys.
Triggering Replication
======================
-Futon can trigger replication between two local databases,
+Fauxton can trigger replication between two local databases,
between a local and remote database, or even between two remote databases.
We'll show you how to replicate data from one local database to another,
which is a simple way of making backups of your databases as we're working
through the examples.
First we'll need to create an empty database to be the target of replication.
-Return to the overview and create a database called hello-replication.
-Now click "Replicator" in the sidebar and choose hello-world as the source
-and hello-replication as the target. Click "Replicate" to replicate your
-database. The result should look something like :ref:`intro/tour-10`.
-
-.. _intro/tour-10:
-
-.. figure:: ../../images/intro-tour-10.png
- :align: center
- :alt: Running database replication in Futon
+Return to the Databases overview and create a database called
+``hello-replication``. Now click "Replication" in the sidebar and choose
+hello-world as the source and hello-replication as the target. Click
+"Replicate" to replicate your database.
- Figure 10. Running database replication in Futon
+To view the result of your replication, click on the Databases tab again.
+You should see the hello-replication database has the same number of documents
+as the hello-world database, and it should take up roughly the same size as
+well.
.. note::
For larger databases, replication can take much longer. It is important to
@@ -481,11 +419,11 @@ database. The result should look something like :ref:`intro/tour-10`.
Wrapping Up
===========
-Now that you've seen most of Futon's features, you'll be prepared to dive in
+Now that you've seen most of Fauxton's features, you'll be prepared to dive in
and inspect your data as we build our example application in the next few
-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.
+documents. Fauxton'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.
But before we get there, we'll have another look at CouchDB's HTTP API -- now
with a magnifying glass. Let's curl up on the couch and relax.
http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/c4e7cd92/templates/pages/index.html
----------------------------------------------------------------------
diff --git a/templates/pages/index.html b/templates/pages/index.html
index 8c44f78..ede01f1 100644
--- a/templates/pages/index.html
+++ b/templates/pages/index.html
@@ -75,7 +75,7 @@ specific language governing permissions and limitations under the License.
</a>
<br />
<span class="linkdescr">start using CouchDB with
- <a href="{{ pathto("intro/futon") }}">Futon</a> and
+ <a href="{{ pathto("intro/tour/fauxton") }}">Fauxton</a> and
<a href="{{ pathto("intro/curl") }}">cURL</a></span>
</p>
<p class="biglink">
http://git-wip-us.apache.org/repos/asf/couchdb-documentation/blob/c4e7cd92/templates/utilities.html
----------------------------------------------------------------------
diff --git a/templates/utilities.html b/templates/utilities.html
index f49d584..2effa56 100644
--- a/templates/utilities.html
+++ b/templates/utilities.html
@@ -17,6 +17,6 @@ specific language governing permissions and limitations under the License.
<h3>Utilities</h3>
<ul>
-<li><a href="../">Futon</a></li>
+<li><a href="../">Fauxton</a></li>
</ul>
{% endif %}