diff options
author | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-08-22 17:09:15 +0300 |
---|---|---|
committer | Achilleas Pipinellis <axilleas@axilleas.me> | 2016-08-22 17:09:15 +0300 |
commit | 915dda1421d8227c0ba395bfdb04ff915724c4ac (patch) | |
tree | edd56c72784ae915bcf1765b1379200cf896f154 /doc | |
parent | 94cfd4adb21f4ebbb115978e022a88cd4cf03d69 (diff) |
Split Koding admin/user docs
Diffstat (limited to 'doc')
-rw-r--r-- | doc/README.md | 2 | ||||
-rw-r--r-- | doc/administration/integration/koding.md (renamed from doc/integration/koding.md) | 21 | ||||
-rw-r--r-- | doc/user/project/img/koding_build-in-progress.png (renamed from doc/integration/img/koding_build-in-progress.png) | bin | 70949 -> 70949 bytes | |||
-rw-r--r-- | doc/user/project/img/koding_build-logs.png (renamed from doc/integration/img/koding_build-logs.png) | bin | 263623 -> 263623 bytes | |||
-rw-r--r-- | doc/user/project/img/koding_build-success.png (renamed from doc/integration/img/koding_build-success.png) | bin | 304666 -> 304666 bytes | |||
-rw-r--r-- | doc/user/project/img/koding_commit-koding.yml.png (renamed from doc/integration/img/koding_commit-koding.yml.png) | bin | 302703 -> 302703 bytes | |||
-rw-r--r-- | doc/user/project/img/koding_different-stack-on-mr-try.png (renamed from doc/integration/img/koding_different-stack-on-mr-try.png) | bin | 333649 -> 333649 bytes | |||
-rw-r--r-- | doc/user/project/img/koding_edit-on-ide.png (renamed from doc/integration/img/koding_edit-on-ide.png) | bin | 330880 -> 330880 bytes | |||
-rw-r--r-- | doc/user/project/img/koding_enable-koding.png (renamed from doc/integration/img/koding_enable-koding.png) | bin | 73499 -> 73499 bytes | |||
-rw-r--r-- | doc/user/project/img/koding_landing.png (renamed from doc/integration/img/koding_landing.png) | bin | 268455 -> 268455 bytes | |||
-rw-r--r-- | doc/user/project/img/koding_open-gitlab-from-koding.png (renamed from doc/integration/img/koding_open-gitlab-from-koding.png) | bin | 32559 -> 32559 bytes | |||
-rw-r--r-- | doc/user/project/img/koding_run-in-ide.png (renamed from doc/integration/img/koding_run-in-ide.png) | bin | 65465 -> 65465 bytes | |||
-rw-r--r-- | doc/user/project/img/koding_run-mr-in-ide.png (renamed from doc/integration/img/koding_run-mr-in-ide.png) | bin | 339759 -> 339759 bytes | |||
-rw-r--r-- | doc/user/project/img/koding_set-up-ide.png (renamed from doc/integration/img/koding_set-up-ide.png) | bin | 207481 -> 207481 bytes | |||
-rw-r--r-- | doc/user/project/img/koding_stack-import.png (renamed from doc/integration/img/koding_stack-import.png) | bin | 500352 -> 500352 bytes | |||
-rw-r--r-- | doc/user/project/img/koding_start-build.png (renamed from doc/integration/img/koding_start-build.png) | bin | 105253 -> 105253 bytes | |||
-rw-r--r-- | doc/user/project/koding.md (renamed from doc/integration/koding-usage.md) | 78 |
17 files changed, 56 insertions, 45 deletions
diff --git a/doc/README.md b/doc/README.md index fc51ea911b9..195b7c7af62 100644 --- a/doc/README.md +++ b/doc/README.md @@ -18,6 +18,7 @@ - [SSH](ssh/README.md) Setup your ssh keys and deploy keys for secure access to your projects. - [Webhooks](web_hooks/web_hooks.md) Let GitLab notify you when new code has been pushed to your project. - [Workflow](workflow/README.md) Using GitLab functionality and importing projects from GitHub and SVN. +- [Koding](user/project/koding.md) Learn how to use Koding, the online IDE. ## Administrator documentation @@ -29,6 +30,7 @@ - [Restart GitLab](administration/restart_gitlab.md) Learn how to restart GitLab and its components. - [Integration](integration/README.md) How to integrate with systems such as JIRA, Redmine, Twitter. - [Issue closing](customization/issue_closing.md) Customize how to close an issue from commit messages. +- [Koding](administration/integration/koding.md) Set up Koding to use with GitLab. - [Libravatar](customization/libravatar.md) Use Libravatar for user avatars. - [Log system](administration/logs.md) Log system. - [Environment Variables](administration/environment_variables.md) to configure GitLab. diff --git a/doc/integration/koding.md b/doc/administration/integration/koding.md index 53450b6d048..a2c358af095 100644 --- a/doc/integration/koding.md +++ b/doc/administration/integration/koding.md @@ -1,5 +1,7 @@ # Koding & GitLab +> [Introduced][ce-5909] in GitLab 8.11. + This document will guide you through installing and configuring Koding with GitLab. @@ -12,10 +14,9 @@ provisioned VMs. This agent is called Klient and it provides Koding to access and manage the target machine. Kontrol and Klient are based on another technology called -[Kite](github.com/koding/kite), that we have written at Koding. Which is a +[Kite](https://github.com/koding/kite), that we have written at Koding. Which is a microservice framework that allows you to develop microservices easily. - ## Requirements ### Hardware @@ -31,20 +32,20 @@ least a `c3.xlarge` instance. ### Software - - [git](https://git-scm.com) - - [docker](https://www.docker.com) + - [Git](https://git-scm.com) + - [Docker](https://www.docker.com) - [docker-compose](https://www.docker.com/products/docker-compose) Koding can run on most of the UNIX based operating systems, since it's shipped as containerized with Docker support, it can work on any operating system that supports Docker. -Required services are; +Required services are: - - PostgreSQL # Kontrol and Service DB provider - - MongoDB # Main DB provider the application - - Redis # In memory DB used by both application and services - - RabbitMQ # Message Queue for both application and services +- **PostgreSQL** - Kontrol and Service DB provider +- **MongoDB** - Main DB provider the application +- **Redis** - In memory DB used by both application and services +- **RabbitMQ** - Message Queue for both application and services which are also provided as a Docker container by Koding. @@ -237,3 +238,5 @@ login) once you accept you will be redirected to your Koding instance. From now on you can login by using `SIGN IN WITH GITLAB` button on your Login screen in your Koding instance. + +[ce-5909]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/5909 diff --git a/doc/integration/img/koding_build-in-progress.png b/doc/user/project/img/koding_build-in-progress.png Binary files differindex f8cc81834c4..f8cc81834c4 100644 --- a/doc/integration/img/koding_build-in-progress.png +++ b/doc/user/project/img/koding_build-in-progress.png diff --git a/doc/integration/img/koding_build-logs.png b/doc/user/project/img/koding_build-logs.png Binary files differindex a04cd5aff99..a04cd5aff99 100644 --- a/doc/integration/img/koding_build-logs.png +++ b/doc/user/project/img/koding_build-logs.png diff --git a/doc/integration/img/koding_build-success.png b/doc/user/project/img/koding_build-success.png Binary files differindex 2a0dd296480..2a0dd296480 100644 --- a/doc/integration/img/koding_build-success.png +++ b/doc/user/project/img/koding_build-success.png diff --git a/doc/integration/img/koding_commit-koding.yml.png b/doc/user/project/img/koding_commit-koding.yml.png Binary files differindex 3e133c50327..3e133c50327 100644 --- a/doc/integration/img/koding_commit-koding.yml.png +++ b/doc/user/project/img/koding_commit-koding.yml.png diff --git a/doc/integration/img/koding_different-stack-on-mr-try.png b/doc/user/project/img/koding_different-stack-on-mr-try.png Binary files differindex fd25e32f648..fd25e32f648 100644 --- a/doc/integration/img/koding_different-stack-on-mr-try.png +++ b/doc/user/project/img/koding_different-stack-on-mr-try.png diff --git a/doc/integration/img/koding_edit-on-ide.png b/doc/user/project/img/koding_edit-on-ide.png Binary files differindex fd5aaff75f5..fd5aaff75f5 100644 --- a/doc/integration/img/koding_edit-on-ide.png +++ b/doc/user/project/img/koding_edit-on-ide.png diff --git a/doc/integration/img/koding_enable-koding.png b/doc/user/project/img/koding_enable-koding.png Binary files differindex c0ae0ee9918..c0ae0ee9918 100644 --- a/doc/integration/img/koding_enable-koding.png +++ b/doc/user/project/img/koding_enable-koding.png diff --git a/doc/integration/img/koding_landing.png b/doc/user/project/img/koding_landing.png Binary files differindex 7c629d9b05e..7c629d9b05e 100644 --- a/doc/integration/img/koding_landing.png +++ b/doc/user/project/img/koding_landing.png diff --git a/doc/integration/img/koding_open-gitlab-from-koding.png b/doc/user/project/img/koding_open-gitlab-from-koding.png Binary files differindex c958cf8f224..c958cf8f224 100644 --- a/doc/integration/img/koding_open-gitlab-from-koding.png +++ b/doc/user/project/img/koding_open-gitlab-from-koding.png diff --git a/doc/integration/img/koding_run-in-ide.png b/doc/user/project/img/koding_run-in-ide.png Binary files differindex f91ee0f74cc..f91ee0f74cc 100644 --- a/doc/integration/img/koding_run-in-ide.png +++ b/doc/user/project/img/koding_run-in-ide.png diff --git a/doc/integration/img/koding_run-mr-in-ide.png b/doc/user/project/img/koding_run-mr-in-ide.png Binary files differindex 502817a2a46..502817a2a46 100644 --- a/doc/integration/img/koding_run-mr-in-ide.png +++ b/doc/user/project/img/koding_run-mr-in-ide.png diff --git a/doc/integration/img/koding_set-up-ide.png b/doc/user/project/img/koding_set-up-ide.png Binary files differindex 7f408c980b5..7f408c980b5 100644 --- a/doc/integration/img/koding_set-up-ide.png +++ b/doc/user/project/img/koding_set-up-ide.png diff --git a/doc/integration/img/koding_stack-import.png b/doc/user/project/img/koding_stack-import.png Binary files differindex 2a4e3c87fc8..2a4e3c87fc8 100644 --- a/doc/integration/img/koding_stack-import.png +++ b/doc/user/project/img/koding_stack-import.png diff --git a/doc/integration/img/koding_start-build.png b/doc/user/project/img/koding_start-build.png Binary files differindex 52159440f62..52159440f62 100644 --- a/doc/integration/img/koding_start-build.png +++ b/doc/user/project/img/koding_start-build.png diff --git a/doc/integration/koding-usage.md b/doc/user/project/koding.md index bb74badce66..e54587fab68 100644 --- a/doc/integration/koding-usage.md +++ b/doc/user/project/koding.md @@ -1,7 +1,10 @@ # Koding & GitLab +> [Introduced][ce-5909] in GitLab 8.11. + This document will guide you through using Koding integration on GitLab in -detail. For configuring and installing please follow [this](koding.md) guide. +detail. For configuring and installing please follow the +[administrator guide](../../administration/integration/koding.md). You can use Koding integration to run and develop your projects on GitLab. This will allow you and the users to test your project without leaving the browser. @@ -10,29 +13,26 @@ environment for your project. With this integration you can automatically create a proper stack template for your projects. Currently auto-generated stack templates are designed to work with AWS which requires a valid AWS credential to be able to use these stacks. You can find more information about -stacks and the other providers that you can use on Koding from -[here](https://www.koding.com/docs). - +stacks and the other providers that you can use on Koding following the +[Koding documentation][koding-docs]. -# Enable Integration +## Enable Integration You can enable Koding integration by providing the running Koding instance URL -in Application Settings; +in Application Settings under **Admin area > Settings** (`/admin/application_settings`). - - Open **Admin area > Settings** (`/admin/application_settings`). - -![Enable Koding](help/integration/img/koding_enable-koding.png) +![Enable Koding](img/koding_enable-koding.png) Once enabled you will see `Koding` link on your sidebar which leads you to -Koding Landing page +Koding Landing page. -![Koding Landing](help/integration/img/koding_landing.png) +![Koding Landing](img/koding_landing.png) You can navigate to running Koding instance from here. For more information and -details about configuring integration please follow [this](koding.md) guide. - +details about configuring the integration, please follow the +[administrator guide](../../administration/integration/koding.md). -# Set up Koding on Projects +## Set up Koding on Projects Once it's enabled, you will see some integration buttons on Project pages, Merge Requests etc. To get started working on a specific project you first need @@ -40,83 +40,89 @@ to create a `.koding.yml` file under your project root. You can easily do that by using `Set Up Koding` button which will be visible on every project's landing page; -![Set Up Koding](help/integration/img/koding_set-up-ide.png) +![Set Up Koding](img/koding_set-up-ide.png) Once you click this will open a New File page on GitLab with auto-generated `.koding.yml` content based on your server and repository configuration. -![Commit .koding.yml](help/integration/img/koding_commit-koding.yml.png) +![Commit .koding.yml](img/koding_commit-koding.yml.png) -# Run a project on Koding +## Run a project on Koding If there is `.koding.yml` exists in your project root, you will see `Run in IDE (Koding)` button in your project landing page. You can initiate the process from here. -![Run on Koding](help/integration/img/koding_run-in-ide.png) +![Run on Koding](img/koding_run-in-ide.png) This will open Koding defined in the settings in a new window and will start -importing the project's stack file; +importing the project's stack file. -![Import Stack](help/integration/img/koding_stack-import.png) +![Import Stack](img/koding_stack-import.png) You should see the details of your repository imported into your Koding instance. Once it's completed it will lead you to the Stack Editor and from there you can start using your new stack integrated with your project on your GitLab instance. For details about what's next you can follow -[this](https://www.koding.com/docs/creating-an-aws-stack) guide from 8. step. +[this guide](https://www.koding.com/docs/creating-an-aws-stack) from step 8. Once stack initialized you will see the `README.md` content from your project in `Stack Build` wizard, this wizard will let you to build the stack and import your project into it. **Once it's completed it will automatically open the -related vm instead of importing from scratch** +related vm instead of importing from scratch**. -![Stack Building](help/integration/img/koding_start-build.png) +![Stack Building](img/koding_start-build.png) This will take time depending on the required environment. -![Stack Building in Progress](help/integration/img/koding_build-in-progress.png) +![Stack Building in Progress](img/koding_build-in-progress.png) It usually takes ~4 min. to make it ready with a `t2.nano` instance on given AWS region. (`t2.nano` is default vm type on auto-generated stack template -which can be manually changed) +which can be manually changed). -![Stack Building Success](help/integration/img/koding_build-success.png) +![Stack Building Success](img/koding_build-success.png) -You can check out the `Build Logs` from this success modal as well; +You can check out the `Build Logs` from this success modal as well. -![Stack Build Logs](help/integration/img/koding_build-logs.png) +![Stack Build Logs](img/koding_build-logs.png) You can now `Start Coding`! -![Edit On IDE](help/integration/img/koding_edit-on-ide.png) +![Edit On IDE](img/koding_edit-on-ide.png) - -# Try a Merge Request on IDE +## Try a Merge Request on IDE It's also possible to try a change on IDE before merging it. This flow only enabled if the target project has `.koding.yml` in it's target branch. You should see the alternative version of `Run in IDE (Koding)` button in merge request pages as well; -![Run in IDE on MR](help/integration/img/koding_run-mr-in-ide.png) +![Run in IDE on MR](img/koding_run-mr-in-ide.png) This will again take you to Koding with proper arguments passed, which will allow Koding to modify the stack template provided by target branch. You can see the difference; -![Different Branch for MR](help/integration/img/koding_different-stack-on-mr-try.png) +![Different Branch for MR](img/koding_different-stack-on-mr-try.png) The flow for the branch stack is also same with the regular project flow. - -# Open GitLab from Koding +## Open GitLab from Koding Since stacks generated with import flow defined in previous steps, they have information about the repository they are belonging to. By using this information you can access to related GitLab page from stacks on your sidebar on Koding. -![Open GitLab from Koding](help/integration/img/koding_open-gitlab-from-koding.png) +![Open GitLab from Koding](img/koding_open-gitlab-from-koding.png) + +## Other links + +- [YouTube video on GitLab + Koding workflow][youtube] +- [Koding documentation][koding-docs] +[ce-5909]: https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/5909 +[youtube]: https://youtu.be/3wei5yv_Ye8 +[koding-docs]: https://www.koding.com/docs |