gitlab-org--gitlab-foss/doc/development/README.md

# 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/blob/master/doc/howto/README.md) to install a development version

## Styleguides

- [API styleguide](api_styleguide.md) Use this styleguide if you are
  contributing to the API.
- [Documentation styleguide](doc_styleguide.md) Use this styleguide if you are
  contributing to documentation.
- [Writing documentation](writing_documentation.md)
  - [Distinction between general documentation and technical articles](writing_documentation.md#distinction-between-general-documentation-and-technical-articles)
- [SQL Migration Style Guide](migration_style_guide.md) for creating safe SQL migrations
- [Testing standards and style guidelines](testing.md)
- [UX guide](ux_guide/index.md) for building GitLab with existing CSS styles and elements
- [Frontend guidelines](fe_guide/index.md)
- [SQL guidelines](sql.md) for working with SQL queries
- [Sidekiq guidelines](sidekiq_style_guide.md) for working with Sidekiq workers
- [`Gemfile` guidelines](gemfile.md)

## Process

- [Generate a changelog entry with `bin/changelog`](changelog.md)
- [Limit conflicts with EE when developing on CE](limit_ee_conflicts.md)
- [Code review guidelines](code_review.md) for reviewing code and having code reviewed.
- [Merge request performance guidelines](merge_request_performance_guidelines.md)
  for ensuring merge requests do not negatively impact GitLab performance

## Backend howtos

- [Architecture](architecture.md) of GitLab
- [Gotchas](gotchas.md) to avoid
- [How to dump production data to staging](db_dump.md)
- [Instrumentation](instrumentation.md)
- [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)
- [Object state models](object_state_models.md)
- [Building a package for testing purposes](build_test_package.md)
- [Manage feature flags](feature_flags.md)
- [View sent emails or preview mailers](emails.md)
- [Working with Gitaly](gitaly.md)

## Databases

- [Merge Request Checklist](database_merge_request_checklist.md)
- [What requires downtime?](what_requires_downtime.md)
- [Adding database indexes](adding_database_indexes.md)
- [Post Deployment Migrations](post_deployment_migrations.md)
- [Foreign Keys & Associations](foreign_keys.md)
- [Serializing Data](serializing_data.md)
- [Polymorphic Associations](polymorphic_associations.md)
- [Single Table Inheritance](single_table_inheritance.md)
- [Background Migrations](background_migrations.md)
- [Storing SHA1 Hashes As Binary](sha1_as_binary.md)
- [Iterating Tables In Batches](iterating_tables_in_batches.md)
- [Ordering Table Columns](ordering_table_columns.md)
- [Verifying Database Capabilities](verifying_database_capabilities.md)
- [Hash Indexes](hash_indexes.md)
- [Swapping Tables](swapping_tables.md)

## i18n

- [Internationalization for GitLab](i18n_guide.md)

## Compliance

- [Licensing](licensing.md) for ensuring license compliance
create migration style guide. Fixes #2305 2015-05-11 13:09:36 +00:00			`# Development`
Add doc file for dev rake tasks 2014-04-24 17:53:18 +00:00
Structure the development documentation 2016-08-04 10:45:59 +00:00			`## 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`
Link to doc root, not readme of GDK 2016-08-08 15:14:36 +00:00			`- [GitLab Development Kit (GDK)](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/master/doc/howto/README.md) to install a development version`
Structure the development documentation 2016-08-04 10:45:59 +00:00
			`## Styleguides`

Add an API styleguide Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-10-13 16:44:52 +00:00			`- [API styleguide](api_styleguide.md) Use this styleguide if you are`
			`contributing to the API.`
Small refactor of doc/development/README.md - Fix wrong doc_styleguide URL - Clarify migrations refer to SQL - Capitalize CSS 2016-08-10 11:28:56 +00:00			`- [Documentation styleguide](doc_styleguide.md) Use this styleguide if you are`
Structure the development documentation 2016-08-04 10:45:59 +00:00			`contributing to documentation.`
Fix links and do some refactoring 2017-03-29 08:31:39 +00:00			`- [Writing documentation](writing_documentation.md)`
			`- [Distinction between general documentation and technical articles](writing_documentation.md#distinction-between-general-documentation-and-technical-articles)`
Small refactor of doc/development/README.md - Fix wrong doc_styleguide URL - Clarify migrations refer to SQL - Capitalize CSS 2016-08-10 11:28:56 +00:00			`- [SQL Migration Style Guide](migration_style_guide.md) for creating safe SQL migrations`
Structure the development documentation 2016-08-04 10:45:59 +00:00			`- [Testing standards and style guidelines](testing.md)`
Fix link to index.md in development README.md [ci skip] 2016-11-12 19:48:41 +00:00			`- [UX guide](ux_guide/index.md) for building GitLab with existing CSS styles and elements`
Creates Frontend Style guide 2017-03-22 19:30:54 +00:00			`- [Frontend guidelines](fe_guide/index.md)`
Re-organize queues to use for Sidekiq Dumping too many jobs in the same queue (e.g. the "default" queue) is a dangerous setup. Jobs that take a long time to process can effectively block any other work from being performed given there are enough of these jobs. Furthermore it becomes harder to monitor the jobs as a single queue could contain jobs for different workers. In such a setup the only reliable way of getting counts per job is to iterate over all jobs in a queue, which is a rather time consuming process. By using separate queues for various workers we have better control over throughput, we can add weight to queues, and we can monitor queues better. Some workers still use the same queue whenever their work is related. For example, the various CI pipeline workers use the same "pipeline" queue. This commit includes a Rails migration that moves Sidekiq jobs from the old queues to the new ones. This migration also takes care of doing the inverse if ever needed. This does require downtime as otherwise new jobs could be scheduled in the old queues after this migration completes. This commit also includes an RSpec test that blacklists the use of the "default" queue and ensures cron workers use the "cronjob" queue. Fixes gitlab-org/gitlab-ce#23370 2016-10-21 16:13:41 +00:00			`- [SQL guidelines](sql.md) for working with SQL queries`
			`- [Sidekiq guidelines](sidekiq_style_guide.md) for working with Sidekiq workers`
Document "No gems fetched from git repositories" policy [ci skip] 2017-01-27 11:17:21 +00:00			- [`Gemfile` guidelines](gemfile.md)
Structure the development documentation 2016-08-04 10:45:59 +00:00
			`## Process`

Add changelog documentation 2016-10-25 12:09:46 +00:00			- [Generate a changelog entry with `bin/changelog`](changelog.md)
Start to document how to code for CE with EE in mind Signed-off-by: Rémy Coutable <remy@rymai.me> 2016-11-02 16:16:06 +00:00			`- [Limit conflicts with EE when developing on CE](limit_ee_conflicts.md)`
Structure the development documentation 2016-08-04 10:45:59 +00:00			`- [Code review guidelines](code_review.md) for reviewing code and having code reviewed.`
Added performance guidelines for new MRs These guidelines cover the performance requirement for newly submitted merge requests. These guidelines are put in to place to prevent merge requests from negatively impacting GitLab performance as much as possible. 2016-08-19 15:21:00 +00:00			`- [Merge request performance guidelines](merge_request_performance_guidelines.md)`
			`for ensuring merge requests do not negatively impact GitLab performance`
Structure the development documentation 2016-08-04 10:45:59 +00:00
			`## Backend howtos`

Update docs to markdown style guide. 2014-04-24 22:48:22 +00:00			`- [Architecture](architecture.md) of GitLab`
Add "Gotchas" development doc 2016-02-17 03:09:00 +00:00			`- [Gotchas](gotchas.md) to avoid`
Fix the "How to dump production data" link [ci skip] 2016-02-17 02:31:14 +00:00			`- [How to dump production data to staging](db_dump.md)`
Added dev guide for measuring Ruby blocks 2016-04-05 10:37:41 +00:00			`- [Instrumentation](instrumentation.md)`
Added performance guidelines Fixes gitlab-org/gitlab-ce#15254 gitlab-org/gitlab-ce#14277 [ci skip] 2016-04-28 19:44:21 +00:00			`- [Performance guidelines](performance.md)`
Alphabetize Development doc index [ci skip] 2016-02-17 02:29:54 +00:00			`- [Rake tasks](rake_tasks.md) for development`
			`- [Shell commands](shell_commands.md) in the GitLab codebase`
Disable Sidekiq arguments logging by default 2014-12-01 17:58:37 +00:00			`- [Sidekiq debugging](sidekiq_debugging.md)`
Link to object state models [ci skip] 2016-11-17 22:28:44 +00:00			`- [Object state models](object_state_models.md)`
Add a manual job to trigger package build in omnibus 2017-05-05 08:41:16 +00:00			`- [Building a package for testing purposes](build_test_package.md)`
Add feature toggles through Flipper 2017-05-31 21:06:01 +00:00			`- [Manage feature flags](feature_flags.md)`
Add developer documentation about working with sent emails and previews 2017-09-12 15:41:55 +00:00			`- [View sent emails or preview mailers](emails.md)`
Added some Gitaly docs to `docs/development` 2017-09-27 14:59:51 +00:00			`- [Working with Gitaly](gitaly.md)`
Added documentation on adding database indexes 2016-08-11 12:22:21 +00:00
			`## Databases`

Add more database development related docs 2017-08-10 15:53:20 +00:00			`- [Merge Request Checklist](database_merge_request_checklist.md)`
Added guide about migrations and downtime This guide describes various commonly used operations and the impact they have on the availability of a GitLab instance. 2016-08-04 15:17:31 +00:00			`- [What requires downtime?](what_requires_downtime.md)`
Added documentation on adding database indexes 2016-08-11 12:22:21 +00:00			`- [Adding database indexes](adding_database_indexes.md)`
Support for post deployment migrations These are regular Rails migrations that are executed by default. A user can opt-out of these migrations by setting an environment variable during the deployment process. Fixes gitlab-org/gitlab-ce#22133 2016-10-27 12:36:53 +00:00			`- [Post Deployment Migrations](post_deployment_migrations.md)`
Add documentation about adding foreign keys [ci skip] 2017-05-05 12:02:21 +00:00			`- [Foreign Keys & Associations](foreign_keys.md)`
Document not storing serialized data 2017-05-31 11:47:14 +00:00			`- [Serializing Data](serializing_data.md)`
Document not using polymorphic associations Instead of using polymorphic associations a developer should use separate tables. 2017-05-08 11:36:20 +00:00			`- [Polymorphic Associations](polymorphic_associations.md)`
Document not using STI 2017-06-02 12:34:26 +00:00			`- [Single Table Inheritance](single_table_inheritance.md)`
Add the ability to perform background migrations Background migrations can be used to perform long running data migrations without these blocking a deployment procedure. See MR https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/11854 for more information. 2017-06-02 15:12:36 +00:00			`- [Background Migrations](background_migrations.md)`
Added code for defining SHA attributes These attributes are stored in binary in the database, but exposed as strings. This allows one to query/create data using plain SHA1 hashes as Strings, while storing them more efficiently as binary. 2017-06-29 13:37:37 +00:00			`- [Storing SHA1 Hashes As Binary](sha1_as_binary.md)`
Added EachBatch for iterating tables in batches This module provides a class method called `each_batch` that can be used to iterate tables in batches in a more efficient way compared to Rails' `in_batches` method. This commit also includes a RuboCop cop to blacklist the use of `in_batches` in favour of this new method. 2017-07-07 12:49:05 +00:00			`- [Iterating Tables In Batches](iterating_tables_in_batches.md)`
Add more database development related docs 2017-08-10 15:53:20 +00:00			`- [Ordering Table Columns](ordering_table_columns.md)`
Document how to handle different DB (versions) 2017-08-11 12:12:37 +00:00			`- [Verifying Database Capabilities](verifying_database_capabilities.md)`
Document not using database hash indexes 2017-08-11 12:16:08 +00:00			`- [Hash Indexes](hash_indexes.md)`
Document how to swap database tables. 2017-09-11 12:55:14 +00:00			`- [Swapping Tables](swapping_tables.md)`
Structure the development documentation 2016-08-04 10:45:59 +00:00
Add guide to collaborate with i18n. 2017-05-16 18:26:12 +00:00			`## i18n`

			`- [Internationalization for GitLab](i18n_guide.md)`

Structure the development documentation 2016-08-04 10:45:59 +00:00			`## Compliance`

			`- [Licensing](licensing.md) for ensuring license compliance`