summaryrefslogtreecommitdiff
path: root/doc/development/README.md
Commit message (Collapse)AuthorAgeFilesLines
* Track and act upon the number of executed queriesquery-countsYorick Peterse2018-02-011-0/+1
| | | | | | | | | | | This ensures that we have more visibility in the number of SQL queries that are executed in web requests. The current threshold is hardcoded to 100 as we will rarely (maybe once or twice) change it. In production and development we use Sentry if enabled, in the test environment we raise an error. This feature is also only enabled in production/staging when running on GitLab.com as it's not very useful to other users.
* Add documents for GitLab utilitiesdocs-gitlab-utilitiesLin Jen-Shin2018-01-021-0/+1
|
* Merge branch 'no-ivar-in-modules' into 'master'Robert Speicher2017-12-151-0/+1
|\ | | | | | | | | Add cop to make sure we don't use ivar in a module See merge request gitlab-org/gitlab-ce!12800
| * Merge remote-tracking branch 'upstream/master' into no-ivar-in-modulesLin Jen-Shin2017-12-151-1/+2
| |\ | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * upstream/master: (671 commits) Make rubocop happy Use guard clause Improve language Prettify Use temp branch Pass info about who started the job and which job triggered it Docs: add indexes for monitoring and performance monitoring clearer-documentation-on-inline-diffs Add docs for commit diff discussion in merge requests sorting for tags api Clear BatchLoader after each spec to prevent holding onto records longer than necessary Include project in BatchLoader key to prevent returning blobs for the wrong project moved lfs_blob_ids method into ExtractsPath module Converted JS modules into exported modules spec fixes Bump gitlab-shell version to 5.10.3 Clear caches before updating MR diffs Use new Ruby version 2.4 in GitLab QA images moved lfs blob fetch from extractspath file Update GitLab QA dependencies ...
| * | Updates based on feedbackLin Jen-Shin2017-11-221-0/+1
| | |
* | | Docs update documentation guidelinesMarcia Ramos2017-12-151-3/+2
| |/ |/|
* | Add "Guidelines for implementing Enterprise Edition features" in CE ↵docs/improve-limit-conflicts-with-eeRémy Coutable2017-12-061-0/+1
| | | | | | | | | | | | development doc since the doc page is already there Signed-off-by: Rémy Coutable <remy@rymai.me>
* | Move the "Limit conflicts with EE" doc to "Automatic CE-> EE merge"Rémy Coutable2017-12-051-1/+1
|/ | | | Signed-off-by: Rémy Coutable <remy@rymai.me>
* Add basic docs for troubleshooting database problemsdocs/db-debuggingEric Eastwood2017-11-151-0/+1
|
* Add basic emoji development docsEric Eastwood2017-11-151-0/+1
|
* Rewrite the GitHub importer from scratchYorick Peterse2017-11-071-0/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Prior to this MR there were two GitHub related importers: * Github::Import: the main importer used for GitHub projects * Gitlab::GithubImport: importer that's somewhat confusingly used for importing Gitea projects (apparently they have a compatible API) This MR renames the Gitea importer to Gitlab::LegacyGithubImport and introduces a new GitHub importer in the Gitlab::GithubImport namespace. This new GitHub importer uses Sidekiq for importing multiple resources in parallel, though it also has the ability to import data sequentially should this be necessary. The new code is spread across the following directories: * lib/gitlab/github_import: this directory contains most of the importer code such as the classes used for importing resources. * app/workers/gitlab/github_import: this directory contains the Sidekiq workers, most of which simply use the code from the directory above. * app/workers/concerns/gitlab/github_import: this directory provides a few modules that are included in every GitHub importer worker. == Stages The import work is divided into separate stages, with each stage importing a specific set of data. Stages will schedule the work that needs to be performed, followed by scheduling a job for the "AdvanceStageWorker" worker. This worker will periodically check if all work is completed and schedule the next stage if this is the case. If work is not yet completed this worker will reschedule itself. Using this approach we don't have to block threads by calling `sleep()`, as doing so for large projects could block the thread from doing any work for many hours. == Retrying Work Workers will reschedule themselves whenever necessary. For example, hitting the GitHub API's rate limit will result in jobs rescheduling themselves. These jobs are not processed until the rate limit has been reset. == User Lookups Part of the importing process involves looking up user details in the GitHub API so we can map them to GitLab users. The old importer used an in-memory cache, but this obviously doesn't work when the work is spread across different threads. The new importer uses a Redis cache and makes sure we only perform API/database calls if absolutely necessary. Frequently used keys are refreshed, and lookup misses are also cached; removing the need for performing API/database calls if we know we don't have the data we're looking for. == Performance & Models The new importer in various places uses raw INSERT statements (as generated by `Gitlab::Database.bulk_insert`) instead of using Rails models. This allows us to bypass any validations and callbacks, drastically reducing the number of SQL queries and Gitaly RPC calls necessary to import projects. To ensure the code produces valid data the corresponding tests check if the produced rows are valid according to the model validation rules.
* Exclude comments from specific docsAchilleas Pipinellis2017-11-011-0/+4
|
* Fix a missing link and create a separate "Testing guides" sectiondocs/fix-dev-docRémy Coutable2017-10-111-1/+5
| | | | Signed-off-by: Rémy Coutable <remy@rymai.me>
* Refactor the Development documentation, and divide the Testing documentation ↵Rémy Coutable2017-10-111-50/+64
| | | | into multiple pages
* Move i18n/introduction to i18n/indexAchilleas Pipinellis2017-10-091-2/+2
|
* Merge branch 'master' into jramsay-4012-improve-internationization-docsAchilleas Pipinellis2017-10-091-0/+1
|\
| * Added some Gitaly docs to `docs/development`Andrew Newdigate2017-09-271-0/+1
| |
* | Docs: add translation and proof reading guidelinesJames Ramsay2017-10-051-1/+3
|/
* Add developer documentation about working with sent emails and previewsRobert Speicher2017-09-121-0/+1
|
* Document how to swap database tables.docs/document-swapping-tablesYorick Peterse2017-09-111-0/+1
|
* Document not using database hash indexesYorick Peterse2017-08-161-0/+1
|
* Document how to handle different DB (versions)Yorick Peterse2017-08-161-0/+1
|
* Add more database development related docsYorick Peterse2017-08-161-0/+2
|
* Added EachBatch for iterating tables in batchesactive-record-each-batchYorick Peterse2017-07-071-0/+1
| | | | | | | 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.
* Added code for defining SHA attributesYorick Peterse2017-06-291-0/+1
| | | | | | 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.
* Add the ability to perform background migrationsYorick Peterse2017-06-121-0/+1
| | | | | | | | 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.
* Document not using STIdocument-polymorphing-columnsYorick Peterse2017-06-071-0/+1
|
* Document not using polymorphic associationsYorick Peterse2017-06-071-0/+1
| | | | | Instead of using polymorphic associations a developer should use separate tables.
* Merge branch 'document-not-using-serialize' into 'master'Douwe Maan2017-06-011-0/+1
|\ | | | | | | | | Document not using ActiveRecord's serialize method See merge request !11821
| * Document not storing serialized dataYorick Peterse2017-05-311-0/+1
| |
* | Add feature toggles through FlipperAlejandro Rodríguez2017-05-311-0/+1
|/
* Add guide to collaborate with i18n.Rubén Dávila Santos2017-05-161-0/+4
|
* Add documentation about adding foreign keysYorick Peterse2017-05-081-0/+1
| | | | [ci skip]
* Add a manual job to trigger package build in omnibusBalasankar C2017-05-051-0/+1
|
* Remove outdated ci_setup.md doc page and document MySQL and RSpec profiling ↵30692-document-rspec-profile-and-mysql-branch-testing-and-remove-ci_setup-doc-pageRémy Coutable2017-04-251-1/+0
| | | | | | for specific branches Signed-off-by: Rémy Coutable <remy@rymai.me>
* Fix links and do some refactoringAchilleas Pipinellis2017-03-291-0/+2
|
* Creates Frontend Style guideFilipa Lacerda2017-03-221-1/+1
|
* Document "No gems fetched from git repositories" policy [ci skip]Adam Niedzielski2017-01-271-0/+1
|
* Link to object state models [ci skip]Victor Wu2016-11-171-0/+1
|
* Start to document how to code for CE with EE in mindRémy Coutable2016-11-171-0/+1
| | | | Signed-off-by: Rémy Coutable <remy@rymai.me>
* Fix link to index.md in development README.mdux-guide-indexAchilleas Pipinellis2016-11-121-1/+1
| | | | [ci skip]
* [ci skip] Establish basic structure for ux_guide README.mdux-guide-restructureawhildy2016-11-101-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Block out pages needed for ux_guide Add resources stub to ux_guide home Fill out principles and basics Add TOC to basics Move all of UI guide to new UX guide structure Add first level structure on ux-guide pages Add more details to buttons Add button images. Update link on development Renamed surfaces to templates. Add tooltip details Update typography and icons on Basics page Add images for color. First draft of voice and tone Delete findings page Refine pages. Fill out Surfaces pages Clean up layout on basics, surfaces, features. Add anchorlinks and counts to components Fill out components page Add item title and system info block Fill out Features page Switch tooltip placement image
* Merge branch 'rs-bin-changelog' into 'master' Rémy Coutable2016-11-021-0/+1
|\ | | | | | | | | Add a bin/changelog script and changelog documentation See merge request !7098
| * Add changelog documentationRobert Speicher2016-10-311-0/+1
| |
* | Support for post deployment migrationsbackground-migrationsYorick Peterse2016-10-311-0/+1
|/ | | | | | | | 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
* Merge branch 'improve-grape-dsl-rules' into 'master' Robert Speicher2016-10-251-0/+2
|\ | | | | | | | | | | | | | | | | Add an API styleguide This adds a styleguide for API development. Spinned-of from https://gitlab.com/gitlab-org/gitlab-ce/merge_requests/6860#note_16922017. [ci skip] See merge request !6864
| * Add an API styleguideRémy Coutable2016-10-131-0/+2
| | | | | | | | Signed-off-by: Rémy Coutable <remy@rymai.me>
* | Re-organize queues to use for Sidekiqseparate-sidekiq-queuesYorick Peterse2016-10-211-1/+2
|/ | | | | | | | | | | | | | | | | | | | | | | | | | | | 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
* Initial incomplete draft of the Frontend Development Guidelines.Connor Shea2016-09-211-0/+1
| | | | [ci skip]
* Added performance guidelines for new MRsmr-performance-guidesYorick Peterse2016-08-221-0/+2
| | | | | | | 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.
View Lorry Controller Status