Commit 1dfca44045f4c0563e3fd78690113109a2bfae39
1 parent
c720190f
Exists in
master
Add the first draft of development doc.
Showing
1 changed file
with
18 additions
and
0 deletions
Show diff stats
@@ -0,0 +1,18 @@ | @@ -0,0 +1,18 @@ | ||
1 | +# Development setup | ||
2 | + | ||
3 | +To avoid building the packages for every change you do during development, it is useful to setup a VM on which you can develop. | ||
4 | + | ||
5 | +Once you get the VM running, download the package from `https://about.gitlab.com/downloads/` and using the directions there | ||
6 | +finish the package installation. | ||
7 | + | ||
8 | +Once the package is installed, navigate to `/opt/gitlab/embedded/cookbooks` and remove the `gitlab` directory which holds the internal omnibus-gitlab cookbook. | ||
9 | + | ||
10 | +Clone the omnibus-gitlab repository from `https://gitlab.com/gitlab-org/omnibus-gitlab.git` to a known location, for example `/home/`. | ||
11 | + | ||
12 | +Once the repository is cloned symlink the cookbook in the omnibus-gitlab repository, for example: | ||
13 | + | ||
14 | +``` | ||
15 | +ln -s /home/omnibus-gitlab/files/gitlab-cookbooks/gitlab /opt/gitlab/embedded/cookbooks | ||
16 | +``` | ||
17 | + | ||
18 | +Now you can do the changes in the omnibus-gitlab repository, try the changes right away and contribute back to omnibus-gitlab. |