From 1dfca44045f4c0563e3fd78690113109a2bfae39 Mon Sep 17 00:00:00 2001 From: Marin Jankovski Date: Thu, 28 Aug 2014 13:34:28 +0200 Subject: [PATCH] Add the first draft of development doc. --- doc/development.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+), 0 deletions(-) create mode 100644 doc/development.md diff --git a/doc/development.md b/doc/development.md new file mode 100644 index 0000000..20917dd --- /dev/null +++ b/doc/development.md @@ -0,0 +1,18 @@ +# Development setup + +To avoid building the packages for every change you do during development, it is useful to setup a VM on which you can develop. + +Once you get the VM running, download the package from `https://about.gitlab.com/downloads/` and using the directions there +finish the package installation. + +Once the package is installed, navigate to `/opt/gitlab/embedded/cookbooks` and remove the `gitlab` directory which holds the internal omnibus-gitlab cookbook. + +Clone the omnibus-gitlab repository from `https://gitlab.com/gitlab-org/omnibus-gitlab.git` to a known location, for example `/home/`. + +Once the repository is cloned symlink the cookbook in the omnibus-gitlab repository, for example: + +``` +ln -s /home/omnibus-gitlab/files/gitlab-cookbooks/gitlab /opt/gitlab/embedded/cookbooks +``` + +Now you can do the changes in the omnibus-gitlab repository, try the changes right away and contribute back to omnibus-gitlab. -- libgit2 0.21.2