07d5759408
Added documentation on adding database indexes ## What does this MR do? This MR adds a guide on when to add database indexes, how to approach this problem, etc ## Are there points in the code the reviewer needs to double check? Spelling, grammar, etc ## Why was this MR needed? Blindly adding indexes can be harmful to the database, and I recently had to remove 48-something unused indexes. ## What are the relevant issue numbers? #20767 ## Does this MR meet the acceptance criteria? - [x] [Documentation created/updated](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/doc/development/doc_styleguide.md) - Tests - [x] All builds are passing - [ ] Conform by the [style guides](https://gitlab.com/gitlab-org/gitlab-ce/blob/master/CONTRIBUTING.md#style-guides) - [x] Branch has no merge conflicts with `master` (if you do - rebase it please) - [x] [Squashed related commits together](https://git-scm.com/book/en/Git-Tools-Rewriting-History#Squashing-Commits) See merge request !5771 |
||
|---|---|---|
| .. | ||
| README.md | ||
| adding_database_indexes.md | ||
| architecture.md | ||
| ci_setup.md | ||
| code_review.md | ||
| db_dump.md | ||
| doc_styleguide.md | ||
| gitlab_architecture_diagram.png | ||
| gitlab_diagram_overview.odg | ||
| gotchas.md | ||
| instrumentation.md | ||
| licensing.md | ||
| migration_style_guide.md | ||
| newlines_styleguide.md | ||
| omnibus.md | ||
| performance.md | ||
| profiling.md | ||
| rake_tasks.md | ||
| scss_styleguide.md | ||
| shared_files.md | ||
| shell_commands.md | ||
| sidekiq_debugging.md | ||
| sql.md | ||
| testing.md | ||
| ui_guide.md | ||
| what_requires_downtime.md | ||
README.md
Development
Outside of docs
- CONTRIBUTING.md main contributing guide
- PROCESS.md contributing process
- GitLab Development Kit (GDK) to install a development version
Styleguides
- Documentation styleguide Use this styleguide if you are contributing to documentation.
- SQL Migration Style Guide for creating safe SQL migrations
- Testing standards and style guidelines
- UI guide for building GitLab with existing CSS styles and elements
- SQL guidelines for SQL guidelines
Process
- Code review guidelines for reviewing code and having code reviewed.
Backend howtos
- Architecture of GitLab
- CI setup for testing GitLab
- Gotchas to avoid
- How to dump production data to staging
- Instrumentation
- Performance guidelines
- Rake tasks for development
- Shell commands in the GitLab codebase
- Sidekiq debugging
Databases
Compliance
- Licensing for ensuring license compliance