diff options
| author | Garren Smith <garren.smith@gmail.com> | 2014-05-29 11:43:05 +0200 |
|---|---|---|
| committer | Garren Smith <garren.smith@gmail.com> | 2014-05-29 14:17:02 +0200 |
| commit | 9c301c16231ef1cca00176446bedaea52fcc1c9b (patch) | |
| tree | 87cd2746e72b2590d8fe05c4082e1fc660356c7a | |
| parent | 17031e89f3d35286f0a04993a4dbcd710b484ea8 (diff) | |
| download | couchdb-9c301c16231ef1cca00176446bedaea52fcc1c9b.tar.gz | |
Fauxtin: Remove Todo, clean up readme
We haven't used todo.md in a long time. All the tickets are in JIRA.
I've just removed some old wording from the readme.md
| -rw-r--r-- | src/Makefile.am | 1 | ||||
| -rw-r--r-- | src/fauxton/TODO.md | 24 | ||||
| -rw-r--r-- | src/fauxton/readme.md | 35 |
3 files changed, 11 insertions, 49 deletions
diff --git a/src/Makefile.am b/src/Makefile.am index 92ec8f1f9..7801c988d 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -343,6 +343,5 @@ FAUXTON_FILES = \ fauxton/test/mocha/testUtils.js \ fauxton/test/runner.html \ fauxton/test/test.config.underscore \ - fauxton/TODO.md \ fauxton/CONTRIBUTING.md \ fauxton/writing_addons.md diff --git a/src/fauxton/TODO.md b/src/fauxton/TODO.md deleted file mode 100644 index a4b2a8e1a..000000000 --- a/src/fauxton/TODO.md +++ /dev/null @@ -1,24 +0,0 @@ -# Fauxton todo -In no particular order - -- [ ] docco docs -- [ ] user management -- [ ] view options -- [ ] view editor -- [ ] visual view builder -- [ ] new db as modal -- [ ] new view button -- [ ] show design docs only -- [ ] fix delete doc button UI bug -- [ ] delete multiple docs via _bulk_docs -- [x] show change events in database view -- [ ] pouchdb addon -- [ ] bespoke bootstrap style -- [ ] responsive interface -- [ ] sticky subnav for some UI components on _all_docs -- [ ] "show me" button in API bar doesn't -- [ ] edit index button doesn't -- [ ] replicate UI -- [x] delete database -- [x] format dates better (e.g. in logs plugin) -- [ ] restore unfiltered data in logs UI diff --git a/src/fauxton/readme.md b/src/fauxton/readme.md index bb810956e..dc36a17bb 100644 --- a/src/fauxton/readme.md +++ b/src/fauxton/readme.md @@ -1,19 +1,7 @@ Fauxton ======= -This is the initial implementation of Fauxton, focused on fleshing out -the various pieces of functionality and as a test bed for new ideas. -Full functionality and design considerations will be added later. - - - -Current items of interest: - - * Live JSON editor with dynamic JS Hinting and error popups - * Initial plugin system - * Minimal externally loadable plugin example - * Data popups for additional db info on \_all_dbs page - * CouchDB API compliant urls +Fauxton is the new Web UI for CouchDB. To get it running in development on your machine. Follow the steps below. ## Setup Fauxton ## @@ -40,17 +28,6 @@ And then... grunt dev -#### (Optional) To avoid a npm global install - # Add node_modules/.bin to your path - # export PATH=./node_modules/.bin:$PATH - # Or just use the wrappers in ./bin/ - - # Development mode, non minified files - ./bin/grunt couchdebug - - # Or fully compiled install - # ./bin/grunt couchdb - ### Prepare Fauxton Release Follow the "Fauxton Setup" section, Edit settings.json variable root where the document will live. eg. "/_utils/fauxton/" @@ -81,3 +58,13 @@ Each module must have a `base.js` file, this is read and compile when Fauxton is Checkout [Jira](https://issues.apache.org/jira/browse/COUCHDB/component/12320406) for a list of items to do. +## (Optional) To avoid a npm global install + # Add node_modules/.bin to your path + # export PATH=./node_modules/.bin:$PATH + # Or just use the wrappers in ./bin/ + + # Development mode, non minified files + ./bin/grunt couchdebug + + # Or fully compiled install + # ./bin/grunt couchdb |