Add doc file for dev rake tasks

Dmitriy Zaporozhets
1 parent 2eaca545
Showing 2 changed files with 30 additions and 2 deletions Show diff stats
doc/development/README.md
doc/development/rake_tasks.md
-+ [Architecture](architecture.md)
-+ [Shell commands](shell_commands.md)
+## Development 
+
++ [Architecture](architecture.md) of GitLab
++ [Shell commands](shell_commands.md) in the GitLab codebase
++ [Rake tasks](rake_tasks.md) for development
@@ -0,0 +1,25 @@
+# Rake tasks for developers
+
+## Setup db with developer seeds:
+
+Note that if your db user does not have advanced privilegies you must create db manually before run this command 
+
+```
+bundle exec rake setup
+```
+
+## Run tests
+
+This runs all test suite present in GitLab 
+
+```
+bundle exec rake test
+```
+
+## Generate searchable docs for source code
+
+You can find results under `doc/code` directory
+
+```
+bundle exec rake gitlab:generate_docs
+```
1		-+ [Architecture](architecture.md)
2		-+ [Shell commands](shell_commands.md)
	1	+## Development
	2	+
	3	++ [Architecture](architecture.md) of GitLab
	4	++ [Shell commands](shell_commands.md) in the GitLab codebase
	5	++ [Rake tasks](rake_tasks.md) for development
...	...
...	...	@@ -0,0 +1,25 @@
	1	+# Rake tasks for developers
	2	+
	3	+## Setup db with developer seeds:
	4	+
	5	+Note that if your db user does not have advanced privilegies you must create db manually before run this command
	6	+
	7	+```
	8	+bundle exec rake setup
	9	+```
	10	+
	11	+## Run tests
	12	+
	13	+This runs all test suite present in GitLab
	14	+
	15	+```
	16	+bundle exec rake test
	17	+```
	18	+
	19	+## Generate searchable docs for source code
	20	+
	21	+You can find results under `doc/code` directory
	22	+
	23	+```
	24	+bundle exec rake gitlab:generate_docs
	25	+```
...	...