diff options
Diffstat (limited to 'doc/development')
| -rw-r--r-- | doc/development/architecture.md | 2 | ||||
| -rw-r--r-- | doc/development/dangerbot.md | 2 | ||||
| -rw-r--r-- | doc/development/elasticsearch.md | 4 | ||||
| -rw-r--r-- | doc/development/experiment_guide/index.md | 4 | ||||
| -rw-r--r-- | doc/development/file_storage.md | 4 | ||||
| -rw-r--r-- | doc/development/import_project.md | 2 | ||||
| -rw-r--r-- | doc/development/rake_tasks.md | 8 |
7 files changed, 14 insertions, 12 deletions
diff --git a/doc/development/architecture.md b/doc/development/architecture.md index c36b03e9769..f1801320ae0 100644 --- a/doc/development/architecture.md +++ b/doc/development/architecture.md @@ -725,7 +725,7 @@ GitLab Shell has a configuration file at `/home/git/gitlab-shell/config.yml`. ### Maintenance Tasks -[GitLab](https://gitlab.com/gitlab-org/gitlab/tree/master) provides rake tasks with which you see version information and run a quick check on your configuration to ensure it is configured properly within the application. See [maintenance rake tasks](https://gitlab.com/gitlab-org/gitlab/blob/master/doc/raketasks/maintenance.md). +[GitLab](https://gitlab.com/gitlab-org/gitlab/tree/master) provides Rake tasks with which you see version information and run a quick check on your configuration to ensure it is configured properly within the application. See [maintenance Rake tasks](../raketasks/maintenance.md). In a nutshell, do the following: ```shell diff --git a/doc/development/dangerbot.md b/doc/development/dangerbot.md index 2e4451949aa..e090281f2bf 100644 --- a/doc/development/dangerbot.md +++ b/doc/development/dangerbot.md @@ -31,7 +31,7 @@ from the start of the merge request. ## Run Danger locally -A subset of the current checks can be run locally with the following rake task: +A subset of the current checks can be run locally with the following Rake task: ```shell bin/rake danger_local diff --git a/doc/development/elasticsearch.md b/doc/development/elasticsearch.md index 20f9fb95440..26d14d8830c 100644 --- a/doc/development/elasticsearch.md +++ b/doc/development/elasticsearch.md @@ -25,7 +25,7 @@ Developers making significant changes to Elasticsearch queries should test their See the [Elasticsearch GDK setup instructions](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/master/doc/howto/elasticsearch.md) -## Helpful rake tasks +## Helpful Rake tasks - `gitlab:elastic:test:index_size`: Tells you how much space the current index is using, as well as how many documents are in the index. - `gitlab:elastic:test:index_size_change`: Outputs index size, reindexes, and outputs index size again. Useful when testing improvements to indexing size. @@ -34,7 +34,7 @@ Additionally, if you need large repos or multiple forks for testing, please cons ## How does it work? -The Elasticsearch integration depends on an external indexer. We ship an [indexer written in Go](https://gitlab.com/gitlab-org/gitlab-elasticsearch-indexer). The user must trigger the initial indexing via a rake task but, after this is done, GitLab itself will trigger reindexing when required via `after_` callbacks on create, update, and destroy that are inherited from [/ee/app/models/concerns/elastic/application_versioned_search.rb](https://gitlab.com/gitlab-org/gitlab/blob/master/ee/app/models/concerns/elastic/application_versioned_search.rb). +The Elasticsearch integration depends on an external indexer. We ship an [indexer written in Go](https://gitlab.com/gitlab-org/gitlab-elasticsearch-indexer). The user must trigger the initial indexing via a Rake task but, after this is done, GitLab itself will trigger reindexing when required via `after_` callbacks on create, update, and destroy that are inherited from [/ee/app/models/concerns/elastic/application_versioned_search.rb](https://gitlab.com/gitlab-org/gitlab/blob/master/ee/app/models/concerns/elastic/application_versioned_search.rb). After initial indexing is complete, create, update, and delete operations for all models except projects (see [#207494](https://gitlab.com/gitlab-org/gitlab/issues/207494)) are tracked in a Redis [`ZSET`](https://redis.io/topics/data-types#sorted-sets). A regular `sidekiq-cron` `ElasticIndexBulkCronWorker` processes this queue, updating many Elasticsearch documents at a time with the [Bulk Request API](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html). diff --git a/doc/development/experiment_guide/index.md b/doc/development/experiment_guide/index.md index edfde53f5ec..ffa95d86876 100644 --- a/doc/development/experiment_guide/index.md +++ b/doc/development/experiment_guide/index.md @@ -56,7 +56,9 @@ The author then adds a comment to this piece of code and adds a link to the issu ``` - Track necessary events. See the [telemetry guide](../../telemetry/index.md) for details. -- After the merge request is merged, use [`chatops`](../../ci/chatops/README.md) to enable the feature flag and start the experiment. For visibility, please run the command in the `#s_growth` channel: +- After the merge request is merged, use [`chatops`](../../ci/chatops/README.md) in the +[appropriate channel](../feature_flags/controls.md#where-to-run-commands) to enable the feature flag and start the experiment. +For visibility, please also share any commands run against production in the `#s_growth` channel: ```shell /chatops run feature set --project=gitlab-org/gitlab experimental_sign_up_flow true diff --git a/doc/development/file_storage.md b/doc/development/file_storage.md index adfb92acc54..e16fe7eba5b 100644 --- a/doc/development/file_storage.md +++ b/doc/development/file_storage.md @@ -50,9 +50,9 @@ In the case of Issues/MR/Notes Markdown attachments, there is a different approa instead of basing the path into a mutable variable `:project_path_with_namespace`, it's possible to use the hash of the project ID instead, if project migrates to the new approach (introduced in 10.2). -> Note: We provide an [all-in-one rake task] to migrate all uploads to object +> Note: We provide an [all-in-one Rake task] to migrate all uploads to object > storage in one go. If a new Uploader class or model type is introduced, make -> sure you add a rake task invocation corresponding to it to the [category +> sure you add a Rake task invocation corresponding to it to the [category > list]. ### Path segments diff --git a/doc/development/import_project.md b/doc/development/import_project.md index 7bfcbaf07f8..0701279ddea 100644 --- a/doc/development/import_project.md +++ b/doc/development/import_project.md @@ -45,7 +45,7 @@ There is also an option to [import the project via GitHub](../user/project/impor This method will take longer to import than the other methods and will depend on several factors. It's recommended to use the other methods. -### Importing via a rake task +### Importing via a Rake task [`import.rake`](https://gitlab.com/gitlab-org/gitlab/blob/master/lib/tasks/gitlab/import_export/import.rake) was introduced for importing large GitLab project exports. diff --git a/doc/development/rake_tasks.md b/doc/development/rake_tasks.md index 83dd5027a02..3bc638ca6f2 100644 --- a/doc/development/rake_tasks.md +++ b/doc/development/rake_tasks.md @@ -129,11 +129,11 @@ To run several tests inside one directory: - `bin/rspec spec/requests/api/` for the rspec tests if you want to test API only -### Speed-up tests, rake tasks, and migrations +### Speed-up tests, Rake tasks, and migrations [Spring](https://github.com/rails/spring) is a Rails application preloader. It speeds up development by keeping your application running in the background so -you don't need to boot it every time you run a test, rake task or migration. +you don't need to boot it every time you run a test, Rake task or migration. If you want to use it, you'll need to export the `ENABLE_SPRING` environment variable to `1`: @@ -247,7 +247,7 @@ To generate GraphQL documentation based on the GitLab schema, run: bundle exec rake gitlab:graphql:compile_docs ``` -In its current state, the rake task: +In its current state, the Rake task: - Generates output for GraphQL objects. - Places the output at `doc/api/graphql/reference/index.md`. @@ -270,4 +270,4 @@ To generate GraphQL schema files based on the GitLab schema, run: bundle exec rake gitlab:graphql:schema:dump ``` -This uses graphql-ruby's built-in rake tasks to generate files in both [IDL](https://www.prisma.io/blog/graphql-sdl-schema-definition-language-6755bcb9ce51) and JSON formats. +This uses graphql-ruby's built-in Rake tasks to generate files in both [IDL](https://www.prisma.io/blog/graphql-sdl-schema-definition-language-6755bcb9ce51) and JSON formats. |