From a67039071d87fd1cc616a9757f3c62a970c7cad9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Cam=20Sa=C3=BCl?= <cammsaul@gmail.com>
Date: Tue, 23 Feb 2016 16:20:55 -0800
Subject: [PATCH] Update developer's guide :yum:
---
bin/dox | 20 -------------
docs/developers-guide.md | 61 ++++++----------------------------------
project.clj | 6 ++--
3 files changed, 11 insertions(+), 76 deletions(-)
delete mode 100755 bin/dox
diff --git a/bin/dox b/bin/dox
deleted file mode 100755
index 9c22a6bb565..00000000000
--- a/bin/dox
+++ /dev/null
@@ -1,20 +0,0 @@
-#!/usr/bin/env bash
-
-set -eu
-set -o pipefail
-
-# Generate Marginalia dox and push them to GitHub pages for this repo
-# You should do this from an up-to-date `master` branch without untracked local changes
-
-git checkout master
-git pull
-lein marg
-cp ./docs/uberdoc.html ~/Desktop/index.html.temp
-git checkout gh-pages
-git pull
-rm index.html
-mv ~/Desktop/index.html.temp index.html
-git add index.html
-git commit -m "Updated dox."
-git push
-git checkout master
diff --git a/docs/developers-guide.md b/docs/developers-guide.md
index f58dd2a80fb..2d00f4b5aa3 100644
--- a/docs/developers-guide.md
+++ b/docs/developers-guide.md
@@ -1,8 +1,8 @@
-> **This guide will teach you:**
-> How to compile your own copy of Metabase
-> How to set up a development environment
-> How to run the Metabase Server
+> **This guide will teach you:**
+> How to compile your own copy of Metabase
+> How to set up a development environment
+> How to run the Metabase Server
> How to contribute back to the Metabase project
@@ -137,43 +137,13 @@ By default, the tests only run against the `h2` driver. You can specify which dr
ENGINES=h2,postgres,mysql,mongo lein test
-At the time of this writing, the valid datasets are `h2`, `postgres`, `mysql`, `mongo`, `sqlserver`, and `sqlite`.
+At the time of this writing, the valid engines are `h2`, `postgres`, `mysql`, `mongo`, `sqlserver`, `sqlite`, `druid`, `bigquery`, and `redshift`. Some of these engines require additional parameters
+when testing since they are impossible to run locally (such as Redshift and Bigquery). The tests will fail on launch and let you know what parameters to supply if needed.
-Run the linters with
-
- lein eastwood # Clojure linters
- lein bikeshed --max-line-length 240
-
-
-#### Bootstrapping (for REPL)
-
-To quickly get your dev environment set up, use the `bootstrap` function to create a new User and Organization.
-Open a REPL in Emacs or with `lein repl` and enter the following:
-
-```clojure
-(use 'metabase.db)
-(setup-db)
-(use 'metabase.bootstrap)
-(bootstrap)
-```
-
-You'll be walked through the steps to get started.
+Run the linters:
-#### API Client (for REPL)
+ lein eastwood && lein bikeshed
-You can make API calls from the REPL using `metabase.http-client`:
-
-```clojure
-(use 'metabase.http-client)
-(defn cl [& args]
- (-> (apply client {:email "crowberto@metabase.com", :password "squawk"} args)
- clojure.pprint/pprint))
-(cl :get "user/current")
-;; -> {:email "crowbetro@metabase.com",
-;; :first_name "Crowbero",
-;; :last_login #inst "2015-03-13T22:55:05.390000000-00:00",
-;; ...}
-```
#### Developing with Emacs
@@ -204,22 +174,9 @@ Start up an instant cheatsheet for the project + dependencies by running
lein instant-cheatsheet
-#### Marginalia
-
-You can generate and view documentation with
-
- lein marg
- open ./docs/uberdoc.html
-
-You can update the GitHub pages documentation using
-
- make dox
-
-You should be on the `master` branch without any uncommited local changes before doing so. Also, make sure you've fetched the branch `gh-pages` and can push it back to `origin`.
-
## License
-Copyright © 2015 Metabase, Inc
+Copyright © 2016 Metabase, Inc
Distributed under the terms of the GNU Affero General Public License (AGPL) except as otherwise noted. See individual files for details.
diff --git a/project.clj b/project.clj
index 6fddc45f0e0..0e44e795654 100644
--- a/project.clj
+++ b/project.clj
@@ -89,11 +89,9 @@
:exclusions [org.clojure/clojure]]
[lein-bikeshed "0.2.0"] ; Linting
[lein-expectations "0.0.8"] ; run unit tests with 'lein expectations'
- [lein-instant-cheatsheet "2.1.4" ; use awesome instant cheatsheet created by yours truly w/ 'lein instant-cheatsheet'
+ [lein-instant-cheatsheet "2.1.5" ; use awesome instant cheatsheet created by yours truly w/ 'lein instant-cheatsheet'
:exclusions [org.clojure/clojure
- org.clojure/tools.namespace]]
- [michaelblume/lein-marginalia "0.9.0" ; generate documentation with 'lein marg'
- :exclusions [org.clojure/clojure]]]
+ org.clojure/tools.namespace]]]
:env {:mb-run-mode "dev"}
:jvm-opts ["-Dlogfile.path=target/log"
"-Xms1024m" ; give JVM a decent heap size to start with
--
GitLab