You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@couchdb.apache.org by michellephung <gi...@git.apache.org> on 2016/09/13 03:55:07 UTC
[GitHub] couchdb-documentation pull request #64: fix Fauxton docs
GitHub user michellephung opened a pull request:
https://github.com/apache/couchdb-documentation/pull/64
fix Fauxton docs
Please check since i've never made a PR to couchdb-docs before
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/michellephung/couchdb-documentation Fix-Fauxton-Docs
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/couchdb-documentation/pull/64.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #64
----
commit e109982ba5f0bf6a60fd33d435d0e0eb9aa823b3
Author: michellephung <mi...@gmail.com>
Date: 2016-09-13T03:53:24Z
fix Fauxton docs
----
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] couchdb-documentation pull request #64: fix Fauxton docs
Posted by garrensmith <gi...@git.apache.org>.
Github user garrensmith commented on a diff in the pull request:
https://github.com/apache/couchdb-documentation/pull/64#discussion_r89774433
--- Diff: src/fauxton/install.rst ---
@@ -96,6 +74,11 @@ layout, data, breadcrumbs and api point is required for the view.
.. _backbone.js: http://backbonejs.org/
.. _Backbone.layoutmanager: https://github.com/tbranyen/backbone.layoutmanager
+Writing Add-Ons
+---------------
+We have Fauxton Add-On documentation:
+ https://github.com/apache/couchdb-fauxton/blob/master/writing_addons.md
--- End diff --
These addon docs are so old. We need to update them before linking to them. Maybe we should leave this out
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] couchdb-documentation pull request #64: fix Fauxton docs
Posted by garrensmith <gi...@git.apache.org>.
Github user garrensmith commented on a diff in the pull request:
https://github.com/apache/couchdb-documentation/pull/64#discussion_r89774111
--- Diff: src/fauxton/install.rst ---
@@ -12,66 +12,44 @@
.. _fauxton/install:
-============
-Installation
-============
-
-Recent versions of `node.js`_ and `npm`_ are required.
-
-.. _node.js: http://nodejs.org/
-.. _npm: https://npmjs.org/doc/README.html
-
-Get the source
-==============
-
-Clone the CouchDB repo::
-
- $ git clone http://git-wip-us.apache.org/repos/asf/couchdb.git
- $ cd couchdb
-
+=============
Fauxton Setup
=============
-Install all dependencies::
+Fauxton is included with CouchDB 2.0, so make sure CouchDB is running, then go to::
- couchdb/ $ cd src/fauxton
- couchdb/src/fauxton/ $ npm install
+ http://127.0.0.1:5984/_utils/
-.. note::
- To avoid a npm global install add ``node_modules/.bin`` to your path::
+You can also upgrade to the latest version of Fauxton by using npm::
- export PATH=./node_modules/.bin:$PATH
+ $ npm install -g fauxton
+ $ fauxton
- Or just use the wrappers in ``./bin/``.
+(Recent versions of `node.js`_ and `npm`_ are required.)
- Development mode, non minified files::
-
- ./bin/grunt couchdebug
-
- Or fully compiled install::
-
- ./bin/grunt couchdb
-
-Dev Server
-==========
+.. _node.js: http://nodejs.org/
+.. _npm: https://npmjs.org/doc/README.html
-Using the dev server is the easiest way to use Fauxton, specially when
-developing for it::
+Fauxton Visual Guide
+====================
+You can find the Visual Guide here:
+ http://couchdb.apache.org/fauxton-visual-guide
- grunt dev
+Development Server
+==================
-Deploy Fauxton
-==============
+Recent versions of `node.js`_ and `npm`_ are required.
-Deploy Fauxton to your local CouchDB instance:
+.. _node.js: http://nodejs.org/
+.. _npm: https://npmjs.org/doc/README.html
- ./bin/grunt couchapp_deploy
+Using the dev server is the easiest way to use Fauxton, specially when developing for it::
-The Fauxton be available by `/fauxton/_design/fauxton/index.html
-<http://localhost:5984/fauxton/_design/fauxton/index.html>`_
+ $ npm install -g fauxton
+ $ npm run dev
--- End diff --
This only works in the couchdb-fauxton repo
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] couchdb-documentation pull request #64: fix Fauxton docs
Posted by garrensmith <gi...@git.apache.org>.
Github user garrensmith commented on a diff in the pull request:
https://github.com/apache/couchdb-documentation/pull/64#discussion_r89774150
--- Diff: src/fauxton/install.rst ---
@@ -12,66 +12,44 @@
.. _fauxton/install:
-============
-Installation
-============
-
-Recent versions of `node.js`_ and `npm`_ are required.
-
-.. _node.js: http://nodejs.org/
-.. _npm: https://npmjs.org/doc/README.html
-
-Get the source
-==============
-
-Clone the CouchDB repo::
-
- $ git clone http://git-wip-us.apache.org/repos/asf/couchdb.git
- $ cd couchdb
-
+=============
Fauxton Setup
=============
-Install all dependencies::
+Fauxton is included with CouchDB 2.0, so make sure CouchDB is running, then go to::
- couchdb/ $ cd src/fauxton
- couchdb/src/fauxton/ $ npm install
+ http://127.0.0.1:5984/_utils/
-.. note::
- To avoid a npm global install add ``node_modules/.bin`` to your path::
+You can also upgrade to the latest version of Fauxton by using npm::
- export PATH=./node_modules/.bin:$PATH
+ $ npm install -g fauxton
+ $ fauxton
- Or just use the wrappers in ``./bin/``.
+(Recent versions of `node.js`_ and `npm`_ are required.)
- Development mode, non minified files::
-
- ./bin/grunt couchdebug
-
- Or fully compiled install::
-
- ./bin/grunt couchdb
-
-Dev Server
-==========
+.. _node.js: http://nodejs.org/
+.. _npm: https://npmjs.org/doc/README.html
-Using the dev server is the easiest way to use Fauxton, specially when
-developing for it::
+Fauxton Visual Guide
+====================
+You can find the Visual Guide here:
+ http://couchdb.apache.org/fauxton-visual-guide
- grunt dev
+Development Server
+==================
-Deploy Fauxton
-==============
+Recent versions of `node.js`_ and `npm`_ are required.
-Deploy Fauxton to your local CouchDB instance:
+.. _node.js: http://nodejs.org/
+.. _npm: https://npmjs.org/doc/README.html
- ./bin/grunt couchapp_deploy
+Using the dev server is the easiest way to use Fauxton, specially when developing for it::
-The Fauxton be available by `/fauxton/_design/fauxton/index.html
-<http://localhost:5984/fauxton/_design/fauxton/index.html>`_
+ $ npm install -g fauxton
--- End diff --
Do you mean `git clone fauxton-repo`
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] couchdb-documentation issue #64: fix Fauxton docs
Posted by michellephung <gi...@git.apache.org>.
Github user michellephung commented on the issue:
https://github.com/apache/couchdb-documentation/pull/64
i think i fixed the issues can you check? i put them on the second commit
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] couchdb-documentation issue #64: fix Fauxton docs
Posted by garrensmith <gi...@git.apache.org>.
Github user garrensmith commented on the issue:
https://github.com/apache/couchdb-documentation/pull/64
+1 after the small change
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---
[GitHub] couchdb-documentation pull request #64: fix Fauxton docs
Posted by asfgit <gi...@git.apache.org>.
Github user asfgit closed the pull request at:
https://github.com/apache/couchdb-documentation/pull/64
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastructure@apache.org or file a JIRA ticket
with INFRA.
---