Fix #1130: Add FAQ page for developers (#1650)

docs/source/faq(developers).md

@@ -0,0 +1,194 @@
+## Frequently Asked Questions
+
+#### Q. How to start contributing?
+
+EvalAI’s issue tracker is good place to start. If you find something that interests you, comment on the thread and we’ll help get you started.
+Alternatively, if you come across a new bug on the site, please file a new issue and comment if you would like to be assigned. Existing issues are tagged with one or more labels, based on the part of the website it touches, its importance etc., which can help you select one.
+
+#### Q. What are the technologies that EvalAI uses?
+
+##### Django
+Django is the heart of the application, which powers our backend. We use Django version 1.10.
+
+##### Django Rest Framework
+We use Django Rest Framework for writing and providing REST APIs. It's permission and serializers have helped write a maintainable codebase.
+
+##### RabbitMQ
+We currently use RabbitMQ for queueing submission messages which are then later on processed by a Python worker.
+
+##### PostgreSQL
+PostgresSQL is used as our primary datastore. All our tables currently reside in a single database named evalai.
+
+##### Angular JS - ^1.6.1
+Angular JS is a well-known framework that powers our frontend.
+
+#### Q. Where could I learn Github Commands?
+
+Refer to [Github Guide](https://help.github.com/articles/git-and-github-learning-resources/).
+
+#### Q. Where could I learn Markdown?
+
+Refer to [MarkDown Guide](https://guides.github.com/features/mastering-markdown/).
+
+#### Q. What to do when coverage decreases in your pull request?
+
+Coverage decreases when the existing test cases don't test the new code you wrote. If you click coverage, you can see exactly which all parts aren't covered and you can write new tests to test the parts. 
+
+### Common Errors during installation
+
+#### Q. While using `pip install -r dev/requirement.txt`
+
+```
+ Writing manifest file 'pip-egg-info/psycopg2.egg-info/SOURCES.txt'
+ Error: You need to install postgresql-server-dev-X.Y for building a server-side extension or
+ libpq-dev for building a client-side application.
+ ----------------------------------------
+ Command "python setup.py egg_info" failed with error code 1 in /tmp/pip-build-qIjU8G/psycopg2/
+```
+
+Use the following commands in order to solve the error:
+
+1. `sudo apt-get install postgresql`
+2. `sudo apt-get install python-psycopg2`
+3. `sudo apt-get install libpq-dev`
+
+#### Q. While using `pip install -r dev/requirement.txt`
+
+```
+Command “python setup.py egg_info” failed with error code 1 in 
+/private/var/folders/c7/b45s17816zn_b1dh3g7yzxrm0000gn/T/pip-build- GM2AG/psycopg2/
+```
+
+Firstly check that you have installed all the mentioned dependencies.
+Then, Upgrade the version of postgresql to 10.1 in order to solve it.
+
+#### Q. Getting an import error 
+
+```
+Couldn't import Django,"when using command python manage.py migrate
+```
+
+Firstly, check that you have activated the virtualenv.
+Install python dependencies using the following commands on the command line
+
+```
+cd evalai
+pip install -r requirements/dev.txt
+```
+
+#### Q. Getting Mocha Error 
+
+```
+Can not load reporter “mocha”,it is not registered
+```
+
+Uninstall karma and then install  
+
+```
+npm uninstall -g generator-karma && npm install -g generator-angular.
+```
+
+#### Q. While trying to execute `bower install` 
+
+```
+bower: command not found
+```
+
+Execute the following command first : 
+
+```
+npm install -g bower 
+```
+
+#### Q. While trying to execute `gulp dev:runserver` 
+
+```
+gulp: command not found
+```
+
+Execute the following command first 
+
+```
+npm install -g gulp-cli
+
+```
+
+#### Q. While executing `gulp dev:runserver`
+
+```
+events.js:160
+throw er; // Unhandled 'error' event
+^
+Error: Gem sass is not installed.
+```
+
+Execute the following command first : 
+
+```
+gem install sass
+
+```
+
+#### Q. While trying to install `npm config set proxy http://proxy:port` on UBUNTU, I get the following error:
+
+```
+ubuntu@ubuntu-Inspiron-3521:~/Desktop/Python-2.7.14$ npm install -g angular-cli
+npm ERR! Linux 4.4.0-21-generic
+npm ERR! argv "/usr/bin/nodejs" "/usr/bin/npm" "install" "-g" "angular-cli"
+npm ERR! node v4.2.6
+npm ERR! npm  v3.5.2
+npm ERR! code ECONNRESET
+
+npm ERR! network tunneling socket could not be established, cause=getaddrinfo ENOTFOUND proxy proxy:80
+npm ERR! network This is most likely not a problem with npm itself
+npm ERR! network and is related to network connectivity.
+npm ERR! network In most cases you are behind a proxy or have bad network settings.
+npm ERR! network 
+npm ERR! network If you are behind a proxy, please make sure that the
+npm ERR! network 'proxy' config is set properly.  See: 'npm help config'
+
+npm ERR! Please include the following file with any support request:
+npm ERR!     /home/ubuntu/Desktop/Python-2.7.14/npm-debug.log
+```
+
+To solve, execute the following commands:
+1. `npm config set registry=registry.npmjs.org`
+
+If the above does not work, try deleting them by following commands:
+1. `npm config delete proxy`
+2. `npm config delete https-proxy`
+
+Then, start the instllation process of frontend once more.
+
+#### Q. While using docker, I am getting the following error on URL [http://localhost:8888/](http://localhost:8888/) 
+
+```
+Cannot Get \
+```
+Try removing the docker containers and then building them again.
+
+
+#### Q. Getting the following error while running `python manage.py seed`
+
+```
+Starting the database seeder. Hang on... Exception while running run() in 'scripts.seed' Database successfully seeded
+```
+
+Change the pyhton version to 2.7.x . The problem might be because of the pyhton 3.0 version.
+
+#### Q. Getting the following error while executing command `createdb evalai -U postgres`
+
+```
+createdb: could not connect to database template1: FATAL: Peer authentication failed for user "postgres"
+```
+
+Try creating a new user and then grant all the privileges to it and then create a db.
+
+#### Q. Getting the following error while executing `npm install`
+
+```
+npm WARN [email protected] requires a peer of generator-
+karma@>=0.9.0 but none was installed.
+```
+
+Uninstall and then install karma again and also don't forget to clean the global as well as project npm cache. Then try again the step 8.

docs/source/index.rst

@@ -19,6 +19,7 @@ Contents:
    architecture_decisions
    directory_structure
    participate
+   faq(developers)
    migrations
    contribution
    pull_request