Details
-
Task
-
Status: Resolved
-
Major
-
Resolution: Fixed
-
None
-
None
-
None
Description
Fauxton is the the next Futon. Now is a good time to get it’s code base into Apache CouchDB.
The code currently lives at https://github.com/cloudant-labs/couchdb/commits/fauxton
Here’s the sub-steps:
1. ask the authors/committers to sign an Apache CLA (in progress)
2. decide on how to integrate the code base (see below)
3. decide if we want to keep calling it Fauxton, or just Futon again.
4. fill out IP Clearance documentation (in progress).
5. prepare the code base with legal requirements, like ASF headers & NOTICE.
I’ll volunteer to do champion all of these.
As for 2. Integration I propose the following:
- Ask INFRA for a separate repository couchdb-futon (or couchdb-fauxon as per 3)
- in the CouchDB repo, make src/futon or wherever it should live a git-submodule to the new couchdb-futon repo.
- Update build-from-checkout/clone instructions to add `git submodule update --init` after `git clone <repo>`
(I realise that not everyone likes submodules, I don’t exactly care about the integration as long as it is a single command that needs to be run to make things work. No solution is without drawbacks, so unless someone can point to a point that makes submodules not work for this, I suggest we avoid this particular bikeshed).
As for 3: Futon.
Once all that is in place we can work on integrating building Fauxton on `make dist`. It should be a matter of installing the dependencies and calling one command. For `make test` we should also run Fauxton’s test suite (when it exists). None of that is critical for the import, though.
Consider this a draft.