diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-03-13 21:08:56 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-03-13 21:08:56 +0300 |
commit | 7b7bc31c5ba07eebe62e2f2582f111ce24285cd4 (patch) | |
tree | 70c795a932a603e49176d30ee5f0835fcfed46c2 /doc/development | |
parent | cb38c5062c623059d311c4e9e37428eacdea95d6 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/development')
-rw-r--r-- | doc/development/advanced_search.md | 10 | ||||
-rw-r--r-- | doc/development/contributing/index.md | 8 | ||||
-rw-r--r-- | doc/development/contributing/merge_request_workflow.md | 11 | ||||
-rw-r--r-- | doc/development/fe_guide/vuex.md | 9 |
4 files changed, 22 insertions, 16 deletions
diff --git a/doc/development/advanced_search.md b/doc/development/advanced_search.md index 4e61098b17d..4c779088d01 100644 --- a/doc/development/advanced_search.md +++ b/doc/development/advanced_search.md @@ -42,6 +42,16 @@ After initial indexing is complete, create, update, and delete operations for al Search queries are generated by the concerns found in [`ee/app/models/concerns/elastic`](https://gitlab.com/gitlab-org/gitlab/-/tree/master/ee/app/models/concerns/elastic). These concerns are also in charge of access control, and have been a historic source of security bugs so please pay close attention to them! +### Custom routing + +[Custom routing](https://www.elastic.co/guide/en/elasticsearch/reference/current/mapping-routing-field.html#_searching_with_custom_routing) +is used in Elasticsearch for document types that are associated with a project. The routing format is `project_<project_id>`. Routing is set +during indexing and searching operations. Some of the benefits and tradeoffs to using custom routing are: + +- Project scoped searches are much faster. +- Routing is not used if too many shards would be hit for global and group scoped searches. +- Shard size imbalance might occur. + ## Existing Analyzers/Tokenizers/Filters These are all defined in [`ee/lib/elastic/latest/config.rb`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/ee/lib/elastic/latest/config.rb) diff --git a/doc/development/contributing/index.md b/doc/development/contributing/index.md index cf10a106119..6a9dd34e703 100644 --- a/doc/development/contributing/index.md +++ b/doc/development/contributing/index.md @@ -49,11 +49,11 @@ If you would like to contribute to GitLab: The general flow of contributing to GitLab is: -1. [Create a fork](../../user/project/repository/forking_workflow.md#creating-a-fork) - of GitLab. In some cases, you will want to set up the +1. [Read about](https://gitlab.com/gitlab-community/meta) and [request access](https://gitlab.com/gitlab-community/meta#request-access-to-community-forks) + to the GitLab Community forks. In some cases, you will want to set up the [GitLab Development Kit](https://gitlab.com/gitlab-org/gitlab-development-kit) to - [develop against your fork](https://gitlab.com/gitlab-org/gitlab-development-kit/-/blob/main/doc/index.md#develop-in-your-own-gitlab-fork). -1. Make your changes in your fork. + [develop against the GitLab community fork](https://gitlab.com/gitlab-org/gitlab-development-kit/-/blob/main/doc/index.md#develop-in-your-own-gitlab-fork). +1. Create a feature branch and make changes in the [GitLab community fork](https://gitlab.com/gitlab-community/gitlab). 1. When you're ready, [create a new merge request](../../user/project/merge_requests/creating_merge_requests.md). 1. In the merge request's description: - Ensure you provide complete and accurate information. diff --git a/doc/development/contributing/merge_request_workflow.md b/doc/development/contributing/merge_request_workflow.md index c9866131cc7..e384b41f6f2 100644 --- a/doc/development/contributing/merge_request_workflow.md +++ b/doc/development/contributing/merge_request_workflow.md @@ -80,12 +80,15 @@ intent behind your changes can also help expedite merge request reviews. To create a merge request: -1. [Fork](../../user/project/repository/forking_workflow.md) the project into - your personal namespace (or group) on GitLab.com. -1. Create a feature branch in your fork (don't work off your [default branch](../../user/project/repository/branches/default.md)). +1. [Read about](https://gitlab.com/gitlab-community/meta) and [request access](https://gitlab.com/gitlab-community/meta#request-access-to-community-forks) + to the GitLab Community forks. In some cases, you will want to set up the + [GitLab Development Kit](https://gitlab.com/gitlab-org/gitlab-development-kit) to + [develop against the GitLab community fork](https://gitlab.com/gitlab-org/gitlab-development-kit/-/blob/main/doc/index.md#develop-in-your-own-gitlab-fork). +1. Create a feature branch in the [GitLab community fork](https://gitlab.com/gitlab-community/gitlab) + (don't work off the [default branch](../../user/project/repository/branches/default.md)). 1. Follow the [commit messages guidelines](#commit-messages-guidelines). 1. If you have multiple commits, combine them into a few logically organized commits. -1. Push the commits to your working branch in your fork. +1. Push the commits to your working branch in the fork. 1. Submit a merge request (MR) against the default branch of the upstream project. 1. The MR title should describe the change you want to make. 1. The MR description should give a reason for your change. diff --git a/doc/development/fe_guide/vuex.md b/doc/development/fe_guide/vuex.md index 95204a6e91c..6d882358e8d 100644 --- a/doc/development/fe_guide/vuex.md +++ b/doc/development/fe_guide/vuex.md @@ -6,14 +6,7 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Vuex -When there's a clear benefit to separating state management from components (for example, due to state complexity) we recommend using [Vuex](https://vuex.vuejs.org) over any other Flux pattern. Otherwise, feel free to manage state in the components. - -Vuex should be strongly considered when: - -- You expect multiple parts of the application to react to state changes. -- There's a need to share data between multiple components. -- There are complex interactions with Backend, for example, multiple API calls. -- The app involves interacting with backend via both traditional REST API and GraphQL (especially when moving the REST API over to GraphQL is a pending backend task). +[Vuex](https://vuex.vuejs.org) should no longer be considered a preferred path to store management and is currently in its legacy phase. This means it is acceptable to add upon existing `Vuex` stores, but we strongly recommend reducing store sizes over time and eventually migrating fully to [Apollo](https://www.apollographql.com/) whenever it's possible. Before adding any new `Vuex` store to an application, first ensure that the `Vue` application you plan to add it into **does not use** `Apollo`. `Vuex` and `Apollo` should not be combined unless absolutely necessary. Please consider reading through [our GraphQL documentation](../fe_guide/graphql.md) for more guidelines on how you can build `Apollo` based applications. The information included in this page is explained in more detail in the official [Vuex documentation](https://vuex.vuejs.org). |