diff options
Diffstat (limited to 'doc/development/README.md')
| -rw-r--r-- | doc/development/README.md | 52 |
1 files changed, 26 insertions, 26 deletions
diff --git a/doc/development/README.md b/doc/development/README.md index 6d44714d9b0..e2d0c6c2056 100644 --- a/doc/development/README.md +++ b/doc/development/README.md @@ -1,27 +1,27 @@ -# Development +# GitLab development guides ## Get started! - Setup GitLab's development environment with [GitLab Development Kit (GDK)](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/master/doc/howto/README.md) -- [GitLab Contributing Guide](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md) +- [GitLab contributing guide](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md) - [Architecture](architecture.md) of GitLab - [Rake tasks](rake_tasks.md) for development ## Processes -- [GitLab Core Team & GitLab Inc. Contribution Process](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/PROCESS.md) +- [GitLab core team & GitLab Inc. contribution process](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/PROCESS.md) - [Generate a changelog entry with `bin/changelog`](changelog.md) - [Code review guidelines](code_review.md) for reviewing code and having code reviewed. - [Limit conflicts with EE when developing on CE](limit_ee_conflicts.md) -## UX and Frontend Guides +## UX and frontend guides - [UX guide](ux_guide/index.md) for building GitLab with existing CSS styles and elements - [Frontend guidelines](fe_guide/index.md) -## Backend Guides +## Backend guides -- [Testing Standards and Style guidelines](testing_guide/index.md) +- [Testing standards and style guidelines](testing_guide/index.md) - [API styleguide](api_styleguide.md) Use this styleguide if you are contributing to the API. - [Sidekiq guidelines](sidekiq_style_guide.md) for working with Sidekiq workers @@ -35,52 +35,52 @@ - [Issue and merge requests state models](object_state_models.md) - [How to dump production data to staging](db_dump.md) -## Performance Guides +## Performance guides - [Instrumentation](instrumentation.md) - [Performance guidelines](performance.md) - [Merge request performance guidelines](merge_request_performance_guidelines.md) for ensuring merge requests do not negatively impact GitLab performance -## Databases Guides +## Databases guides ### Migrations - [What requires downtime?](what_requires_downtime.md) - [SQL guidelines](sql.md) for working with SQL queries -- [Migrations Style Guide](migration_style_guide.md) for creating safe SQL migrations -- [Post Deployment Migrations](post_deployment_migrations.md) -- [Background Migrations](background_migrations.md) -- [Swapping Tables](swapping_tables.md) +- [Migrations style guide](migration_style_guide.md) for creating safe SQL migrations +- [Post deployment migrations](post_deployment_migrations.md) +- [Background migrations](background_migrations.md) +- [Swapping tables](swapping_tables.md) ### Best practices -- [Merge Request Checklist](database_merge_request_checklist.md) +- [Merge Request checklist](database_merge_request_checklist.md) - [Adding database indexes](adding_database_indexes.md) -- [Foreign Keys & Associations](foreign_keys.md) -- [Single Table Inheritance](single_table_inheritance.md) -- [Polymorphic Associations](polymorphic_associations.md) -- [Serializing Data](serializing_data.md) -- [Hash Indexes](hash_indexes.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) - -## Documentation Guides +- [Foreign keys & associations](foreign_keys.md) +- [Single table inheritance](single_table_inheritance.md) +- [Polymorphic associations](polymorphic_associations.md) +- [Serializing data](serializing_data.md) +- [Hash indexes](hash_indexes.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) + +## Documentation guides - [Documentation styleguide](doc_styleguide.md): Use this styleguide if you are contributing to the documentation. - [Writing documentation](writing_documentation.md) - [Distinction between general documentation and technical articles](writing_documentation.md#distinction-between-general-documentation-and-technical-articles) -## Internationalization (i18n) Guides +## Internationalization (i18n) guides - [Introduction](i18n/index.md) - [Externalization](i18n/externalization.md) - [Translation](i18n/translation.md) -## Build Guides +## Build guides - [Building a package for testing purposes](build_test_package.md) |