diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-06-16 06:10:28 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-06-16 06:10:28 +0300 |
commit | e5aec0ddbc6e3122f5e2425e92b30c4cd2184c90 (patch) | |
tree | 625a0e8675629b08d90041db70d4f833e31f2eec /doc | |
parent | e7da7e417c5f09cb673b1c9aca085b53b38bbe68 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
37 files changed, 154 insertions, 145 deletions
diff --git a/doc/architecture/blueprints/code_search_with_zoekt/index.md b/doc/architecture/blueprints/code_search_with_zoekt/index.md index db608b763b8..681782609ba 100644 --- a/doc/architecture/blueprints/code_search_with_zoekt/index.md +++ b/doc/architecture/blueprints/code_search_with_zoekt/index.md @@ -111,34 +111,30 @@ Elasticsearch option if we find Zoekt is a suitable long term option. ### Indexing Similar to our Elasticsearch integration, GitLab will notify Zoekt every time -there are updates to a repository. Zoekt, unlike Elasticsearch, is designed to -clone and index Git repositories so we will simply notify Zoekt of the URL of -the repository that has changed and it will update its local copy of the Git -repo and then update its local index files. The Zoekt side of this logic will -be implemented in a new server-side indexing endpoint we add to Zoekt which is -currently in -[an open Pull request](https://github.com/sourcegraph/zoekt/pull/496). -While the details of -this pull request are still being debated, we may choose to deploy a fork with -the functionality we need, but our strongest intention is not to maintain a -fork of Zoekt and the maintainers have already expressed they are open to this -new functionality. +there are updates to a repository. We've introduced a new indexer called +[`gitlab-zoekt-indexer`](https://gitlab.com/gitlab-org/gitlab-zoekt-indexer) and +we are going to replace the legacy indexer that needs to clone repositories with it. +The new indexer expects a payload with all required information to connect to +Gitaly in order to index the repository. The rails side of the integration will be a Sidekiq worker that is scheduled every time there is an update to a repository and it will simply call this -`/index` endpoint in Zoekt. This will also need to generate a one-time token -that can allow Zoekt to clone a private repository. +`/indexer/index` endpoint in Zoekt. This will also need to send a Gitaly token +that can allow Zoekt to connect to Gitaly. + +We're going to encrypt the connection with SSL and add basic auth in [Add authentication for GitLab -> Zoekt HTTP calls](https://gitlab.com/gitlab-org/gitlab/-/issues/389749) +before enabling the new indexer since it receives Gitaly secrets from GitLab. ```mermaid sequenceDiagram participant user as User - participant gitlab_git as GitLab Git + participant gitaly as Gitaly participant gitlab_sidekiq as GitLab Sidekiq participant zoekt as Zoekt user->>gitlab_git: git push git@gitlab.com:gitlab-org/gitlab.git gitlab_git->>gitlab_sidekiq: ZoektIndexerWorker.perform_async(278964) - gitlab_sidekiq->>zoekt: POST /index {"RepoUrl":"https://zoekt:SECRET_TOKEN@gitlab.com/gitlab-org/gitlab.git","RepoId":278964}' - zoekt->>gitlab_git: git clone https://zoekt:SECRET_TOKEN@gitlab.com/gitlab-org/gitlab.git + gitlab_sidekiq->>zoekt: POST /indexer/index {"GitalyConnectionInfo": {"Address": "tcp://gitaly:2305", "Storage": "default", "Token": "secret_token", "Path": "@hashed/a/b/c.git"}, "RepoId":7} + zoekt->>gitaly: go gitaly client ``` The Sidekiq worker can leverage de-duplication based on the `project_id`. @@ -169,19 +165,15 @@ matches all the searched repositories. ### Zoekt infrastructure Each Zoekt node will need to run a -[zoekt-dynamic-indexserver](https://github.com/sourcegraph/zoekt/pull/496) and -a -[zoekt-webserver](https://github.com/sourcegraph/zoekt/blob/main/cmd/zoekt-webserver/main.go). -These are both webservers with different responsibilities. Considering that the -Zoekt indexing process needs to keep a full clone of the bare repo -([unless we come up with a better option](https://gitlab.com/gitlab-org/gitlab/-/issues/384722)) -these bare repos will be stored on spinning disks to save space. These are only -used as an intermediate step to generate the actual `.zoekt` index files which -will be stored on an SSD for fast searches. These web servers need to run on -the same node as they access the same files. The `zoekt-dynamic-indexserver` is -responsible for writing the `.zoekt` index files. The `zoekt-webserver` is -responsible for responding to searches that it performs by reading these -`.zoekt` index files. +[`gitlab-zoekt-indexer`](https://gitlab.com/gitlab-org/gitlab-zoekt-indexer/-/blob/main/cmd/gitlab-zoekt-indexer/main.go) +and a +[`zoekt-webserver`](https://github.com/sourcegraph/zoekt/blob/main/cmd/zoekt-webserver/main.go). +These are both webservers with different responsibilities. +The actual `.zoekt` index files will be stored on an SSD for fast searches. +These web servers need to run on the same node as they access the same files. +The `gitlab-zoekt-indexer` is responsible for writing the `.zoekt` index files. +The `zoekt-webserver` is responsible for responding to searches that it performs +by reading these `.zoekt` index files. ### Rollout strategy diff --git a/doc/user/project/clusters/add_eks_clusters.md b/doc/user/project/clusters/add_eks_clusters.md index 4636d3c49f8..87554e786ab 100644 --- a/doc/user/project/clusters/add_eks_clusters.md +++ b/doc/user/project/clusters/add_eks_clusters.md @@ -248,7 +248,10 @@ For example, the following policy document allows assuming a role whose name sta To configure Amazon authentication in GitLab, generate an access key for the IAM user in the Amazon AWS console, and follow these steps: -1. In GitLab, on the top bar, select **Main menu > Admin > Settings > General** and expand the **Amazon EKS** section. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > General**. +1. Expand **Amazon EKS**. 1. Check **Enable Amazon EKS integration**. 1. Enter your **Account ID**. 1. Enter your [access key and ID](#eks-access-key-and-id). diff --git a/doc/user/project/clusters/index.md b/doc/user/project/clusters/index.md index 5ce1994ba36..ab6084acd5e 100644 --- a/doc/user/project/clusters/index.md +++ b/doc/user/project/clusters/index.md @@ -24,5 +24,5 @@ to a single project. To view project-level Kubernetes clusters: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Infrastructure > Kubernetes clusters**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Operate > Kubernetes clusters**. diff --git a/doc/user/project/codeowners/index.md b/doc/user/project/codeowners/index.md index e69dba6f977..272d59bd6a4 100644 --- a/doc/user/project/codeowners/index.md +++ b/doc/user/project/codeowners/index.md @@ -48,8 +48,8 @@ For example: To view the Code Owners of a file or directory: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Repository > Files**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Code > Repository**. 1. Go to the file or directory you want to see the Code Owners for. 1. Optional. Select a branch or tag. diff --git a/doc/user/project/deploy_tokens/index.md b/doc/user/project/deploy_tokens/index.md index a81ccd043bd..0b9c42f2a60 100644 --- a/doc/user/project/deploy_tokens/index.md +++ b/doc/user/project/deploy_tokens/index.md @@ -92,10 +92,8 @@ Prerequisites: - You must have at least the Maintainer role for the project or group. -1. On the top bar, select **Main menu**, and: - - For a project deploy token, select **Projects** and find your project. - - For a group deploy token, select **Groups** and find your group. -1. On the left sidebar, select **Settings > Repository**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project or group. +1. Select **Settings > Repository**. 1. Expand **Deploy tokens**. 1. Complete the fields, and select the desired [scopes](#scope). 1. Select **Create deploy token**. @@ -113,10 +111,8 @@ Prerequisites: To revoke a deploy token: -1. On the top bar, select **Main menu**, and: - - For a project deploy token, select **Projects** and find your project. - - For a group deploy token, select **Groups** and find your group. -1. On the left sidebar, select **Settings > Repository**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project or group. +1. Select **Settings > Repository**. 1. Expand **Deploy tokens**. 1. In the **Active Deploy Tokens** section, by the token you want to revoke, select **Revoke**. diff --git a/doc/user/project/insights/index.md b/doc/user/project/insights/index.md index 2874bf98736..5ca6fcebdd6 100644 --- a/doc/user/project/insights/index.md +++ b/doc/user/project/insights/index.md @@ -24,8 +24,8 @@ Prerequisites: To view project insights: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Analytics > Insights**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Analyze > Insights**. 1. To view a report, select the **Select report** dropdown list. ## Configure project insights @@ -45,7 +45,7 @@ To configure project insights, either: - Create a `.gitlab/insights.yml` file locally in the root directory of your project, and push your changes. - Create a `.gitlab/insights.yml` file in the UI: - 1. On the top bar, select **Main menu > Projects** and find your project. + 1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. 1. Above the file list, select the branch you want to commit to, select the plus icon, then select **New file**. 1. In the **File name** text box, enter `.gitlab/insights.yml`. 1. In the large text box, update the file contents. diff --git a/doc/user/project/integrations/apple_app_store.md b/doc/user/project/integrations/apple_app_store.md index 3fe709668af..405531abd0d 100644 --- a/doc/user/project/integrations/apple_app_store.md +++ b/doc/user/project/integrations/apple_app_store.md @@ -29,9 +29,9 @@ An Apple ID enrolled in the [Apple Developer Program](https://developer.apple.co GitLab supports enabling the Apple App Store integration at the project level. Complete these steps in GitLab: 1. In the Apple App Store Connect portal, generate a new private key for your project by following [these instructions](https://developer.apple.com/documentation/appstoreconnectapi/creating_api_keys_for_app_store_connect_api). -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Integrations**. -1. Select **Apple App Store**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Integrations**. +1. Select **Apple App Store Connect**. 1. Turn on the **Active** toggle under **Enable Integration**. 1. Provide the Apple App Store Connect configuration information: - **Issuer ID**: The Apple App Store Connect issuer ID. diff --git a/doc/user/project/integrations/asana.md b/doc/user/project/integrations/asana.md index 352f6cdc2bb..edd08f1e3d3 100644 --- a/doc/user/project/integrations/asana.md +++ b/doc/user/project/integrations/asana.md @@ -32,8 +32,8 @@ In Asana, create a Personal Access Token. Complete these steps in GitLab: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Integrations**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Integrations**. 1. Select **Asana**. 1. Ensure that the **Active** toggle is enabled. 1. Paste the token you generated in Asana. diff --git a/doc/user/project/integrations/bamboo.md b/doc/user/project/integrations/bamboo.md index 05bdd039f12..8394687d8f5 100644 --- a/doc/user/project/integrations/bamboo.md +++ b/doc/user/project/integrations/bamboo.md @@ -36,8 +36,8 @@ integration in GitLab. ## Configure GitLab -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Integrations**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Integrations**. 1. Select **Atlassian Bamboo**. 1. Ensure the **Active** checkbox is selected. 1. Enter the base URL of your Bamboo server. For example, `https://bamboo.example.com`. diff --git a/doc/user/project/integrations/bugzilla.md b/doc/user/project/integrations/bugzilla.md index cb6abaa4c7b..1796e674b00 100644 --- a/doc/user/project/integrations/bugzilla.md +++ b/doc/user/project/integrations/bugzilla.md @@ -14,8 +14,8 @@ You can configure Bugzilla as an To enable the Bugzilla integration in a project: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Integrations**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Integrations**. 1. Select **Bugzilla**. 1. Select the checkbox under **Enable integration**. 1. Fill in the required fields: diff --git a/doc/user/project/integrations/clickup.md b/doc/user/project/integrations/clickup.md index 4353749dd33..bf2c738049c 100644 --- a/doc/user/project/integrations/clickup.md +++ b/doc/user/project/integrations/clickup.md @@ -11,8 +11,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w You can use [ClickUp](https://clickup.com/) as an external issue tracker. To enable the ClickUp integration in a project: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Integrations**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Integrations**. 1. Select **ClickUp**. 1. Select the checkbox under **Enable integration**. 1. Fill in the required fields: diff --git a/doc/user/project/integrations/custom_issue_tracker.md b/doc/user/project/integrations/custom_issue_tracker.md index b529d728e3b..9580c924fd1 100644 --- a/doc/user/project/integrations/custom_issue_tracker.md +++ b/doc/user/project/integrations/custom_issue_tracker.md @@ -20,8 +20,8 @@ on the left sidebar in your project. To enable a custom issue tracker in a project: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Integrations**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Integrations**. 1. Select **Custom issue tracker**. 1. Select the checkbox under **Enable integration**. 1. Fill in the required fields: diff --git a/doc/user/project/integrations/discord_notifications.md b/doc/user/project/integrations/discord_notifications.md index 60b37f07bb5..180e39e3254 100644 --- a/doc/user/project/integrations/discord_notifications.md +++ b/doc/user/project/integrations/discord_notifications.md @@ -26,8 +26,8 @@ and configure it in GitLab. With the webhook URL created in the Discord channel, you can set up the Discord Notifications integration in GitLab. -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Integrations**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Integrations**. 1. Select **Discord Notifications**. 1. Ensure that the **Active** toggle is enabled. 1. Check the checkboxes corresponding to the GitLab events for which you want to send notifications to Discord. diff --git a/doc/user/project/integrations/emails_on_push.md b/doc/user/project/integrations/emails_on_push.md index 7f8755f1114..eb3eecaa656 100644 --- a/doc/user/project/integrations/emails_on_push.md +++ b/doc/user/project/integrations/emails_on_push.md @@ -11,8 +11,8 @@ that is pushed to your project. To enable emails on push: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Integrations**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Integrations**. 1. Select **Emails on push**. 1. In the **Recipients** section, provide a list of emails separated by spaces or newlines. 1. Configure the following options: diff --git a/doc/user/project/integrations/ewm.md b/doc/user/project/integrations/ewm.md index 7f87e9fc81f..d96558579d1 100644 --- a/doc/user/project/integrations/ewm.md +++ b/doc/user/project/integrations/ewm.md @@ -14,8 +14,8 @@ This IBM product was [formerly named Rational Team Concert (RTC)](https://jazz.n To enable the EWM integration, in a project: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Integrations**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Integrations**. 1. Select **EWM**. 1. Select the checkbox under **Enable integration**. 1. Fill in the required fields: diff --git a/doc/user/project/integrations/github.md b/doc/user/project/integrations/github.md index 3e75106a9bc..98654a3b59f 100644 --- a/doc/user/project/integrations/github.md +++ b/doc/user/project/integrations/github.md @@ -29,8 +29,8 @@ Complete these steps on GitHub: Complete these steps in GitLab: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Integrations**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Integrations**. 1. Select **GitHub**. 1. Ensure the **Active** checkbox is selected. 1. In **Token**, paste the token you generated on GitHub. diff --git a/doc/user/project/integrations/gitlab_slack_application.md b/doc/user/project/integrations/gitlab_slack_application.md index fabdf07f76f..8790c7213e5 100644 --- a/doc/user/project/integrations/gitlab_slack_application.md +++ b/doc/user/project/integrations/gitlab_slack_application.md @@ -107,8 +107,9 @@ With Slack notifications, GitLab can send messages to Slack workspace channels f To configure Slack notifications: -1. On the top bar, select **Main menu > Projects** and find a project for which the GitLab for Slack app has been [installed](#installation). -1. On the left sidebar, select **Settings > Integrations**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find a project for + which the GitLab for Slack app has been [installed](#installation). +1. Select **Settings > Integrations**. 1. Select **GitLab for Slack app**. 1. In the **Trigger** section, select the checkbox for each GitLab event you want to receive a notification for in Slack. For a full list, see @@ -162,8 +163,9 @@ New releases of the app might require permissions to be authorized before some f To update your GitLab for Slack app: -1. On the top bar, select **Main menu > Projects** and find a project for which the GitLab for Slack app has been configured. -1. On the left sidebar, select **Settings > Integrations**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find a project for + which the GitLab for Slack app has been configured. +1. Select **Settings > Integrations**. 1. Select **GitLab for Slack app**. 1. Select **Reinstall GitLab for Slack app**. diff --git a/doc/user/project/integrations/google_play.md b/doc/user/project/integrations/google_play.md index 2ae5a504e06..4b0f4fe205a 100644 --- a/doc/user/project/integrations/google_play.md +++ b/doc/user/project/integrations/google_play.md @@ -29,8 +29,8 @@ Prerequisites: To enable the Google Play integration in GitLab: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Integrations**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Integrations**. 1. Select **Google Play**. 1. In **Enable integration**, select the **Active** checkbox. 1. In **Package name**, enter the package name of the app (for example, `com.gitlab.app_name`). diff --git a/doc/user/project/integrations/harbor.md b/doc/user/project/integrations/harbor.md index 4a586054aee..12986cba555 100644 --- a/doc/user/project/integrations/harbor.md +++ b/doc/user/project/integrations/harbor.md @@ -25,8 +25,8 @@ In the Harbor instance, ensure that: GitLab supports integrating Harbor projects at the group or project level. Complete these steps in GitLab: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Integrations**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Integrations**. 1. Select **Harbor**. 1. Turn on the **Active** toggle under **Enable Integration**. 1. Provide the Harbor configuration information: diff --git a/doc/user/project/integrations/index.md b/doc/user/project/integrations/index.md index abc274d814d..c70a58a24d2 100644 --- a/doc/user/project/integrations/index.md +++ b/doc/user/project/integrations/index.md @@ -18,8 +18,8 @@ Prerequisites: To view the available integrations for your project: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Integrations**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Integrations**. You can also view and manage integration settings across [all projects in an instance or group](../../admin_area/settings/project_integration_management.md). For a single project, you can choose to inherit the instance or group configuration, diff --git a/doc/user/project/integrations/irker.md b/doc/user/project/integrations/irker.md index c77fffaa1ba..7d3c85b2c62 100644 --- a/doc/user/project/integrations/irker.md +++ b/doc/user/project/integrations/irker.md @@ -39,8 +39,8 @@ network. For more details, read ## Complete these steps in GitLab -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Integrations**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Integrations**. 1. Select **irker (IRC gateway)**. 1. Ensure that the **Active** toggle is enabled. 1. Optional. Under **Server host**, enter the server host address where `irkerd` runs. If empty, diff --git a/doc/user/project/integrations/mattermost.md b/doc/user/project/integrations/mattermost.md index a50d341c38e..a73c0f001f3 100644 --- a/doc/user/project/integrations/mattermost.md +++ b/doc/user/project/integrations/mattermost.md @@ -41,8 +41,8 @@ Display name override is not enabled by default, you need to ask your administra After the Mattermost instance has an incoming webhook set up, you can set up GitLab to send the notifications: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Integrations**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Integrations**. 1. Select **Mattermost notifications**. 1. Select the GitLab events to generate notifications for. For each event you select, input the Mattermost channel to receive the notification. You do not need to add the hash sign (`#`). diff --git a/doc/user/project/integrations/mattermost_slash_commands.md b/doc/user/project/integrations/mattermost_slash_commands.md index 4de334a0535..a8d8323a651 100644 --- a/doc/user/project/integrations/mattermost_slash_commands.md +++ b/doc/user/project/integrations/mattermost_slash_commands.md @@ -29,9 +29,9 @@ you must have Mattermost [3.4 or later](https://mattermost.com/blog/category/pla If Mattermost is installed on the same server as GitLab, you can automatically configure Mattermost slash commands: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Integrations**. -1. In **Add an integration**, select **Mattermost slash commands**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Integrations**. +1. Select **Mattermost slash commands**. 1. In **Enable integration**, ensure the **Active** checkbox is selected. 1. Select **Add to Mattermost**, and select **Save changes**. @@ -65,8 +65,9 @@ To get configuration values from GitLab: 1. In a different browser tab, sign in to GitLab as a user with administrator access. -1. On the top bar, select **Main menu > Admin**. -1. On the left sidebar, select **Settings > Integrations**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Admin Area**. +1. Select **Settings > Integrations**. 1. Select **Mattermost slash commands**. GitLab displays potential values for Mattermost settings. 1. Copy the **Request URL** value. All other values are suggestions. 1. Do not close this browser tab. You need it in a later step. diff --git a/doc/user/project/integrations/microsoft_teams.md b/doc/user/project/integrations/microsoft_teams.md index 5d2c27fc2a4..3d0b77069a3 100644 --- a/doc/user/project/integrations/microsoft_teams.md +++ b/doc/user/project/integrations/microsoft_teams.md @@ -35,8 +35,8 @@ After you configure Microsoft Teams to receive notifications, you must configure GitLab to send the notifications: 1. Sign in to GitLab as an administrator. -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Integrations**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Integrations**. 1. Select **Microsoft Teams notifications**. 1. To enable the integration, select **Active**. 1. In the **Trigger** section, select the checkbox next to each event to enable it: diff --git a/doc/user/project/integrations/mlflow_client.md b/doc/user/project/integrations/mlflow_client.md index 6059de8b742..cffa2649cc8 100644 --- a/doc/user/project/integrations/mlflow_client.md +++ b/doc/user/project/integrations/mlflow_client.md @@ -23,7 +23,9 @@ GitLab plays the role of a MLflow server. Running `mlflow server` is not necessa Prerequisites: - A [personal access token](../../../user/profile/personal_access_tokens.md) for the project, with minimum access level of `api`. -- The project ID. To find the project ID, on the top bar, select **Main menu > Projects** and find your project. On the left sidebar, select **Settings > General**. +- The project ID. To find the project ID: + 1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. + 1. Select **Settings > General**. To enable MLflow client integration: diff --git a/doc/user/project/integrations/pivotal_tracker.md b/doc/user/project/integrations/pivotal_tracker.md index c2392061b8f..7f53f08e808 100644 --- a/doc/user/project/integrations/pivotal_tracker.md +++ b/doc/user/project/integrations/pivotal_tracker.md @@ -37,8 +37,8 @@ In Pivotal Tracker, [create an API token](https://www.pivotaltracker.com/help/ar Complete these steps in GitLab: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Integrations**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Integrations**. 1. Select **Pivotal Tracker**. 1. Ensure that the **Active** toggle is enabled. 1. Paste the token you generated in Pivotal Tracker. diff --git a/doc/user/project/integrations/pumble.md b/doc/user/project/integrations/pumble.md index 5199d1a9935..62703ebfad9 100644 --- a/doc/user/project/integrations/pumble.md +++ b/doc/user/project/integrations/pumble.md @@ -26,7 +26,8 @@ notifications: 1. To enable the integration for your group or project: 1. In your group or project, on the left sidebar, select **Settings > Integrations**. 1. To enable the integration for your instance: - 1. On the top bar, select **Main menu > Admin**. + 1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). + 1. Select **Admin Area**. 1. On the left sidebar, select **Settings > Integrations**. 1. Select the **Pumble** integration. 1. Ensure that the **Active** toggle is enabled. diff --git a/doc/user/project/integrations/redmine.md b/doc/user/project/integrations/redmine.md index 5ef30cf413d..9cb93c2d082 100644 --- a/doc/user/project/integrations/redmine.md +++ b/doc/user/project/integrations/redmine.md @@ -9,8 +9,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w You can use [Redmine](https://www.redmine.org/) as an external issue tracker. To enable the Redmine integration in a project: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Integrations**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Integrations**. 1. Select **Redmine**. 1. Select the checkbox under **Enable integration**. 1. Fill in the required fields: diff --git a/doc/user/project/integrations/shimo.md b/doc/user/project/integrations/shimo.md index cf9745929a1..6fbd246d7f4 100644 --- a/doc/user/project/integrations/shimo.md +++ b/doc/user/project/integrations/shimo.md @@ -21,11 +21,11 @@ This change is a breaking change. ## Configure settings in GitLab -To enable the Shimo integration for your group or project: +To enable the Shimo integration for your project: -1. On the top bar, select **Main menu** and find your group or project. -1. On the left sidebar, select **Settings > Integrations**. -1. In **Add an integration**, select **Shimo**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Integrations**. +1. Select **Shimo**. 1. In **Enable integration**, ensure the **Active** checkbox is selected. 1. Provide the **Shimo Workspace URL** you want to link to your group or project (for example, `https://shimo.im/space/aBAYV6VvajUP873j`). 1. Select **Save changes**. @@ -36,8 +36,8 @@ On the left sidebar, **Shimo** now appears instead of **Wiki**. To view the Shimo Workspace from your group or project: -1. On the top bar, select **Main menu** and find your group or project. -1. On the left sidebar, select **Shimo**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Shimo**. 1. On the **Shimo Workspace** page, select **Go to Shimo Workspace**. <!--- end_remove --> diff --git a/doc/user/project/integrations/slack.md b/doc/user/project/integrations/slack.md index 2ce1e15ff63..14183a47625 100644 --- a/doc/user/project/integrations/slack.md +++ b/doc/user/project/integrations/slack.md @@ -32,8 +32,8 @@ to control GitLab from Slack. Slash commands are configured separately. > [Changed](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/106760) in GitLab 15.9 to limit Slack channels to 10 per event. -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Integrations**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Integrations**. 1. Select **Slack notifications**. 1. In the **Enable integration** section, select the **Active** checkbox. 1. In the **Trigger** section, select the checkboxes for each type of GitLab diff --git a/doc/user/project/integrations/slack_slash_commands.md b/doc/user/project/integrations/slack_slash_commands.md index 4fa4b75422e..74bd12561fb 100644 --- a/doc/user/project/integrations/slack_slash_commands.md +++ b/doc/user/project/integrations/slack_slash_commands.md @@ -19,11 +19,10 @@ The [Slack notifications integration](slack.md) is configured separately. ## Configure GitLab and Slack -Slack slash command integrations -are scoped to a project. +Slack slash command integrations are scoped to a project. -1. In GitLab, on the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Integrations**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Integrations**. 1. Select **Slack slash commands**. Leave this browser tab open. 1. Open a new browser tab, sign in to your Slack team, and [start a new Slash Commands integration](https://my.slack.com/services/new/slash-commands). 1. Enter a trigger command. We suggest you use the project name. diff --git a/doc/user/project/integrations/squash_tm.md b/doc/user/project/integrations/squash_tm.md index 2a1106edb0c..ff633783e83 100644 --- a/doc/user/project/integrations/squash_tm.md +++ b/doc/user/project/integrations/squash_tm.md @@ -26,8 +26,8 @@ are synchronized as requirements in Squash TM and test progress is reported in G ## Configure GitLab -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Integrations**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Integrations**. 1. Select **Squash TM**. 1. Ensure that the **Active** toggle is enabled. 1. In the **Trigger** section, indicate which type of issue is concerned by the real-time synchronization. diff --git a/doc/user/project/integrations/telegram.md b/doc/user/project/integrations/telegram.md index fabea52629d..9d36a16f5fc 100644 --- a/doc/user/project/integrations/telegram.md +++ b/doc/user/project/integrations/telegram.md @@ -40,11 +40,12 @@ After you invite the bot to a Telegram channel, you can configure GitLab to send 1. To enable the integration: - **For your group or project:** - 1. On the top bar, select **Main menu** and find your group or project. - 1. on the left sidebar, select **Settings > Integrations**. + 1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project or group. + 1. Select **Settings > Integrations**. - **For your instance:** - 1. On the top bar, select **Main menu > Admin**. - 1. On the left sidebar, select **Settings > Integrations**. + 1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). + 1. Select **Admin Area**. + 1. Select **Settings > Integrations**. 1. Select **Telegram**. 1. In **Enable integration**, select the **Active** checkbox. 1. In **New token**, [paste the token value from the Telegram bot](#create-a-telegram-bot). diff --git a/doc/user/project/integrations/unify_circuit.md b/doc/user/project/integrations/unify_circuit.md index 4a40a6250f1..7d0dd6d2af3 100644 --- a/doc/user/project/integrations/unify_circuit.md +++ b/doc/user/project/integrations/unify_circuit.md @@ -15,8 +15,8 @@ copy its URL. In GitLab: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Integrations**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Integrations**. 1. Select **Unify Circuit**. 1. Turn on the **Active** toggle. 1. Select the checkboxes corresponding to the GitLab events you want to receive in Unify Circuit. diff --git a/doc/user/project/integrations/webex_teams.md b/doc/user/project/integrations/webex_teams.md index 2388014db06..3ba05476e63 100644 --- a/doc/user/project/integrations/webex_teams.md +++ b/doc/user/project/integrations/webex_teams.md @@ -21,14 +21,17 @@ You can configure GitLab to send notifications to a Webex Teams space: ## Configure settings in GitLab -Once you have a webhook URL for your Webex Teams space, you can configure GitLab to send +After you have a webhook URL for your Webex Teams space, you can configure GitLab to send notifications: -1. Navigate to: - - **Settings > Integrations** in a project to enable the integration at the project level. - - **Settings > Integrations** in a group to enable the integration at the group level. - - On the top bar, select **Main menu > Admin**. Then, in the left sidebar, - select **Settings > Integrations** to enable an instance-level integration. +1. To enable integration: + - At the project or group level: + 1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project or group. + 1. Select **Settings > Integrations**. + - At the instance level: + 1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). + 1. Select **Admin Area**. + 1. Select **Settings > Integrations**. 1. Select the **Webex Teams** integration. 1. Ensure that the **Active** toggle is enabled. 1. Select the checkboxes corresponding to the GitLab events you want to receive in Webex Teams. diff --git a/doc/user/project/integrations/youtrack.md b/doc/user/project/integrations/youtrack.md index b1c7b533c0f..8845aa8fdfd 100644 --- a/doc/user/project/integrations/youtrack.md +++ b/doc/user/project/integrations/youtrack.md @@ -14,8 +14,8 @@ You can configure YouTrack as an To enable the YouTrack integration in a project: -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > Integrations**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > Integrations**. 1. Select **YouTrack**. 1. Select the checkbox under **Enable integration**. 1. Fill in the required fields: diff --git a/doc/user/project/working_with_projects.md b/doc/user/project/working_with_projects.md index 912aa6d0ebf..5bd7c12ed31 100644 --- a/doc/user/project/working_with_projects.md +++ b/doc/user/project/working_with_projects.md @@ -11,9 +11,15 @@ code are saved in projects, and most features are in the scope of projects. ## View projects -To view all your projects, on the top bar, select **Main menu > Projects > View all projects**. +To view all your projects: -To browse all public projects, select **Main menu > Explore > Projects**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **View all your projects**. + +To browse all projects you can access: + +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Explore**. ### Who can view the Projects page @@ -42,11 +48,12 @@ visit the `/projects/:id` URL in your browser or other tool accessing the projec To explore project topics: -1. On the top bar, select **Main menu > Projects > View all projects**. -1. Select the **Explore topics** tab. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **Explore**. +1. On the left sidebar, select **Topics**. 1. To view projects associated with a topic, select a topic. -The **Explore topics** tab shows a list of topics sorted by the number of associated projects. +The **Explore topics** page shows a list of topics, sorted by the number of associated projects. You can assign topics to a project on the [Project Settings page](settings/index.md#assign-topics-to-a-project). @@ -59,13 +66,14 @@ You can add a star to projects you use frequently to make them easier to find. To add a star to a project: -1. On the top bar, select **Main menu > Projects** and find your project. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. 1. In the upper-right corner of the page, select **Star**. ## View starred projects -1. On the top bar, select **Main menu > Projects > View all projects**. -1. Select the **Starred projects** tab. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **View all your projects**. +1. Select the **Starred** tab. 1. GitLab displays information about your starred projects, including: - Project description, including name, description, and icon. @@ -83,7 +91,8 @@ called `my-project` under your username, the project is created at `https://gitl To view your personal projects: -1. On the top bar, select **Main menu > Projects > View all projects**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **View all your projects**. 1. In the **Yours** tab, select **Personal**. ## Delete a project @@ -95,7 +104,7 @@ After you delete a project: To delete a project: -1. On the top bar, select **Main menu > Projects** and find your project. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. 1. Select **Settings > General**. 1. Expand the **Advanced** section. 1. Scroll down to the **Delete project** section. @@ -111,7 +120,8 @@ To delete a project: To view a list of all projects that are pending deletion: -1. On the top bar, select **Main menu > Projects > View all projects**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select **View all your projects**. 1. Based on your GitLab version: - GitLab 14.6 and later: select the **Pending deletion** tab. - GitLab 14.5 and earlier: select the **Deleted projects** tab. @@ -126,18 +136,14 @@ Each project in the list shows: To view the activity of a project: -1. On the top bar, select **Main menu > Projects** and find your project.. -1. On the left sidebar, select **Project information > Activity**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Manage > Activity**. 1. Select a tab to view the type of project activity. ## Search in projects -You can search through your projects. - -1. On the top bar, select **Main menu**. -1. In **Search your projects**, type the project name. - -GitLab filters as you type. +To search through your projects, on the left sidebar, at the top, select **Search GitLab** +(**{search}**). GitLab filters as you type. You can also look for the projects you [starred](#star-a-project) (**Starred projects**). @@ -160,7 +166,10 @@ You can also choose to hide or show archived projects. You can filter projects by the programming language they use. To do this: -1. On the top bar, select **Main menu > Projects > View all projects**. +1. On the left sidebar, expand the top-most chevron (**{chevron-down}**). +1. Select either: + - **View all your projects**, to filter your projects. + - **Explore**, to filter all projects you can access. 1. From the **Language** dropdown list, select the language you want to filter projects by. A list of projects that use the selected language is displayed. @@ -173,8 +182,8 @@ Prerequisite: - You must have the Owner role for the project. -1. On the top bar, select **Main menu > Projects** and find your project. -1. On the left sidebar, select **Settings > General**. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. +1. Select **Settings > General**. 1. Expand **Visibility, project features, permissions**. 1. Use the toggle by each feature you want to turn on or off, or change access for. 1. Select **Save changes**. @@ -189,7 +198,7 @@ When you leave a project: To leave a project: -1. On the top bar, select **Main menu > Projects** and find your project. +1. On the left sidebar, at the top, select **Search GitLab** (**{search}**) to find your project. 1. Select **Leave project**. The **Leave project** option only displays on the project dashboard when a project is part of a group under a [group namespace](../namespace/index.md). |