diff options
| author | Sid Sijbrandij <sytse@gitlab.com> | 2016-08-04 10:45:59 +0000 |
|---|---|---|
| committer | Sid Sijbrandij <sytse@gitlab.com> | 2016-08-04 10:45:59 +0000 |
| commit | 1de019f5c8a76da10877b8a2b4f27823374c6da2 (patch) | |
| tree | 98dfce4afb16806098c1c52a84695ad21bb73116 | |
| parent | 3dbec7f49a14802dbee1513a9d0015f935b3642f (diff) | |
| download | gitlab-ce-1de019f5c8a76da10877b8a2b4f27823374c6da2.tar.gz | |
Structure the development documentation
| -rw-r--r-- | doc/development/README.md | 33 |
1 files changed, 26 insertions, 7 deletions
diff --git a/doc/development/README.md b/doc/development/README.md index c5d5af43864..11aa50b89af 100644 --- a/doc/development/README.md +++ b/doc/development/README.md @@ -1,18 +1,37 @@ # Development +## Outside of docs + +- [CONTRIBUTING.md](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md) main contributing guide +- [PROCESS.md](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/PROCESS.md) contributing process +- [GitLab Development Kit (GDK)](https://gitlab.com/gitlab-org/gitlab-development-kit) to install a development version + +## Styleguides + +- [Documentation styleguide](development/doc_styleguide.md) Use this styleguide if you are + contributing to documentation. +- [Migration Style Guide](migration_style_guide.md) for creating safe migrations +- [Testing standards and style guidelines](testing.md) +- [UI guide](ui_guide.md) for building GitLab with existing css styles and elements +- [SQL guidelines](sql.md) for SQL guidelines + + +## Process + +- [Code review guidelines](code_review.md) for reviewing code and having code reviewed. + +## Backend howtos + - [Architecture](architecture.md) of GitLab - [CI setup](ci_setup.md) for testing GitLab -- [Code review guidelines](code_review.md) for reviewing code and having code - reviewed. - [Gotchas](gotchas.md) to avoid - [How to dump production data to staging](db_dump.md) - [Instrumentation](instrumentation.md) -- [Licensing](licensing.md) for ensuring license compliance -- [Migration Style Guide](migration_style_guide.md) for creating safe migrations - [Performance guidelines](performance.md) - [Rake tasks](rake_tasks.md) for development - [Shell commands](shell_commands.md) in the GitLab codebase - [Sidekiq debugging](sidekiq_debugging.md) -- [SQL guidelines](sql.md) for SQL guidelines -- [Testing standards and style guidelines](testing.md) -- [UI guide](ui_guide.md) for building GitLab with existing css styles and elements + +## Compliance + +- [Licensing](licensing.md) for ensuring license compliance |