Skip to content

Commit

Permalink
Update docs and koding for "gdk" command
Browse files Browse the repository at this point in the history
  • Loading branch information
jacobvosmaer committed Aug 8, 2016
1 parent 921843b commit eb711c8
Show file tree
Hide file tree
Showing 8 changed files with 26 additions and 39 deletions.
7 changes: 4 additions & 3 deletions .koding.yml
Original file line number Diff line number Diff line change
Expand Up @@ -51,14 +51,15 @@ resource:
echo _KD_NOTIFY_@Cloning GitLab repository...@
# clone and run gitlab
git clone https://gitlab.com/gitlab-org/gitlab-development-kit.git
gem install gitlab-development-kit
gdk init
# force to use 0.0.0.0 for localhost
echo "0.0.0.0" > gitlab-development-kit/host
echo _KD_NOTIFY_@Compiling GitLab...@
cd gitlab-development-kit
make
gdk install
EOF
Expand All @@ -70,7 +71,7 @@ resource:
echo ""
echo "Now launch a new terminal and do;"
echo " $ cd gitlab-development-kit"
echo " $ ./run"
echo " $ gdk run"
echo ""
echo _KD_DONE_
Expand Down
16 changes: 0 additions & 16 deletions bootstrap

This file was deleted.

2 changes: 1 addition & 1 deletion doc/howto/browse.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ quickest way to do it.

```
cd gitlab-development-kit
./run
gdk run
```

Open [localhost:3000](http://localhost:3000) in your web browser. It
Expand Down
4 changes: 2 additions & 2 deletions doc/howto/https.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,8 @@ On OS X you can add this certificate to the trust store with:
Next make sure that HTTPS is enabled in gitlab/config/gitlab.yml: look
for the `https:` and `port:` settings.

Uncomment the `nginx` line in your Procfile. Now `./run app`
(and `./run`) will start NGINX listening on https://localhost:3443.
Uncomment the `nginx` line in your Procfile. Now `gdk run app`
(and `gdk run`) will start NGINX listening on https://localhost:3443.

If you are using a port other than localhost:3000 for
gitlab-workhorse, or if you want to use a port other than
Expand Down
4 changes: 2 additions & 2 deletions doc/howto/local_network.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,12 @@ application then run:

```
echo 0.0.0.0 > host
./run
gdk run
```

If you would like to revert back to the `localhost` network then run:

```
rm host
./run
gdk run
```
2 changes: 1 addition & 1 deletion doc/howto/performance_metrics.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Golang compiler and NPM installed. InfluxDB and Grafana consume about
You need to have a working GDK installation before you install InfluxDB
and Grafana.

First make sure you do not have `./run` active anywhere. Then run:
First make sure you do not have `gdk run` active anywhere. Then run:

rm Procfile
make performance-metrics-setup
Expand Down
4 changes: 2 additions & 2 deletions doc/howto/pry.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,6 @@ development server (localhost:3000) you need to comment out the
`rails-web:` line in the Procfile in your GDK root directory because
Unicorn is not compatible with Pry.

Then launch GDK as usual (e.g. with `./run`) and in a separate
terminal run: `./run thin`. Your Pry prompts will appear in the window
Then launch GDK as usual (e.g. with `gdk run`) and in a separate
terminal run: `gdk run thin`. Your Pry prompts will appear in the window
that runs Thin.
26 changes: 14 additions & 12 deletions doc/set-up-gdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,31 +8,32 @@ contain 'problematic' characters such as ` ` and `(`. For example,
cause problems.

```
git clone https://gitlab.com/gitlab-org/gitlab-development-kit.git
gem install gitlab-development-kit
gdk init
cd gitlab-development-kit
```

The `Makefile` will clone the repositories, install the Gem bundles and set up
The `gdk install` command will clone the repositories, install the Gem bundles and set up
basic configuration files. Pick one:

## Develop in a fork

```
# Set up GDK with 'origin' pointing to your gitlab-ce fork.
# Replace MY-FORK with your namespace
make gitlab_repo=https://gitlab.com/MY-FORK/gitlab-ce.git
gdk install gitlab_repo=https://gitlab.com/MY-FORK/gitlab-ce.git
support/set-gitlab-upstream
```

The set-gitlab-upstream script creates a remote named `upstream` for
[the canonical GitLab CE
repository](https://gitlab.com/gitlab-org/gitlab-ce). It also modifies
`make update` (See [Update gitlab and gitlab-shell
`gdk update` (See [Update gitlab and gitlab-shell
repositories](Update gitlab and gitlab-shell repositories)) to pull
down from the upstream repository instead of your fork, making it
easier to keep up-to-date with the project.

If you want to push changes from upstream to your fork, run `make
If you want to push changes from upstream to your fork, run `gdk
update` and then `git push origin` from the `gitlab` directory.

## Develop in the main repo
Expand All @@ -41,7 +42,7 @@ Alternatively, you can clone all components from their official source.

```
# Clone your own forked repositories
make
gdk install
```


Expand All @@ -56,13 +57,14 @@ instead of 3000 so that you can run GDK EE next to CE without port
conflicts.

```
git clone https://gitlab.com/gitlab-org/gitlab-development-kit.git gdk-ee
gem install gdk
gdk init gdk-ee
cd gdk-ee
echo 3001 > port
make gitlab_repo=https://gitlab.com/gitlab-org/gitlab-ee.git
gdk install gitlab_repo=https://gitlab.com/gitlab-org/gitlab-ee.git
```

Now you can start GitLab EE with `./run` in the `gdk-ee` directory and you
Now you can start GitLab EE with `gdk run` in the `gdk-ee` directory and you
will not have port conflicts with a separate GDK instance for CE that
might still be running.

Expand All @@ -73,15 +75,15 @@ onboarding document: https://about.gitlab.com/handbook/developer-onboarding/#git

Start GitLab and all required services:

./run
gdk run

To start only the databases use:

./run db
gdk run db

To start only the app (assuming the DBs are already running):

./run app
gdk run app

To access GitLab you may now go to http://localhost:3000 in your
browser. The development login credentials are `root` and `5iveL!fe`.
Expand Down

0 comments on commit eb711c8

Please sign in to comment.