INTRO.md

Go Developer Documentation

Setting up GitBook

We're using GitBook for generating our HTML Docs from markdown files. It is hosted here, and if you would like to contribute, you need GitBook setup for the same.

Building and serving

gitbook serve

Status Legend

• Not Done
• In Progress
• Pending Review
• Done

Index

1. Concepts in Go

• 1.1 Domain
• 1.2 Implementation

2. Getting Started

• 2.1 Setting up your development environment
• 2.2 How to go about making changes to the codebase
• 2.3 How to add a configuration migration
• 2.4 How to add a database migration

3. Technology Stack

• 3.1 Plugins Architecture - OSGi
• 3.2 Object Relation Mapping (ORM) - Hibernate & IBatis
• 3.3 Caching - EhCache
• 3.4 Dependency Injection (DI) - Spring
• 3.5 Model View Controller (MVC)
• 3.6 User Interface (UI) - jQuery & Prototype, SCSS, HTML
• 3.7 Build Tool - Buildr

4. Architecture of Go

• 4.1 Overview
• 4.2 Go Server
• 4.3 Go Agent
• 4.4 Common
• 4.5 Build Infrastructure

5. Features

• 5.1 Dashboard
• 5.2 Fan-in
• 5.3 Value Stream Map
• 5.4 Compare Pipeline
• 5.5 PackageRepository
• 5.6 Command Repository
• 5.7 Environments
• 5.8 Templates
• 5.9 Shine
• 5.10 OAuth Gadgets
• 5.11 Backup

6. CD in practice

• 6.1 Build Go Using Go
• 6.2 Test Infrastructure
• 6.3 Continuous Deployment

7. Miscellaneous

• 7.1 Technical Debt

8. Writing Go Plugins

• Overview
• Go Plugin Architecture
• Go Plugin Basics
• Go Plugin User Guide
• Go Plugin API
• Package Repository Extension
• Package repository plugin using java interface/class based plugin API
• Package repository plugin using JSON message based plugin API
• Task Extension
• Task plugin using java interface/class based plugin API
• Task plugin using JSON message based plugin API