Merge Backend/README.md in main minion README

[GrmpCerber]

Frontend readme is empty where Backend/README.md seems to contain a lot of useful informations some of wich are already in the main README and other critical are not.

1. minion-backend mentions scripts/minion-db-init
   • which is not in main readme.
   • This script is working correctly but I'm still not declared as an administrator ( / I still have the default landing page)
2. Unfortunately both README do not share the same base path / command name.
   • minion and minion-backend will have their own virtualenv ==> 2x Python installed
   • minion uses ./setup.sh run-backend where minion-backend uses scripts/minion-backend-api runserver

[yeukhon]

This inconsistency does throw people off.

Let me address the virtualenv issue first. You are only forced to see two env when you are using the VM I built for the preview of 0.3. The setup.sh script in mozilla/minion will setup under a single virtualenv called "env" if you don't supply the path where you want to build your virtualenv (this is 90% true, but a misleading, see my next comment).
https://github.com/mozilla/minion/blob/master/setup.sh#L46

In general, you don't want to cluster two projects into a single virtualenv. Hence why I mandate my VM to have two separate virtualenv. If the community finds it difficult, I can put them into a single one for the next VM.

Now back to the the 1.2 point: you might have this issue, please do a fetch and then rebase
mozilla/minion-backend@8b125bd

$ backend
$ git stash
$ git fetch
$ git rebase origin/master

stash will put your uncommitted changes aside

to 1.1: that's a problem. I think we have to discuss what to put together, where the doc should fall under. We might continue to use mozilla/minion as the ultimate source for README and all other readme will link back here (including the documentation).

to 2.2 yeah that's because mozilla/minion is really for quick setting up both minion-backend and frontend. That little shell script serves that single purpose. The minion scripts are correct. When you run the shell script you do python setup.py, and setuptools will move certain "scripts" to location like the current environment's bin.

(b)vagrant@precise64:~$ which minion-db-init
/opt/minion/b/bin/minion-db-init

[yeukhon]

My bad. I gave out somewhat misleading/confusing information. I was looking at the wrong line. When I created the vm I actually had my own setup.sh to install each backend and frontend into its own virtualenv.

The script from minion repo will always put them under the same environment called env (I hope this clarify my point). We can change how the vm works in the next release of the VM. I think we will at some point this week.

[GrmpCerber]

foreword

Sorry yeukhon I think you missunderstood me : I'm not using the official VM, I did a manual setup on one of my own VM

In general, you don't want to cluster ...

I'm not fluent with python so this point is not obvious to me.
For the moment I thought these two envs were juste a mistake and a waste of space / bandwith (minon/env is 60MB on my VM)

back to business

to 1.1 and 1.2 : Beeing a new user with what I would call a "a fresh look" I wanted to tell you that I was using minion/README as a "quick start guide".
Now that I'm able to login (see mozilla/minion-frontend#95 :) ) I'd like to figure out what minion does and what I will be able to do with it.
Unfortunately the default landing page is not explicit on what to do next :

You do not have any sites in Minion yet. This should become a nice landing page for new users.

So I tried to register me as a power user.
This is not described in the main readme but might be in the backend with scripts/minion-db-init.
I've tried the script and it ended without error but also without any visible change (I still have the default landing page)
Since then, as suggested in backend's readme, I also tried scripts/minion-create-* which told me that these values where already registered. That's why I suppose scripts/minion-db-init works. (unfortunately I'm still not able to get rid of the default landing page / go forward with minion ... I'll post a question on that tomorrow)

to 1.2 :

you might have this issue, please do a fetch and then rebase

I did a fresh clone of minion followed by ./setup.py clone (today) so this should have pulled your commit... or not ?

to 2.2 : Ok, but then I suggest you to either highlight the reasons why one would need to run them directly from backend/scripts or remove it from backend's readme since this duplicate info is useless/might be misleading

[yeukhon]

Thanks. So the good news is we are working on the documentation. See a working copy: https://minion-yeukhon.readthedocs.org/en/latest/
We are still making a lot of changes to make it more readable and concise. The installation section is still a bit confusing and I will chop down some information later.

I think you are making a good point merging REAMDE, referencing them under a single README. Better yet, once we have the documentation setup, we should just point them to that URL.

> This script is working correctly but I'm still not declared as an administrator

One user found our init script does not accept username with space. Example: Yeuk Hon doing so will fail the init script silently. So if you tried to enter your full name, you probably want to fetch and rebase to the latest. (or clone, whichever way makes sense to you).
The proxy error shouldn't prevent anyone from using the init script as the script makes http request directly to the backend api, which in turns will write to the database. No persona login in that process.

No landing page. Yes. It is one of the low-hanging issues. We can change the way the "blank" landing page should read. It should say "You do not seem to be associate with any sites. Only administrator can create and configure sites and plans for you."

That might be better. of course we welcome PR if you have a better idea or string.