Repository: couchdb-www Updated Branches: refs/heads/asf-site 7b5c60904 -> d0c8d7cf5
Add fauxton-visual-guide Project: http://git-wip-us.apache.org/repos/asf/couchdb-www/repo Commit: http://git-wip-us.apache.org/repos/asf/couchdb-www/commit/d0c8d7cf Tree: http://git-wip-us.apache.org/repos/asf/couchdb-www/tree/d0c8d7cf Diff: http://git-wip-us.apache.org/repos/asf/couchdb-www/diff/d0c8d7cf Branch: refs/heads/asf-site Commit: d0c8d7cf55a7d83cbb0c4c1298ecbf85830ab26a Parents: 7b5c609 Author: [email protected] <[email protected]> Authored: Mon Jun 29 18:40:59 2015 -0400 Committer: Michelle Phung <[email protected]> Committed: Wed Aug 12 15:00:42 2015 -0400 ---------------------------------------------------------------------- Makefile | 6 +- _src-fauxton-visual-guide/_layout.jade | 11 + .../assets/active-tasks.png | Bin 0 -> 139356 bytes _src-fauxton-visual-guide/assets/add-admin.png | Bin 0 -> 189260 bytes _src-fauxton-visual-guide/assets/all-dbs.png | Bin 0 -> 162465 bytes _src-fauxton-visual-guide/assets/all-docs.png | Bin 0 -> 193855 bytes _src-fauxton-visual-guide/assets/answers.png | Bin 0 -> 3870 bytes _src-fauxton-visual-guide/assets/config.png | Bin 0 -> 206886 bytes _src-fauxton-visual-guide/assets/cors.png | Bin 0 -> 142390 bytes _src-fauxton-visual-guide/assets/couch.png | Bin 0 -> 1780 bytes .../assets/couchdb-logo.png | Bin 0 -> 3116 bytes .../assets/couchdb-logo1.png | Bin 0 -> 7841 bytes .../assets/header-bar1.png | Bin 0 -> 525238 bytes .../assets/headerbar/0.png | Bin 0 -> 58499 bytes .../assets/headerbar/1.png | Bin 0 -> 69310 bytes .../assets/headerbar/2.png | Bin 0 -> 73385 bytes .../assets/headerbar/3.png | Bin 0 -> 65497 bytes .../assets/headerbar/4.png | Bin 0 -> 82061 bytes .../assets/headerbar/5.png | Bin 0 -> 114795 bytes .../assets/headerbar/6.png | Bin 0 -> 65403 bytes _src-fauxton-visual-guide/assets/linen.jpg | Bin 0 -> 17601 bytes _src-fauxton-visual-guide/assets/login.png | Bin 0 -> 104385 bytes _src-fauxton-visual-guide/assets/replicator.png | Bin 0 -> 83583 bytes .../assets/troubleshooting.png | Bin 0 -> 3879 bytes .../assets/usermanagement.png | Bin 0 -> 140574 bytes _src-fauxton-visual-guide/assets/verify.png | Bin 0 -> 121285 bytes _src-fauxton-visual-guide/index.jade | 495 +++++++++++++++++++ _src-fauxton-visual-guide/js/main.coffee | 12 + _src-fauxton-visual-guide/main.less | 291 +++++++++++ fauxton-visual-guide/assets/active-tasks.png | Bin 0 -> 139356 bytes fauxton-visual-guide/assets/add-admin.png | Bin 0 -> 189260 bytes fauxton-visual-guide/assets/all-dbs.png | Bin 0 -> 162465 bytes fauxton-visual-guide/assets/all-docs.png | Bin 0 -> 193855 bytes fauxton-visual-guide/assets/answers.png | Bin 0 -> 3870 bytes fauxton-visual-guide/assets/config.png | Bin 0 -> 206886 bytes fauxton-visual-guide/assets/cors.png | Bin 0 -> 142390 bytes fauxton-visual-guide/assets/couch.png | Bin 0 -> 1780 bytes fauxton-visual-guide/assets/couchdb-logo.png | Bin 0 -> 3116 bytes fauxton-visual-guide/assets/couchdb-logo1.png | Bin 0 -> 7841 bytes fauxton-visual-guide/assets/header-bar1.png | Bin 0 -> 525238 bytes fauxton-visual-guide/assets/headerbar/0.png | Bin 0 -> 58499 bytes fauxton-visual-guide/assets/headerbar/1.png | Bin 0 -> 69310 bytes fauxton-visual-guide/assets/headerbar/2.png | Bin 0 -> 73385 bytes fauxton-visual-guide/assets/headerbar/3.png | Bin 0 -> 65497 bytes fauxton-visual-guide/assets/headerbar/4.png | Bin 0 -> 82061 bytes fauxton-visual-guide/assets/headerbar/5.png | Bin 0 -> 114795 bytes fauxton-visual-guide/assets/headerbar/6.png | Bin 0 -> 65403 bytes fauxton-visual-guide/assets/linen.jpg | Bin 0 -> 17601 bytes fauxton-visual-guide/assets/login.png | Bin 0 -> 104385 bytes fauxton-visual-guide/assets/replicator.png | Bin 0 -> 83583 bytes fauxton-visual-guide/assets/troubleshooting.png | Bin 0 -> 3879 bytes fauxton-visual-guide/assets/usermanagement.png | Bin 0 -> 140574 bytes fauxton-visual-guide/assets/verify.png | Bin 0 -> 121285 bytes fauxton-visual-guide/index.html | 230 +++++++++ fauxton-visual-guide/js/main.js | 1 + fauxton-visual-guide/main.css | 1 + index.html | 1 + 57 files changed, 1047 insertions(+), 1 deletion(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/Makefile ---------------------------------------------------------------------- diff --git a/Makefile b/Makefile index 438e365..338c309 100644 --- a/Makefile +++ b/Makefile @@ -1,7 +1,11 @@ -all: style/master.css +all: style/master.css fauxton-visual-guide style/master.css: style/master.less lessc $< > $@ +fauxton-visual-guide: + harp compile _src-fauxton-visual-guide fauxton-visual-guide + clean: rm style/master.css + rm -rf fauxton-visual-guide http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/_src-fauxton-visual-guide/_layout.jade ---------------------------------------------------------------------- diff --git a/_src-fauxton-visual-guide/_layout.jade b/_src-fauxton-visual-guide/_layout.jade new file mode 100644 index 0000000..d5d65d7 --- /dev/null +++ b/_src-fauxton-visual-guide/_layout.jade @@ -0,0 +1,11 @@ +doctype +html + head + title Fauxton Visual Guide + link(rel="stylesheet" href="main.css") + link(rel="icon" type="image/png" href="assets/couch.png") + script(src="http://ajax.googleapis.com/ajax/libs/jquery/1.5.2/jquery.min.js";) + script(src="js/main.js") + + body + != yield \ No newline at end of file http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/_src-fauxton-visual-guide/assets/active-tasks.png ---------------------------------------------------------------------- diff --git a/_src-fauxton-visual-guide/assets/active-tasks.png b/_src-fauxton-visual-guide/assets/active-tasks.png new file mode 100644 index 0000000..cd3d77a Binary files /dev/null and b/_src-fauxton-visual-guide/assets/active-tasks.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/_src-fauxton-visual-guide/assets/add-admin.png ---------------------------------------------------------------------- diff --git a/_src-fauxton-visual-guide/assets/add-admin.png b/_src-fauxton-visual-guide/assets/add-admin.png new file mode 100644 index 0000000..a898715 Binary files /dev/null and b/_src-fauxton-visual-guide/assets/add-admin.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/_src-fauxton-visual-guide/assets/all-dbs.png ---------------------------------------------------------------------- diff --git a/_src-fauxton-visual-guide/assets/all-dbs.png b/_src-fauxton-visual-guide/assets/all-dbs.png new file mode 100644 index 0000000..5b9d53f Binary files /dev/null and b/_src-fauxton-visual-guide/assets/all-dbs.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/_src-fauxton-visual-guide/assets/all-docs.png ---------------------------------------------------------------------- diff --git a/_src-fauxton-visual-guide/assets/all-docs.png b/_src-fauxton-visual-guide/assets/all-docs.png new file mode 100644 index 0000000..07f5607 Binary files /dev/null and b/_src-fauxton-visual-guide/assets/all-docs.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/_src-fauxton-visual-guide/assets/answers.png ---------------------------------------------------------------------- diff --git a/_src-fauxton-visual-guide/assets/answers.png b/_src-fauxton-visual-guide/assets/answers.png new file mode 100644 index 0000000..0a993ba Binary files /dev/null and b/_src-fauxton-visual-guide/assets/answers.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/_src-fauxton-visual-guide/assets/config.png ---------------------------------------------------------------------- diff --git a/_src-fauxton-visual-guide/assets/config.png b/_src-fauxton-visual-guide/assets/config.png new file mode 100644 index 0000000..cb2b211 Binary files /dev/null and b/_src-fauxton-visual-guide/assets/config.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/_src-fauxton-visual-guide/assets/cors.png ---------------------------------------------------------------------- diff --git a/_src-fauxton-visual-guide/assets/cors.png b/_src-fauxton-visual-guide/assets/cors.png new file mode 100644 index 0000000..a3397aa Binary files /dev/null and b/_src-fauxton-visual-guide/assets/cors.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/_src-fauxton-visual-guide/assets/couch.png ---------------------------------------------------------------------- diff --git a/_src-fauxton-visual-guide/assets/couch.png b/_src-fauxton-visual-guide/assets/couch.png new file mode 100644 index 0000000..8670739 Binary files /dev/null and b/_src-fauxton-visual-guide/assets/couch.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/_src-fauxton-visual-guide/assets/couchdb-logo.png ---------------------------------------------------------------------- diff --git a/_src-fauxton-visual-guide/assets/couchdb-logo.png b/_src-fauxton-visual-guide/assets/couchdb-logo.png new file mode 100644 index 0000000..db7edaa Binary files /dev/null and b/_src-fauxton-visual-guide/assets/couchdb-logo.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/_src-fauxton-visual-guide/assets/couchdb-logo1.png ---------------------------------------------------------------------- diff --git a/_src-fauxton-visual-guide/assets/couchdb-logo1.png b/_src-fauxton-visual-guide/assets/couchdb-logo1.png new file mode 100644 index 0000000..a7d179b Binary files /dev/null and b/_src-fauxton-visual-guide/assets/couchdb-logo1.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/_src-fauxton-visual-guide/assets/header-bar1.png ---------------------------------------------------------------------- diff --git a/_src-fauxton-visual-guide/assets/header-bar1.png b/_src-fauxton-visual-guide/assets/header-bar1.png new file mode 100644 index 0000000..53df722 Binary files /dev/null and b/_src-fauxton-visual-guide/assets/header-bar1.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/_src-fauxton-visual-guide/assets/headerbar/0.png ---------------------------------------------------------------------- diff --git a/_src-fauxton-visual-guide/assets/headerbar/0.png b/_src-fauxton-visual-guide/assets/headerbar/0.png new file mode 100644 index 0000000..52ab51c Binary files /dev/null and b/_src-fauxton-visual-guide/assets/headerbar/0.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/_src-fauxton-visual-guide/assets/headerbar/1.png ---------------------------------------------------------------------- diff --git a/_src-fauxton-visual-guide/assets/headerbar/1.png b/_src-fauxton-visual-guide/assets/headerbar/1.png new file mode 100644 index 0000000..344fbda Binary files /dev/null and b/_src-fauxton-visual-guide/assets/headerbar/1.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/_src-fauxton-visual-guide/assets/headerbar/2.png ---------------------------------------------------------------------- diff --git a/_src-fauxton-visual-guide/assets/headerbar/2.png b/_src-fauxton-visual-guide/assets/headerbar/2.png new file mode 100644 index 0000000..e92d5f5 Binary files /dev/null and b/_src-fauxton-visual-guide/assets/headerbar/2.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/_src-fauxton-visual-guide/assets/headerbar/3.png ---------------------------------------------------------------------- diff --git a/_src-fauxton-visual-guide/assets/headerbar/3.png b/_src-fauxton-visual-guide/assets/headerbar/3.png new file mode 100644 index 0000000..f93749f Binary files /dev/null and b/_src-fauxton-visual-guide/assets/headerbar/3.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/_src-fauxton-visual-guide/assets/headerbar/4.png ---------------------------------------------------------------------- diff --git a/_src-fauxton-visual-guide/assets/headerbar/4.png b/_src-fauxton-visual-guide/assets/headerbar/4.png new file mode 100644 index 0000000..7ffd2dc Binary files /dev/null and b/_src-fauxton-visual-guide/assets/headerbar/4.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/_src-fauxton-visual-guide/assets/headerbar/5.png ---------------------------------------------------------------------- diff --git a/_src-fauxton-visual-guide/assets/headerbar/5.png b/_src-fauxton-visual-guide/assets/headerbar/5.png new file mode 100644 index 0000000..2fb655c Binary files /dev/null and b/_src-fauxton-visual-guide/assets/headerbar/5.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/_src-fauxton-visual-guide/assets/headerbar/6.png ---------------------------------------------------------------------- diff --git a/_src-fauxton-visual-guide/assets/headerbar/6.png b/_src-fauxton-visual-guide/assets/headerbar/6.png new file mode 100644 index 0000000..92df140 Binary files /dev/null and b/_src-fauxton-visual-guide/assets/headerbar/6.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/_src-fauxton-visual-guide/assets/linen.jpg ---------------------------------------------------------------------- diff --git a/_src-fauxton-visual-guide/assets/linen.jpg b/_src-fauxton-visual-guide/assets/linen.jpg new file mode 100644 index 0000000..d80be96 Binary files /dev/null and b/_src-fauxton-visual-guide/assets/linen.jpg differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/_src-fauxton-visual-guide/assets/login.png ---------------------------------------------------------------------- diff --git a/_src-fauxton-visual-guide/assets/login.png b/_src-fauxton-visual-guide/assets/login.png new file mode 100644 index 0000000..5da5cec Binary files /dev/null and b/_src-fauxton-visual-guide/assets/login.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/_src-fauxton-visual-guide/assets/replicator.png ---------------------------------------------------------------------- diff --git a/_src-fauxton-visual-guide/assets/replicator.png b/_src-fauxton-visual-guide/assets/replicator.png new file mode 100644 index 0000000..c36758b Binary files /dev/null and b/_src-fauxton-visual-guide/assets/replicator.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/_src-fauxton-visual-guide/assets/troubleshooting.png ---------------------------------------------------------------------- diff --git a/_src-fauxton-visual-guide/assets/troubleshooting.png b/_src-fauxton-visual-guide/assets/troubleshooting.png new file mode 100644 index 0000000..328a8fa Binary files /dev/null and b/_src-fauxton-visual-guide/assets/troubleshooting.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/_src-fauxton-visual-guide/assets/usermanagement.png ---------------------------------------------------------------------- diff --git a/_src-fauxton-visual-guide/assets/usermanagement.png b/_src-fauxton-visual-guide/assets/usermanagement.png new file mode 100644 index 0000000..2a31f83 Binary files /dev/null and b/_src-fauxton-visual-guide/assets/usermanagement.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/_src-fauxton-visual-guide/assets/verify.png ---------------------------------------------------------------------- diff --git a/_src-fauxton-visual-guide/assets/verify.png b/_src-fauxton-visual-guide/assets/verify.png new file mode 100644 index 0000000..0db6b5e Binary files /dev/null and b/_src-fauxton-visual-guide/assets/verify.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/_src-fauxton-visual-guide/index.jade ---------------------------------------------------------------------- diff --git a/_src-fauxton-visual-guide/index.jade b/_src-fauxton-visual-guide/index.jade new file mode 100644 index 0000000..62a4e71 --- /dev/null +++ b/_src-fauxton-visual-guide/index.jade @@ -0,0 +1,495 @@ +#toggle-toc-button TOC +ul#toc.hidden + li + a(href="#page-intro") Intro + li + a(href="#page-overview") Overview + li + a(href="#page-getting-started") Features: Getting Started + li + a(href="#page-all-dbs") All Databases + li + a(href="#page-all-docs") All Documents + li + a(href="#page-active-tasks") Active Tasks + li + a(href="#page-replication") Replication + li + a(href="#page-config") Configuration + li + a(href="#page-login") Login/User Management + li + a(href="#page-verify") Verify + li + a(href="#page-helpful-links") Helpful Links + li + a(href="#page-answers") Answers! + +//- ---------------------------------------------------------------------------------------------------------------------------- +#page-intro.pagecontainer + .leftside.linen.page + #introBox.textbox + h1 Fauxton + h2 A visual guide + + .rightside.page + img(src='assets/couch.png').couch +//- ---------------------------------------------------------------------------------------------------------------------------- +#page-overview.pagecontainer + .leftside.page + img(src='assets/couchdb-logo1.png') + .rightside.linen.page + .textbox + :markdown + # Overview + Welcome to Fauxton. + + Apache CouchDB is a database + that uses JSON for documents, + JavaScript for MapReduce indexes, + and regular HTTP for its API. + + Fauxton 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 + design documents. It provides access to the configuration parameters, + and an interface for initiating replication. + + [CouchDB Homepage](https://couchdb.apache.org/) (download available + [here](https://couchdb.apache.org/#download)!) + + [How to Install/Setup](http://docs.couchdb.org/en/latest/install/index.html) + + [Install via npm](https://www.npmjs.com/package/fauxton) + <div class="npm"> + ``npm install -g fauxton`` + ``fauxton`` + </div> + + [CouchDB Documentation](http://docs.couchdb.org/en/latest/) + + [CouchDB Blog](http://blog.couchdb.org/) Updates Weekly! :) + + [CouchDB IRC](http://webchat.freenode.net/?channels=couchdb) Chat + with our volunteers and others in the community. + + [Apache Software Foundation](http://www.apache.org/) About the ASF +//- ---------------------------------------------------------------------------------------------------------------------------- +#page-getting-started.pagecontainer + .leftside.page + img(src='assets/login.png') + .rightside.linen.page + .textbox + :markdown + # Features: Getting Started + + When you first start to use Fauxton, the left most navigation panel + will allow you jump quickly between viewing different parts of what's + going on in your CouchDB instance. + + You can expand or collapse the navigation by clicking on the area + above the topmost tab, "Databases", where the icon of the three + horizontal lines is. + + [Databases](#page-all-dbs) will show you a list of all your databases, + their size, number of documents, and provides quick links to it's + permissions page and replication page. + + [Active Tasks](#page-active-tasks) displays a list of the running + background tasks on the server. Background tasks include view index + building, compaction and replication. This page is an interface to + the [Active Tasks API](http://docs.couchdb.org/en/latest/api/server/common.html#api-server-active-tasks) + call. + + [Config](#page-config) is an interface for the configuration of your + CouchDB installation. The interface allows you to edit different + configurable parameters. For more details on configuration, see + [Configuring CouchDB](http://docs.couchdb.org/en/latest/config/index.html#config). + + [Replication](#page-replication) is an interface to the replication + system, enabling you to initiate replication between local and remote + databases. + + [Documentation](http://docs.couchdb.org/en/latest/) + will direct you to your local copy of the documentation. The link + shown in this guide is to the online version. + + [Login/User Management](#page-login) lets you can change your password, + or add administrator to your CouchDB instance. + + [Verify](#page-verify) verifies your installation and allows you to + check whether all of the components of your CouchDB installation are + correctly installed. + +//- ---------------------------------------------------------------------------------------------------------------------------- +#page-all-dbs.pagecontainer + .leftside.page + img(src='assets/all-dbs.png') + .rightside.linen.page + .textbox + :markdown + # All Databases + ** 1 Add a new Database ** + Click this button on the top bar, and + enter the name of the database you want to create. + + ** 2 Search for a Database ** + This text field auto-completes and jumps directly to a specified + database. + + ** 3 View a Database ** + This link will take to that database's "[All Docs](#page-all-docs)" + page where you can view all of that database's contents. You can also + delete, replicate, and change the permissions for a database from the + database's 'All Docs' page. + + ** 4 Replication Link ** + Jump directly to the Replication page for this database. + + ** 5 Permissions Link ** + Jump directly to the Permissions page for this database. + + +//- ---------------------------------------------------------------------------------------------------------------------------- +#page-all-docs.pagecontainer + .leftside.page + img(src='assets/all-docs.png') + .rightside.linen.page + .textbox + :markdown + # All Documents + ** 1 All Documents overview ** + This is the viewing area, the default view shows you all of the + documents in your database. If you want to view each document's + contents, you can either click 'Query Options' (located in upper right + corner), and then 'Include Docs'. To edit a document, you can either + click on the pencil in upper right of each card, or double click on + the document card, go to the editor page. + + ** 2 Quick Links ** + These are all links that pertain to this specific database. + + ** 3 View Design Documents ** + Design Documents are special documents, since they are data, they are + included in the database as documents, but they are special because + they contain functions for Map-Reduce which act on the rest of the + documents in the database. +//- ---------------------------------------------------------------------------------------------------------------------------- +#page-header-bar.pagecontainer + .headerSubsections + .head-header-section + .leftside + .rightside.linen.firstright + .long-header-textbox.textbox + .tail-header-section + .headerSection + .leftside.subleft + img(src='assets/headerbar/0.png') + .rightside.subright + .textbox + :markdown + # The Header Bar - All Documents + ** Default Header Bar ** + The top image is the default view of the header bar. You can play + around with the controls to see how it works. + + .headerSection + .leftside.subleft + img(src='assets/headerbar/1.png') + .rightside.subright + .textbox + :markdown + ** 1 Jump to another Database Dropdown ** + If you click on the database name here, a tray will pop out, and + you can type the name of another database. Clicking ENTER on the name + will cause the page to jump directly into that database. + + .headerSection + .leftside.subleft + img(src='assets/headerbar/2.png') + .rightside.subright + .textbox + :markdown + ** 2 Cog ** + You can do many things using the tray within the Cog button. You can + replicate this database, delete this database, add a new document, a + new view, or query an index. + + .headerSection + .leftside.subleft + img(src='assets/headerbar/3.png') + .rightside.subright + .textbox + :markdown + ** 3 Multiple Document Select and delete ** + Clicking 'Select' will allow you choose multiple documents, or + deselect all the documents for deletion. You can also expand or + collapse all of the documents to show more information. + + .headerSection + .leftside.subleft + img(src='assets/headerbar/4.png') + .rightside.subright + .textbox + :markdown + ** 4 Jump to a specific document in this database ** + This field takes the _id of the document you are trying to view. + Use this search bar to jump to a specific document in the database. + + .headerSection + .leftside.subleft + img(src='assets/headerbar/5.png') + .rightside.subright + .textbox + :markdown + ** 5 Query Options ** + You choose how you want to view the documents in this database using + Query Options. 'Include Docs' will show all the data in each document. + 'Keys' will allow to narrow down the documents being viewed on this + page based on the parameters you provide. + + .headerSection + .leftside.subleft + img(src='assets/headerbar/6.png') + .rightside.subright + .textbox + :markdown + ** 6 API URL ** + The API URL button shows up on most pages. All the data in CouchDB is + available through a pingable API URL. You can click on this link to + view and copy the particular API for the page you are viewing. + Many times, the browser will shows a interface based on one of the API + endpoints. + +//- ---------------------------------------------------------------------------------------------------------------------------- +#page-active-tasks.pagecontainer + .leftside.page + img(src='assets/active-tasks.png') + .rightside.linen.page + .textbox + :markdown + # Active Tasks + ** 1 Change Polling Interval ** + The status of each task can change as you are watching the Active + Tasks page. The page auto-updates, but polls at regular intervals. You + can set the amount of time that the page updates itself by dragging on + this bar. + + ** 2 API URL ** + This page is an interface to the + [Active Tasks API](http://docs.couchdb.org/en/latest/api/server/common.html#api-server-active-tasks) + call. You can view or copy the raw JSON by clicking on this button. + + ** 3 Filter ** + You can filter by the type of task, or search active tasks by + database name (either source or target) using these tabs. + +//- ---------------------------------------------------------------------------------------------------------------------------- +#page-config.pagecontainer + .leftside.page + img(src='assets/config.png') + .rightside.linen.page + .textbox + :markdown + # 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 the + [Configuring CouchDB](http://docs.couchdb.org/en/latest/config/index.html#config) + section. +//- ---------------------------------------------------------------------------------------------------------------------------- +#page-cors.pagecontainer + .leftside.page + img(src='assets/cors.png') + .rightside.linen.page + .textbox + :markdown + # CORS + + CORS stands for Cross Origin Resource Sharing. It is a setting that + pertains only to browsers. + + By enabling CORS, you allow other people, from <i>their</i> browsers, + to access the data you have stored in your CouchDB databases. + + They can ping your CouchDB instance through an AJAX request, + and it will return information. Or they can POST data to your CouchDB + instance, and CORS allows you to recieve that information. + + For example, + if your CouchDB installation is running on the domain ``alice.example`` + you can ping someone else's CouchDB instance through an AJAX request + from a different domain, e.g. ``bob.example`` - or even localhost! + + But be careful - allowing any domain to access your data can be a + security risk. If you only want certain websites (origins) to be able + to retrieve and change data, you can set 'Restrict to specific + domains', and then list which origins you want to allow access for. + + By setting, 'All domains', you allow anyone from anywhere to ping your + databases, and retrieve information that way. + + If you disable CORS, the JavaScript that makes the AJAX request needs + to run on the same domain. With CORS disabled frontend code that runs + on ``alice.example`` must be also hosted on ``alice.example``. + Disabling CORS, means that no browser that pings your databases will + recieve information. + + You can also limit who can ping you. If you only + want certain websites, or origins, to be able to recieve data from + your stores, you can set 'Restrict to specific domains', and then list + which origins you want to allow access. + + This is a browser specific layer of protection, a second layer of + protection, if you will. The first layer of protection comes from the + permissions you set on each database using roles. (For more + information, see + [CouchDB Security](http://docs.couchdb.org/en/latest/api/database/security.html)) +//- ---------------------------------------------------------------------------------------------------------------------------- +#page-replication.pagecontainer + .leftside.page + img(src='assets/replicator.png') + .rightside.linen.page + .textbox + :markdown + # Replication + + This is the interface to the replication system, enabling you to initiate + replication between local and remote databases. + + You will see two boxes, with 3 boxes in each bigger box. + + Depending on how big your screen is, the top (or leftmost box, labeled + \#1 in the example) is the Source database. The bottom (or rightmost + box, label \#2) is the Target database. + + From the Source database box (\#1), you can choose an existing + database from the dropdown, by selecting 'Local' like in the image to + the left. Or you can specify a remote database as the Source, by + clicking on 'Remote' in that box, and typing in the remote database's + address. + + In the Target database box (\#2), choose either a local or remote + database. If you want to create a new database, and replicate into + that new DB, check the 'Create Target' button. + + For continuous Replications, select the 'continuous' checkbox. + 'Continous' means that the target database will update itself whenever + the source database is updated, from now on. It will continue to + update itself until you cancel the continous replication. + + 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``. + + Under the [Active Tasks](#page-active-tasks) tab, you should see in + the table your new created replication. You might miss it if the + database being replicated is on the small side, but continous + replications will always show up while they are active. + + For more information, see + [/_replicate](http://docs.couchdb.org/en/latest/api/server/common.html#api-server-replicate). + + For more information on replication, see + [Replication](http://docs.couchdb.org/en/latest/replication/index.html#replication). +//- ---------------------------------------------------------------------------------------------------------------------------- +#page-login.pagecontainer + .leftside.page + img(src='assets/add-admin.png') + .rightside.linen.page + .textbox + :markdown + # Login/User Management + + You can change your password, or add admins to your CouchDB instance + within this tab. +//- ---------------------------------------------------------------------------------------------------------------------------- +#page-verify.pagecontainer + .leftside.page + img(src='assets/verify.png') + .rightside.linen.page + .textbox + :markdown + # Verify + + The Verify Installation allows you to check whether all of the + components of your CouchDB installation are correctly installed. +//- ---------------------------------------------------------------------------------------------------------------------------- +#page-helpful-links.pagecontainer + .leftside.page + img(src='assets/troubleshooting.png') + .rightside.linen.page + .textbox + :markdown + # Helpful links + + [How to Install/Setup](http://docs.couchdb.org/en/latest/install/index.html) + + [CouchDB Homepage](https://couchdb.apache.org/) (more info is + available here!) + + [CouchDB Documentation](http://docs.couchdb.org/en/latest/) + + [CouchDB Wiki](http://wiki.apache.org/couchdb/) + + [CoucDB: The Definitive Guide](http://guide.couchdb.org/index.html) + + [CouchDB Tutorials](http://wiki.apache.org/couchdb/Basics) General and + Tutorials for Specific Languages + + [CouchDB IRC](http://webchat.freenode.net/?channels=couchdb) Our chat + channel +//- ---------------------------------------------------------------------------------------------------------------------------- +#page-answers.page + .leftside.page + img(src='assets/answers.png') + .rightside.linen.page + .textbox + h1 Answers! + + p.question Q: Where can I find answers about CouchDB? + p.answer + | A: Checkout the + a(href="http://wiki.apache.org/couchdb/Frequently_asked_questions";) CouchDB FAQ + | . + p.question Q: Wow! this is awesome! how can I contribute? + p.answer + | A: Thanks! If you want to contribute, you can open a pull request + | on + a(href="https://github.com/apache/couchdb-fauxton";) Github + | . + p.question Q: What can I do? + p.answer + | A: Lots of things! checkout our + a(href="https://issues.apache.org/jira/browse/COUCHDB/component/12320406/?selectedTab=com.atlassian.jira.jira-projects-plugin:component-summary-panel";) JIRA + | page for a list of things we need help fixing or building. + p.question Q: I'm not a programmer. What can I do? + p.answer. + A: Good question. There are many things you can do to help out! Find + a place that you think needs fixing, and find out how to fix it. + + :markdown + For example, if you find the documentation a long rabbit hole of + links and links (and links and links....) you could come up with a + hierarchical system of links or strategy guide that would help out a + newbie. + + If you have design skills, or would like to learn architecture + skills, you can help out by finding a cumbersome or non-intuitive + part of CouchDB and/or Fauxton and propose a fix. Good ideas are + always welcome :) + + Another thing is documentation. We have a lot, but the more the + better! If you find a place in CouchDB that is not well-documented, + feel free! + + p.question Q: I found a bug and I think it should be fixed! + p.answer. + A: Awesome! Open a pull request and we can make that happen! + + + + http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/_src-fauxton-visual-guide/js/main.coffee ---------------------------------------------------------------------- diff --git a/_src-fauxton-visual-guide/js/main.coffee b/_src-fauxton-visual-guide/js/main.coffee new file mode 100644 index 0000000..e2df07b --- /dev/null +++ b/_src-fauxton-visual-guide/js/main.coffee @@ -0,0 +1,12 @@ +$ -> + + toc = $('#toc') + button = $('#toggle-toc-button') + + button.click -> + toc.toggleClass('hidden') + button.toggleClass('x') + + button.text -> + if toc.hasClass('hidden') then 'TOC' + else 'X' \ No newline at end of file http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/_src-fauxton-visual-guide/main.less ---------------------------------------------------------------------- diff --git a/_src-fauxton-visual-guide/main.less b/_src-fauxton-visual-guide/main.less new file mode 100644 index 0000000..cca707b --- /dev/null +++ b/_src-fauxton-visual-guide/main.less @@ -0,0 +1,291 @@ +* { + margin: 0; + padding: 0; + -webkit-text-size-adjust: none; +} + +body, +a { + color: #291d1e; +} +/*--------------------------------------------------- + Font +---------------------------------------------------*/ +body, +h1, +h2, +h3, +h4, +pre { + font-size: 16px; + font-family: 'HelveticaNeue-Light', Helvetica, Arial, sans-serif; + font-weight: 300; +} +h1 { + font-size: 34px; +} +h2 { + font-size: 34px; + padding: 48px 0; +} +b, +strong { + font-family: 'HelveticaNeue-Bold', Helvetica, Arial, sans-serif; + font-weight: 900; +} + +.npm { + background-color: #E2E2E2; + border: 1px solid rgb(196, 196, 219); + margin-left: 50px; + display: inline-block; + padding: 10px; + margin-top: -10px; + margin-bottom: 20px; +} + + +#toggle-toc-button { + color: #888; + right: 20px; + top: 20px; + font-size: 12px; + padding: 10px; + position: fixed; + font-family: Arial,sans-serif; + &:hover { + cursor:sw-resize; + } + &.x{ + height: 35px; + width: 100px; + font-size: 8px; + text-align: right; + margin-right: 6px; + &:hover { + cursor:ne-resize; + } + } + z-index: 1001; +} + +#toc { + z-index: 1000; + width: 200px; + margin: 20px; + padding: 20px; + list-style-type: none; + position: fixed; + right: 5px; + background-color: rgba(255, 255, 255, 0.9); + + li { + padding: 2px; + } + + a { + color: rgb(197, 105, 105); + text-decoration: none; + + &:hover { + text-decoration: underline; + } + } + + &.hidden { + display: none; + } +} + +.pagecontainer { + min-height: 800px; + clear:both; +} + +.page { + min-height: 800px; + img { + margin-top: 70px; + height: 600px; + + display: block; + margin-left: auto; + margin-right: auto; + + &.couch { + height: auto; + position: relative; + top: 50%; + transform: translateY(50%); + } + } + overflow-y: auto; +} + +.leftside { + width: 50%; + float: left; +} + +.rightside { + color: green; + width: 50%; + float: right; + height: 100%; +} + +.linen { + background: url(assets/linen.jpg) #eeeeee 50% 0%; +} + +.textbox { + color: gray; + border: 1px solid rgb(216, 216, 216); + min-height: 600px; + width: 87%; + margin: auto; + margin-top: 70px; + margin-bottom: 50px; + background-color: rgba(242, 242, 242, 0.85); + overflow: hidden; + + h1 { + font-size: 30px; + text-align: center; + margin: 20px 10px 20px 10px; + color: #B5B5B5; + } + p { + padding: 5px 30px 15px 30px; + line-height: 1.5; + + &.br { + padding: 0px 30px 0px 30px; + line-height: 1; + } + + &.indent { + margin-left: 15px; + } + + &.question { + font-weight: 600; + padding-bottom: 0px; + } + + &.answer { + padding-top: 0px; + } + } +} + +#introBox { + text-align: center; + min-height: 320px; + + display: block; + position: relative; + top: 50%; + transform: translateY(50%); + h1 { + margin-top: 100px; + } + + h1 { + font-size: 60px; + color: #C0C0C0; + } + + h2 { + font-size: 16px; + padding: 0px; + } +} + +#page-overview { + img { + margin-top: 300px; + height: auto; + } +} + +#page-header-bar { + + .head-header-section { + + + .firstleft{ + padding-top: 100px; + } + .firstright{ + height: 2806px; + + .long-header-textbox{ + height: 95%; + } + } + + + } + + .tail-header-section { + position: absolute; + width: 100%; + + .headerSection { + + overflow: hidden; + } + + >.headerSection:first-child { + .leftside{ + padding-top: 130px; + } + } + + .leftside{ + padding-top: 40px; + } + } + + + img { + padding: 30px; + width: 936px; + height: auto; + } + .textbox { + min-height: auto; + border: none; + } + .border { + border: 1px solid black; + } + + .redborder{ + border: 1px solid red; + } + + .blueborder{ + border: 1px solid blue; + } + + .greenborder{ + border: 1px solid green; + } + + .subleft { + overflow-y: auto; + } + + .clearfix { + clear: both; + } +} + +#page-answers { + img { + height: auto; + } +} + http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/fauxton-visual-guide/assets/active-tasks.png ---------------------------------------------------------------------- diff --git a/fauxton-visual-guide/assets/active-tasks.png b/fauxton-visual-guide/assets/active-tasks.png new file mode 100644 index 0000000..cd3d77a Binary files /dev/null and b/fauxton-visual-guide/assets/active-tasks.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/fauxton-visual-guide/assets/add-admin.png ---------------------------------------------------------------------- diff --git a/fauxton-visual-guide/assets/add-admin.png b/fauxton-visual-guide/assets/add-admin.png new file mode 100644 index 0000000..a898715 Binary files /dev/null and b/fauxton-visual-guide/assets/add-admin.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/fauxton-visual-guide/assets/all-dbs.png ---------------------------------------------------------------------- diff --git a/fauxton-visual-guide/assets/all-dbs.png b/fauxton-visual-guide/assets/all-dbs.png new file mode 100644 index 0000000..5b9d53f Binary files /dev/null and b/fauxton-visual-guide/assets/all-dbs.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/fauxton-visual-guide/assets/all-docs.png ---------------------------------------------------------------------- diff --git a/fauxton-visual-guide/assets/all-docs.png b/fauxton-visual-guide/assets/all-docs.png new file mode 100644 index 0000000..07f5607 Binary files /dev/null and b/fauxton-visual-guide/assets/all-docs.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/fauxton-visual-guide/assets/answers.png ---------------------------------------------------------------------- diff --git a/fauxton-visual-guide/assets/answers.png b/fauxton-visual-guide/assets/answers.png new file mode 100644 index 0000000..0a993ba Binary files /dev/null and b/fauxton-visual-guide/assets/answers.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/fauxton-visual-guide/assets/config.png ---------------------------------------------------------------------- diff --git a/fauxton-visual-guide/assets/config.png b/fauxton-visual-guide/assets/config.png new file mode 100644 index 0000000..cb2b211 Binary files /dev/null and b/fauxton-visual-guide/assets/config.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/fauxton-visual-guide/assets/cors.png ---------------------------------------------------------------------- diff --git a/fauxton-visual-guide/assets/cors.png b/fauxton-visual-guide/assets/cors.png new file mode 100644 index 0000000..a3397aa Binary files /dev/null and b/fauxton-visual-guide/assets/cors.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/fauxton-visual-guide/assets/couch.png ---------------------------------------------------------------------- diff --git a/fauxton-visual-guide/assets/couch.png b/fauxton-visual-guide/assets/couch.png new file mode 100644 index 0000000..8670739 Binary files /dev/null and b/fauxton-visual-guide/assets/couch.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/fauxton-visual-guide/assets/couchdb-logo.png ---------------------------------------------------------------------- diff --git a/fauxton-visual-guide/assets/couchdb-logo.png b/fauxton-visual-guide/assets/couchdb-logo.png new file mode 100644 index 0000000..db7edaa Binary files /dev/null and b/fauxton-visual-guide/assets/couchdb-logo.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/fauxton-visual-guide/assets/couchdb-logo1.png ---------------------------------------------------------------------- diff --git a/fauxton-visual-guide/assets/couchdb-logo1.png b/fauxton-visual-guide/assets/couchdb-logo1.png new file mode 100644 index 0000000..a7d179b Binary files /dev/null and b/fauxton-visual-guide/assets/couchdb-logo1.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/fauxton-visual-guide/assets/header-bar1.png ---------------------------------------------------------------------- diff --git a/fauxton-visual-guide/assets/header-bar1.png b/fauxton-visual-guide/assets/header-bar1.png new file mode 100644 index 0000000..53df722 Binary files /dev/null and b/fauxton-visual-guide/assets/header-bar1.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/fauxton-visual-guide/assets/headerbar/0.png ---------------------------------------------------------------------- diff --git a/fauxton-visual-guide/assets/headerbar/0.png b/fauxton-visual-guide/assets/headerbar/0.png new file mode 100644 index 0000000..52ab51c Binary files /dev/null and b/fauxton-visual-guide/assets/headerbar/0.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/fauxton-visual-guide/assets/headerbar/1.png ---------------------------------------------------------------------- diff --git a/fauxton-visual-guide/assets/headerbar/1.png b/fauxton-visual-guide/assets/headerbar/1.png new file mode 100644 index 0000000..344fbda Binary files /dev/null and b/fauxton-visual-guide/assets/headerbar/1.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/fauxton-visual-guide/assets/headerbar/2.png ---------------------------------------------------------------------- diff --git a/fauxton-visual-guide/assets/headerbar/2.png b/fauxton-visual-guide/assets/headerbar/2.png new file mode 100644 index 0000000..e92d5f5 Binary files /dev/null and b/fauxton-visual-guide/assets/headerbar/2.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/fauxton-visual-guide/assets/headerbar/3.png ---------------------------------------------------------------------- diff --git a/fauxton-visual-guide/assets/headerbar/3.png b/fauxton-visual-guide/assets/headerbar/3.png new file mode 100644 index 0000000..f93749f Binary files /dev/null and b/fauxton-visual-guide/assets/headerbar/3.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/fauxton-visual-guide/assets/headerbar/4.png ---------------------------------------------------------------------- diff --git a/fauxton-visual-guide/assets/headerbar/4.png b/fauxton-visual-guide/assets/headerbar/4.png new file mode 100644 index 0000000..7ffd2dc Binary files /dev/null and b/fauxton-visual-guide/assets/headerbar/4.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/fauxton-visual-guide/assets/headerbar/5.png ---------------------------------------------------------------------- diff --git a/fauxton-visual-guide/assets/headerbar/5.png b/fauxton-visual-guide/assets/headerbar/5.png new file mode 100644 index 0000000..2fb655c Binary files /dev/null and b/fauxton-visual-guide/assets/headerbar/5.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/fauxton-visual-guide/assets/headerbar/6.png ---------------------------------------------------------------------- diff --git a/fauxton-visual-guide/assets/headerbar/6.png b/fauxton-visual-guide/assets/headerbar/6.png new file mode 100644 index 0000000..92df140 Binary files /dev/null and b/fauxton-visual-guide/assets/headerbar/6.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/fauxton-visual-guide/assets/linen.jpg ---------------------------------------------------------------------- diff --git a/fauxton-visual-guide/assets/linen.jpg b/fauxton-visual-guide/assets/linen.jpg new file mode 100644 index 0000000..d80be96 Binary files /dev/null and b/fauxton-visual-guide/assets/linen.jpg differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/fauxton-visual-guide/assets/login.png ---------------------------------------------------------------------- diff --git a/fauxton-visual-guide/assets/login.png b/fauxton-visual-guide/assets/login.png new file mode 100644 index 0000000..5da5cec Binary files /dev/null and b/fauxton-visual-guide/assets/login.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/fauxton-visual-guide/assets/replicator.png ---------------------------------------------------------------------- diff --git a/fauxton-visual-guide/assets/replicator.png b/fauxton-visual-guide/assets/replicator.png new file mode 100644 index 0000000..c36758b Binary files /dev/null and b/fauxton-visual-guide/assets/replicator.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/fauxton-visual-guide/assets/troubleshooting.png ---------------------------------------------------------------------- diff --git a/fauxton-visual-guide/assets/troubleshooting.png b/fauxton-visual-guide/assets/troubleshooting.png new file mode 100644 index 0000000..328a8fa Binary files /dev/null and b/fauxton-visual-guide/assets/troubleshooting.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/fauxton-visual-guide/assets/usermanagement.png ---------------------------------------------------------------------- diff --git a/fauxton-visual-guide/assets/usermanagement.png b/fauxton-visual-guide/assets/usermanagement.png new file mode 100644 index 0000000..2a31f83 Binary files /dev/null and b/fauxton-visual-guide/assets/usermanagement.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/fauxton-visual-guide/assets/verify.png ---------------------------------------------------------------------- diff --git a/fauxton-visual-guide/assets/verify.png b/fauxton-visual-guide/assets/verify.png new file mode 100644 index 0000000..0db6b5e Binary files /dev/null and b/fauxton-visual-guide/assets/verify.png differ http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/fauxton-visual-guide/index.html ---------------------------------------------------------------------- diff --git a/fauxton-visual-guide/index.html b/fauxton-visual-guide/index.html new file mode 100644 index 0000000..891faf4 --- /dev/null +++ b/fauxton-visual-guide/index.html @@ -0,0 +1,230 @@ +<!DOCTYPE html><html><head><title>Fauxton Visual Guide</title><link rel="stylesheet" href="main.css"><link rel="icon" type="image/png" href="assets/couch.png"><script src="http://ajax.googleapis.com/ajax/libs/jquery/1.5.2/jquery.min.js";></script><script src="js/main.js"></script></head><body><div id="toggle-toc-button">TOC</div><ul id="toc" class="hidden"><li><a href="#page-intro">Intro</a></li><li><a href="#page-overview">Overview</a></li><li><a href="#page-getting-started">Features: Getting Started</a></li><li><a href="#page-all-dbs">All Databases</a></li><li><a href="#page-all-docs">All Documents</a></li><li><a href="#page-active-tasks">Active Tasks</a></li><li><a href="#page-replication">Replication</a></li><li><a href="#page-config">Configuration</a></li><li><a href="#page-login">Login/User Management</a></li><li><a href="#page-verify">Verify</a></li><li><a href="#page-helpful-links">Helpful Links</a></li><li><a href="#page-answers">Answers!</a></li></ul><div id="page-intro" cl ass="pagecontainer"><div class="leftside linen page"><div id="introBox" class="textbox"><h1>Fauxton</h1><h2>A visual guide</h2></div></div><div class="rightside page"><img src="assets/couch.png" class="couch"></div></div><div id="page-overview" class="pagecontainer"><div class="leftside page"><img src="assets/couchdb-logo1.png"></div><div class="rightside linen page"><div class="textbox"><h1 id="overview">Overview</h1> +<p>Welcome to Fauxton.</p> +<p>Apache CouchDB is a database +that uses JSON for documents, +JavaScript for MapReduce indexes, +and regular HTTP for its API.</p> +<p>Fauxton 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 +design documents. It provides access to the configuration parameters, +and an interface for initiating replication.</p> +<p><a href="https://couchdb.apache.org/";>CouchDB Homepage</a> (download available +<a href="https://couchdb.apache.org/#download";>here</a>!)</p> +<p><a href="http://docs.couchdb.org/en/latest/install/index.html";>How to Install/Setup</a></p> +<p><a href="https://www.npmjs.com/package/fauxton";>Install via npm</a> </p> +<div class="npm"> + <code>npm install -g fauxton</code><br> <code>fauxton</code> +</div> + +<p><a href="http://docs.couchdb.org/en/latest/";>CouchDB Documentation</a></p> +<p><a href="http://blog.couchdb.org/";>CouchDB Blog</a> Updates Weekly! :)</p> +<p><a href="http://webchat.freenode.net/?channels=couchdb";>CouchDB IRC</a> Chat +with our volunteers and others in the community.</p> +<p><a href="http://www.apache.org/";>Apache Software Foundation</a> About the ASF</p> +</div></div></div><div id="page-getting-started" class="pagecontainer"><div class="leftside page"><img src="assets/login.png"></div><div class="rightside linen page"><div class="textbox"><h1 id="features-getting-started">Features: Getting Started</h1> +<p>When you first start to use Fauxton, the left most navigation panel +will allow you jump quickly between viewing different parts of what's +going on in your CouchDB instance.</p> +<p>You can expand or collapse the navigation by clicking on the area +above the topmost tab, "Databases", where the icon of the three +horizontal lines is.</p> +<p><a href="#page-all-dbs">Databases</a> will show you a list of all your databases, +their size, number of documents, and provides quick links to it's +permissions page and replication page.</p> +<p><a href="#page-active-tasks">Active Tasks</a> displays a list of the running +background tasks on the server. Background tasks include view index +building, compaction and replication. This page is an interface to +the <a href="http://docs.couchdb.org/en/latest/api/server/common.html#api-server-active-tasks";>Active Tasks API</a> +call.</p> +<p><a href="#page-config">Config</a> is an interface for the configuration of your +CouchDB installation. The interface allows you to edit different +configurable parameters. For more details on configuration, see +<a href="http://docs.couchdb.org/en/latest/config/index.html#config";>Configuring CouchDB</a>.</p> +<p><a href="#page-replication">Replication</a> is an interface to the replication +system, enabling you to initiate replication between local and remote +databases.</p> +<p><a href="http://docs.couchdb.org/en/latest/";>Documentation</a> +will direct you to your local copy of the documentation. The link +shown in this guide is to the online version.</p> +<p><a href="#page-login">Login/User Management</a> lets you can change your password, +or add administrator to your CouchDB instance.</p> +<p><a href="#page-verify">Verify</a> verifies your installation and allows you to +check whether all of the components of your CouchDB installation are +correctly installed.</p> +</div></div></div><div id="page-all-dbs" class="pagecontainer"><div class="leftside page"><img src="assets/all-dbs.png"></div><div class="rightside linen page"><div class="textbox"><h1 id="all-databases">All Databases</h1> +<p><strong> 1 Add a new Database </strong> +Click this button on the top bar, and +enter the name of the database you want to create.</p> +<p><strong> 2 Search for a Database </strong> +This text field auto-completes and jumps directly to a specified +database.</p> +<p><strong> 3 View a Database </strong> +This link will take to that database's "<a href="#page-all-docs">All Docs</a>" +page where you can view all of that database's contents. You can also +delete, replicate, and change the permissions for a database from the +database's 'All Docs' page.</p> +<p><strong> 4 Replication Link </strong> +Jump directly to the Replication page for this database.</p> +<p><strong> 5 Permissions Link </strong> +Jump directly to the Permissions page for this database.</p> +</div></div></div><div id="page-all-docs" class="pagecontainer"><div class="leftside page"><img src="assets/all-docs.png"></div><div class="rightside linen page"><div class="textbox"><h1 id="all-documents">All Documents</h1> +<p><strong> 1 All Documents overview </strong> +This is the viewing area, the default view shows you all of the +documents in your database. If you want to view each document's +contents, you can either click 'Query Options' (located in upper right +corner), and then 'Include Docs'. To edit a document, you can either +click on the pencil in upper right of each card, or double click on +the document card, go to the editor page.</p> +<p><strong> 2 Quick Links </strong> +These are all links that pertain to this specific database.</p> +<p><strong> 3 View Design Documents </strong> +Design Documents are special documents, since they are data, they are +included in the database as documents, but they are special because +they contain functions for Map-Reduce which act on the rest of the +documents in the database.</p> +</div></div></div><div id="page-header-bar" class="pagecontainer"><div class="headerSubsections"><div class="head-header-section"><div class="leftside"></div><div class="rightside linen firstright"><div class="long-header-textbox textbox"></div></div></div><div class="tail-header-section"><div class="headerSection"><div class="leftside subleft"><img src="assets/headerbar/0.png"></div><div class="rightside subright"><div class="textbox"><h1 id="the-header-bar-all-documents">The Header Bar - All Documents</h1> +<p><strong> Default Header Bar </strong> +The top image is the default view of the header bar. You can play +around with the controls to see how it works. </p> +</div></div></div><div class="headerSection"><div class="leftside subleft"><img src="assets/headerbar/1.png"></div><div class="rightside subright"><div class="textbox"><p><strong> 1 Jump to another Database Dropdown </strong> +If you click on the database name here, a tray will pop out, and +you can type the name of another database. Clicking ENTER on the name +will cause the page to jump directly into that database.</p> +</div></div></div><div class="headerSection"><div class="leftside subleft"><img src="assets/headerbar/2.png"></div><div class="rightside subright"><div class="textbox"><p><strong> 2 Cog </strong> +You can do many things using the tray within the Cog button. You can +replicate this database, delete this database, add a new document, a +new view, or query an index. </p> +</div></div></div><div class="headerSection"><div class="leftside subleft"><img src="assets/headerbar/3.png"></div><div class="rightside subright"><div class="textbox"><p><strong> 3 Multiple Document Select and delete </strong> +Clicking 'Select' will allow you choose multiple documents, or +deselect all the documents for deletion. You can also expand or +collapse all of the documents to show more information.</p> +</div></div></div><div class="headerSection"><div class="leftside subleft"><img src="assets/headerbar/4.png"></div><div class="rightside subright"><div class="textbox"><p><strong> 4 Jump to a specific document in this database </strong> +This field takes the _id of the document you are trying to view. +Use this search bar to jump to a specific document in the database.</p> +</div></div></div><div class="headerSection"><div class="leftside subleft"><img src="assets/headerbar/5.png"></div><div class="rightside subright"><div class="textbox"><p><strong> 5 Query Options </strong> +You choose how you want to view the documents in this database using +Query Options. 'Include Docs' will show all the data in each document. +'Keys' will allow to narrow down the documents being viewed on this +page based on the parameters you provide.</p> +</div></div></div><div class="headerSection"><div class="leftside subleft"><img src="assets/headerbar/6.png"></div><div class="rightside subright"><div class="textbox"><p><strong> 6 API URL </strong> +The API URL button shows up on most pages. All the data in CouchDB is +available through a pingable API URL. You can click on this link to +view and copy the particular API for the page you are viewing. +Many times, the browser will shows a interface based on one of the API +endpoints.</p> +</div></div></div></div></div></div><div id="page-active-tasks" class="pagecontainer"><div class="leftside page"><img src="assets/active-tasks.png"></div><div class="rightside linen page"><div class="textbox"><h1 id="active-tasks">Active Tasks</h1> +<p><strong> 1 Change Polling Interval </strong> +The status of each task can change as you are watching the Active +Tasks page. The page auto-updates, but polls at regular intervals. You +can set the amount of time that the page updates itself by dragging on +this bar.</p> +<p><strong> 2 API URL </strong> +This page is an interface to the +<a href="http://docs.couchdb.org/en/latest/api/server/common.html#api-server-active-tasks";>Active Tasks API</a> +call. You can view or copy the raw JSON by clicking on this button.</p> +<p><strong> 3 Filter </strong> +You can filter by the type of task, or search active tasks by +database name (either source or target) using these tabs.</p> +</div></div></div><div id="page-config" class="pagecontainer"><div class="leftside page"><img src="assets/config.png"></div><div class="rightside linen page"><div class="textbox"><h1 id="configuration">Configuration</h1> +<p>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 the +<a href="http://docs.couchdb.org/en/latest/config/index.html#config";>Configuring CouchDB</a> +section.</p> +</div></div></div><div id="page-cors" class="pagecontainer"><div class="leftside page"><img src="assets/cors.png"></div><div class="rightside linen page"><div class="textbox"><h1 id="cors">CORS</h1> +<p>CORS stands for Cross Origin Resource Sharing. It is a setting that +pertains only to browsers.</p> +<p>By enabling CORS, you allow other people, from <i>their</i> browsers, +to access the data you have stored in your CouchDB databases.</p> +<p>They can ping your CouchDB instance through an AJAX request, +and it will return information. Or they can POST data to your CouchDB +instance, and CORS allows you to recieve that information.</p> +<p>For example, +if your CouchDB installation is running on the domain <code>alice.example</code> +you can ping someone else's CouchDB instance through an AJAX request +from a different domain, e.g. <code>bob.example</code> - or even localhost!</p> +<p>But be careful - allowing any domain to access your data can be a +security risk. If you only want certain websites (origins) to be able +to retrieve and change data, you can set 'Restrict to specific +domains', and then list which origins you want to allow access for.</p> +<p>By setting, 'All domains', you allow anyone from anywhere to ping your +databases, and retrieve information that way.</p> +<p>If you disable CORS, the JavaScript that makes the AJAX request needs +to run on the same domain. With CORS disabled frontend code that runs +on <code>alice.example</code> must be also hosted on <code>alice.example</code>. +Disabling CORS, means that no browser that pings your databases will +recieve information.</p> +<p>You can also limit who can ping you. If you only +want certain websites, or origins, to be able to recieve data from +your stores, you can set 'Restrict to specific domains', and then list +which origins you want to allow access.</p> +<p>This is a browser specific layer of protection, a second layer of +protection, if you will. The first layer of protection comes from the +permissions you set on each database using roles. (For more +information, see +<a href="http://docs.couchdb.org/en/latest/api/database/security.html";>CouchDB Security</a>)</p> +</div></div></div><div id="page-replication" class="pagecontainer"><div class="leftside page"><img src="assets/replicator.png"></div><div class="rightside linen page"><div class="textbox"><h1 id="replication">Replication</h1> +<p>This is the interface to the replication system, enabling you to initiate +replication between local and remote databases.</p> +<p>You will see two boxes, with 3 boxes in each bigger box.</p> +<p>Depending on how big your screen is, the top (or leftmost box, labeled +#1 in the example) is the Source database. The bottom (or rightmost +box, label #2) is the Target database.</p> +<p>From the Source database box (#1), you can choose an existing +database from the dropdown, by selecting 'Local' like in the image to +the left. Or you can specify a remote database as the Source, by +clicking on 'Remote' in that box, and typing in the remote database's +address.</p> +<p>In the Target database box (#2), choose either a local or remote +database. If you want to create a new database, and replicate into +that new DB, check the 'Create Target' button.</p> +<p>For continuous Replications, select the 'continuous' checkbox. +'Continous' means that the target database will update itself whenever +the source database is updated, from now on. It will continue to +update itself until you cancel the continous replication.</p> +<p>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 +<code>http://username:pass@remotehost:5984/demo</code>.</p> +<p>Under the <a href="#page-active-tasks">Active Tasks</a> tab, you should see in +the table your new created replication. You might miss it if the +database being replicated is on the small side, but continous +replications will always show up while they are active.</p> +<p>For more information, see +<a href="http://docs.couchdb.org/en/latest/api/server/common.html#api-server-replicate";>/_replicate</a>.</p> +<p>For more information on replication, see +<a href="http://docs.couchdb.org/en/latest/replication/index.html#replication";>Replication</a>.</p> +</div></div></div><div id="page-login" class="pagecontainer"><div class="leftside page"><img src="assets/add-admin.png"></div><div class="rightside linen page"><div class="textbox"><h1 id="login-user-management">Login/User Management</h1> +<p>You can change your password, or add admins to your CouchDB instance +within this tab.</p> +</div></div></div><div id="page-verify" class="pagecontainer"><div class="leftside page"><img src="assets/verify.png"></div><div class="rightside linen page"><div class="textbox"><h1 id="verify">Verify</h1> +<p>The Verify Installation allows you to check whether all of the +components of your CouchDB installation are correctly installed.</p> +</div></div></div><div id="page-helpful-links" class="pagecontainer"><div class="leftside page"><img src="assets/troubleshooting.png"></div><div class="rightside linen page"><div class="textbox"><h1 id="helpful-links">Helpful links</h1> +<p><a href="http://docs.couchdb.org/en/latest/install/index.html";>How to Install/Setup</a></p> +<p><a href="https://couchdb.apache.org/";>CouchDB Homepage</a> (more info is +available here!)</p> +<p><a href="http://docs.couchdb.org/en/latest/";>CouchDB Documentation</a></p> +<p><a href="http://wiki.apache.org/couchdb/";>CouchDB Wiki</a></p> +<p><a href="http://guide.couchdb.org/index.html";>CoucDB: The Definitive Guide</a></p> +<p><a href="http://wiki.apache.org/couchdb/Basics";>CouchDB Tutorials</a> General and +Tutorials for Specific Languages</p> +<p><a href="http://webchat.freenode.net/?channels=couchdb";>CouchDB IRC</a> Our chat +channel</p> +</div></div></div><div id="page-answers" class="page"><div class="leftside page"><img src="assets/answers.png"></div><div class="rightside linen page"><div class="textbox"><h1>Answers!</h1><p class="question">Q: Where can I find answers about CouchDB?</p><p class="answer">A: Checkout the <a href="http://wiki.apache.org/couchdb/Frequently_asked_questions";>CouchDB FAQ</a>.</p><p class="question">Q: Wow! this is awesome! how can I contribute?</p><p class="answer">A: Thanks! If you want to contribute, you can open a pull request +on <a href="https://github.com/apache/couchdb-fauxton";>Github</a>.</p><p class="question">Q: What can I do?</p><p class="answer">A: Lots of things! checkout our <a href="https://issues.apache.org/jira/browse/COUCHDB/component/12320406/?selectedTab=com.atlassian.jira.jira-projects-plugin:component-summary-panel";>JIRA</a> page for a list of things we need help fixing or building.</p><p class="question">Q: I'm not a programmer. What can I do?</p><p class="answer">A: Good question. There are many things you can do to help out! Find +a place that you think needs fixing, and find out how to fix it. +</p><p>For example, if you find the documentation a long rabbit hole of +links and links (and links and links....) you could come up with a +hierarchical system of links or strategy guide that would help out a +newbie.</p> +<p>If you have design skills, or would like to learn architecture +skills, you can help out by finding a cumbersome or non-intuitive +part of CouchDB and/or Fauxton and propose a fix. Good ideas are +always welcome :)</p> +<p>Another thing is documentation. We have a lot, but the more the +better! If you find a place in CouchDB that is not well-documented, +feel free!</p> +<p class="question">Q: I found a bug and I think it should be fixed!</p><p class="answer">A: Awesome! Open a pull request and we can make that happen!</p></div></div></div></body></html> \ No newline at end of file http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/fauxton-visual-guide/js/main.js ---------------------------------------------------------------------- diff --git a/fauxton-visual-guide/js/main.js b/fauxton-visual-guide/js/main.js new file mode 100644 index 0000000..aa06e3d --- /dev/null +++ b/fauxton-visual-guide/js/main.js @@ -0,0 +1 @@ +$(function(){var t,n;n=$("#toc");t=$("#toggle-toc-button");return t.click(function(){n.toggleClass("hidden");t.toggleClass("x");return t.text(function(){if(n.hasClass("hidden")){return"TOC"}else{return"X"}})})}); \ No newline at end of file http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/fauxton-visual-guide/main.css ---------------------------------------------------------------------- diff --git a/fauxton-visual-guide/main.css b/fauxton-visual-guide/main.css new file mode 100644 index 0000000..e7f20d9 --- /dev/null +++ b/fauxton-visual-guide/main.css @@ -0,0 +1 @@ +*{margin:0;padding:0;-webkit-text-size-adjust:none}body,a{color:#291d1e}body,h1,h2,h3,h4,pre{font-size:16px;font-family:'HelveticaNeue-Light',Helvetica,Arial,sans-serif;font-weight:300}h1{font-size:34px}h2{font-size:34px;padding:48px 0}b,strong{font-family:'HelveticaNeue-Bold',Helvetica,Arial,sans-serif;font-weight:900}.npm{background-color:#E2E2E2;border:1px solid #c4c4db;margin-left:50px;display:inline-block;padding:10px;margin-top:-10px;margin-bottom:20px}#toggle-toc-button{color:#888;right:20px;top:20px;font-size:12px;padding:10px;position:fixed;font-family:Arial,sans-serif;z-index:1001}#toggle-toc-button:hover{cursor:sw-resize}#toggle-toc-button.x{height:35px;width:100px;font-size:8px;text-align:right;margin-right:6px}#toggle-toc-button.x:hover{cursor:ne-resize}#toc{z-index:1000;width:200px;margin:20px;padding:20px;list-style-type:none;position:fixed;right:5px;background-color:rgba(255,255,255,0.9)}#toc li{padding:2px}#toc a{color:#c56969;text-decoration:none}#toc a:hover{text- decoration:underline}#toc.hidden{display:none}.pagecontainer{min-height:800px;clear:both}.page{min-height:800px;overflow-y:auto}.page img{margin-top:70px;height:600px;display:block;margin-left:auto;margin-right:auto}.page img.couch{height:auto;position:relative;top:50%;-webkit-transform:translateY(50%);-ms-transform:translateY(50%);transform:translateY(50%)}.leftside{width:50%;float:left}.rightside{color:green;width:50%;float:right;height:100%}.linen{background:url(assets/linen.jpg) #eee 50% 0%}.textbox{color:gray;border:1px solid #d8d8d8;min-height:600px;width:87%;margin:auto;margin-top:70px;margin-bottom:50px;background-color:rgba(242,242,242,0.85);overflow:hidden}.textbox h1{font-size:30px;text-align:center;margin:20px 10px;color:#B5B5B5}.textbox p{padding:5px 30px 15px 30px;line-height:1.5}.textbox p.br{padding:0 30px;line-height:1}.textbox p.indent{margin-left:15px}.textbox p.question{font-weight:600;padding-bottom:0}.textbox p.answer{padding-top:0}#introBox{text-align:center;m in-height:320px;display:block;position:relative;top:50%;-webkit-transform:translateY(50%);-ms-transform:translateY(50%);transform:translateY(50%)}#introBox h1{margin-top:100px}#introBox h1{font-size:60px;color:#C0C0C0}#introBox h2{font-size:16px;padding:0}#page-overview img{margin-top:300px;height:auto}#page-header-bar .head-header-section .firstleft{padding-top:100px}#page-header-bar .head-header-section .firstright{height:2806px}#page-header-bar .head-header-section .firstright .long-header-textbox{height:95%}#page-header-bar .tail-header-section{position:absolute;width:100%}#page-header-bar .tail-header-section .headerSection{overflow:hidden}#page-header-bar .tail-header-section > .headerSection:first-child .leftside{padding-top:130px}#page-header-bar .tail-header-section .leftside{padding-top:40px}#page-header-bar img{padding:30px;width:936px;height:auto}#page-header-bar .textbox{min-height:auto;border:none}#page-header-bar .border{border:1px solid black}#page-header-bar .redbor der{border:1px solid red}#page-header-bar .blueborder{border:1px solid blue}#page-header-bar .greenborder{border:1px solid green}#page-header-bar .subleft{overflow-y:auto}#page-header-bar .clearfix{clear:both}#page-answers img{height:auto} \ No newline at end of file http://git-wip-us.apache.org/repos/asf/couchdb-www/blob/d0c8d7cf/index.html ---------------------------------------------------------------------- diff --git a/index.html b/index.html index 4d78e97..8360ddc 100644 --- a/index.html +++ b/index.html @@ -148,6 +148,7 @@ This fabulous linen texture was integrated into the site design. Fauxton is the âkiller appâ that makes CouchDB so powerful and easy to manage. </p> <ul> + <li>— <a href="fauxton-visual-guide/index.html">Fauxton, a Visual Guide</a></li> <li>— <a href="https://github.com/apache/couchdb-fauxton";>Fauxton on GitHub</a></li> <li>— <a href="http://docs.couchdb.org/en/latest/fauxton/addons.html";>Writing an Addon</a></li> </ul>
