From 57c3e1a0b329ecc8fa67d5c9a2f32ae6e98d8f35 Mon Sep 17 00:00:00 2001
From: ivaosthu <ivar.conradi.osthus@finn.no>
Date: Wed, 30 Nov 2016 23:56:33 +0100
Subject: [PATCH] more docs

---
 README.md               | 79 ++++-------------------------------------
 docs/developer-guide.md | 76 +++++++++++++++++++++++++++++++++++++++
 2 files changed, 83 insertions(+), 72 deletions(-)
 create mode 100644 docs/developer-guide.md

diff --git a/README.md b/README.md
index 90e37ba38d..1bcee95d66 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # unleash
 
-__Warning: We are in the process of splitting up unleash into multiple packages in this repository, if you want to test the previous package see [previous tag](https://github.com/unleash/unleash/tree/v1.0.0-alpha.2) __ 
+__Warning: We will soon release the first official version of Unleash (1.0.0). If you want to test the previous package see [previous tag](https://github.com/unleash/unleash/tree/v1.0.0-alpha.2) __ 
 
 [![Build Status](https://travis-ci.org/Unleash/unleash.svg?branch=master)](https://travis-ci.org/Unleash/unleash)
 [![Coverage Status](https://coveralls.io/repos/github/Unleash/unleash/badge.svg?branch=master)](https://coveralls.io/github/Unleash/unleash?branch=master)
@@ -14,79 +14,14 @@ This repo contains the unleash-server, which contains the admin UI and a place t
 Known client implementations:
 - [unleash-client-java](https://github.com/unleash/unleash-client-java)
 - [unleash-client-node](https://github.com/unleash/unleash-client-node)
+- (you implementaiton here!)
 
 ## Project details
 - [Project Roadmap](https://github.com/unleash/unleash/wiki/Roadmap)
 
+## Developer Guide
+If you want to contribute to this project you are encuraged to send issue request, or provie pull-requests. 
+Please read the [unleas developer guide](./docs/developer-guide.md) to learn more on how you can contribute. 
+
 ## Run with docker
-We have set up docker-compose to start postgres and the unleash server together. This makes it really fast to start up
-unleash locally without setting up a database or node.
-
-You find the docker files inside the `packages/unleash-docker` folder
-
-```bash
-$ docker-compose build
-$ docker-compose up
-```
-
-## Development
-
-### Create a local unleash databases in postgres
-
-```bash
-$ psql postgres <<SQL
-CREATE USER unleash_user WITH PASSWORD 'passord';
-CREATE DATABASE unleash;
-GRANT ALL PRIVILEGES ON DATABASE unleash to unleash_user;
-CREATE DATABASE unleash_test;
-GRANT ALL PRIVILEGES ON DATABASE unleash_test to unleash_user;
-SQL
-```
-
-Then set env vars:
-```
-export DATABASE_URL=postgres://unleash_user:passord@localhost:5432/unleash
-export TEST_DATABASE_URL=postgres://unleash_user:passord@localhost:5432/unleash_test
-```
-
-### Commands
-
-```
-// Install dependencies
-npm install
-
-// Build unleash-frontend 
-// (yes this is a bit wierd and be easier when we have a release of the frontend artifact).
-// You can of course "npm link unleash-frontend" instead 
-cd node_modules/unleash-frontend && npm install
-
-// Start server in development
-npm start:dev
-
-// Admin dashboard
-http://localhost:4242
-
-// Feature API:
-http://localhost:4242/api/features
-
-// Execute tests in all packages:
-npm test
-```
-
-### Making a schema change
-
-1. Create `migrations/sql/NNN-your-migration-name.up.sql` with your change in SQL.
-2. Create `migrations/sql/NNN-your-migration-name.down.sql` with the rollback of your change in SQL.
-3. Run `db-migrate create your-migration-name` and edit the generated file to have this line: `module.exports = require('../scripts/migration-runner').create('NNN-your-migration-name');`
-4. Run `db-migrate up`.
-5. Generate LB artifact using `scripts/generate-liquibase-artifact` (TODO: make this internal)
-
-
-### Publishing / Releasing new packages
-
-Please run `npm run nsp` nad `npm run lint` checks before publishing.
-
-Run `npm run publish` to start the publishing process.
-Lerna is setup with independent versioning so you will be prompted with version per package, and lerna will update all the versions across packages.
-
-`npm run publish:dry` 
+We have made a sperate project which runs unleash inside docker. Please see [unelash-docker](https://github.com/Unleash/unleash-docker)
diff --git a/docs/developer-guide.md b/docs/developer-guide.md
new file mode 100644
index 0000000000..3efe1e7c4a
--- /dev/null
+++ b/docs/developer-guide.md
@@ -0,0 +1,76 @@
+# Developer Guide
+
+## Postgre
+To run and develop unleash you need to have PostgreSQL databse (PostgreSQL v.9.5.x or newer) locally.
+
+
+### Create a local unleash databases in postgres
+
+```bash
+$ psql postgres <<SQL
+CREATE USER unleash_user WITH PASSWORD 'passord';
+CREATE DATABASE unleash;
+GRANT ALL PRIVILEGES ON DATABASE unleash to unleash_user;
+CREATE DATABASE unleash_test;
+GRANT ALL PRIVILEGES ON DATABASE unleash_test to unleash_user;
+SQL
+```
+
+Then set env vars:
+
+(Optional as unleash will asume these as default values).
+
+```
+export DATABASE_URL=postgres://unleash_user:passord@localhost:5432/unleash
+export TEST_DATABASE_URL=postgres://unleash_user:passord@localhost:5432/unleash_test
+```
+
+## PostgreSQL with docker
+If you dont want to install PostgreSQL locally you can spin up an instance with docker. 
+We have created a script to ease this process: `scripts/docker-postgres.sh`
+
+
+## Commands
+
+```
+// Install dependencies
+npm install
+
+// Build unleash-frontend 
+// (yes this is a bit wierd and be easier when we have a release of the frontend artifact).
+// You can of course "npm link unleash-frontend" instead 
+cd node_modules/unleash-frontend && npm install
+
+// Start server in development
+npm start:dev
+
+// Admin dashboard
+http://localhost:4242
+
+// Feature API:
+http://localhost:4242/api/features
+
+// Execute tests in all packages:
+npm test
+```
+
+## Database changes
+
+We use database migrations to track database changes. 
+
+### Making a schema change
+
+1. Create `migrations/sql/NNN-your-migration-name.up.sql` with your change in SQL.
+2. Create `migrations/sql/NNN-your-migration-name.down.sql` with the rollback of your change in SQL.
+3. Run `db-migrate create your-migration-name` and edit the generated file to have this line: `module.exports = require('../scripts/migration-runner').create('NNN-your-migration-name');`
+4. Run `db-migrate up`.
+
+
+## Publishing / Releasing new packages
+
+Please run `npm run nsp` nad `npm run lint` checks before publishing.
+
+Run `npm run publish` to start the publishing process.
+Lerna is setup with independent versioning so you will be prompted with version per package, and lerna will update all the versions across packages.
+
+`npm run publish:dry` 
\ No newline at end of file