From 02bbf34347dc346e986591e65b5404aa811576d0 Mon Sep 17 00:00:00 2001 From: Suzanne Selhorn <sselhorn@gitlab.com> Date: Thu, 27 Feb 2025 18:28:47 +0000 Subject: [PATCH] Moving prereqs closer to related docs Because they were linked to and separate --- doc/user/duo_workflow/_index.md | 27 ++++++++++++++++++--------- doc/user/duo_workflow/set_up.md | 19 +++++++------------ 2 files changed, 25 insertions(+), 21 deletions(-) diff --git a/doc/user/duo_workflow/_index.md b/doc/user/duo_workflow/_index.md index 7b251094cd9e6..c658278f13eee 100644 --- a/doc/user/duo_workflow/_index.md +++ b/doc/user/duo_workflow/_index.md @@ -47,13 +47,22 @@ Workflow: - Understands the context of your project structure, codebase, and history. You can also add your own context, such as relevant GitLab issues or merge requests. -## Use Workflow in VS Code +## Prerequisites + +To use Workflow: -Prerequisites: +- You must have [completed setup](set_up.md). +- You must have an account on GitLab.com. +- You must have a project that meets the following requirements: + - The project is on GitLab.com. + - You have at least the Developer role. + - The project belongs to a [group namespace](../namespace/_index.md) with an Ultimate subscription. + - [Experimental features must be turned on](../gitlab_duo/turn_on_off.md#turn-on-beta-and-experimental-features). + - [GitLab Duo must be turned on](../gitlab_duo/_index.md). + - The repository you want to work with should be small or medium-sized. + Workflow can be slow or fail for large repositories. -- You must have [set up Workflow](set_up.md). -- The repository you want to work with should be small or medium-sized. - Workflow can be slow or fail for large repositories. +## Use Workflow in VS Code To use Workflow in VS Code: @@ -83,11 +92,11 @@ You can also provide it with additional context. | Area | How to use GitLab Workflow | |-------------------------------|--------------------------------| -| Epics | Enter the epic ID and the name of the group the epic is in. The group must include a project that meets the [prerequisites](set_up.md#prerequisites). | -| Issues | Enter the issue ID if it's in the current project. You can also enter a project ID from a different project, as long as it meets the [prerequisites](set_up.md#prerequisites). | +| Epics | Enter the epic ID and the name of the group the epic is in. The group must include a project that meets the project prerequisites. | +| Issues | Enter the issue ID if it's in the current project. You can also enter a project ID from a different project, as long as it meets the project prerequisites. | | Local files | Workflow is aware of all files available to Git in the project you have open in your editor. You can also reference a specific file by its file path. | -| Merge requests | Enter the merge request ID if it's in the current project. You can also enter a project ID from a different project, as long as it meets the [prerequisites](set_up.md#prerequisites). | -| Merge request pipelines | Enter the merge request ID that has the pipeline, if it's in the current project. You can also enter a project ID from a different project, as long as it meets the [prerequisites](set_up.md#prerequisites). | +| Merge requests | Enter the merge request ID if it's in the current project. You can also enter a project ID from a different project, as long as it meets the project prerequisites. | +| Merge request pipelines | Enter the merge request ID that has the pipeline, if it's in the current project. You can also enter a project ID from a different project, as long as it meets the project prerequisites. | Workflow also has access to the GitLab [Search API](../../api/search.md) to find related issues or merge requests. diff --git a/doc/user/duo_workflow/set_up.md b/doc/user/duo_workflow/set_up.md index bd31d7a31730c..f84aa270e870a 100644 --- a/doc/user/duo_workflow/set_up.md +++ b/doc/user/duo_workflow/set_up.md @@ -23,18 +23,13 @@ Use the following guide to set up GitLab Duo Workflow. ## Prerequisites -Before you can use Workflow: - -1. Ensure you have an account on GitLab.com. -1. Ensure that the GitLab.com project you want to use with Workflow meets these requirements: - - You must have at least the Developer role for the project. - - Your project must belong to a [group namespace](../namespace/_index.md) - with an **Ultimate** subscription and [experimental features turned on](../gitlab_duo/turn_on_off.md#turn-on-beta-and-experimental-features). - - The project must have [GitLab Duo turned on](../gitlab_duo/_index.md). -1. [Install Visual Studio Code](https://code.visualstudio.com/download) (VS Code). -1. [Install and set up](https://marketplace.visualstudio.com/items?itemName=GitLab.gitlab-workflow#setup) the GitLab Workflow extension for VS Code. - Minimum version 5.16.0. -1. [Install Docker and set the socket file path](set_up.md#install-docker-and-set-the-socket-file-path). +Before you can set up Workflow: + +- [Install Visual Studio Code](https://code.visualstudio.com/download) (VS Code). +- [Install and set up](https://marketplace.visualstudio.com/items?itemName=GitLab.gitlab-workflow#setup) + the GitLab Workflow extension for VS Code. Minimum version 5.16.0. + +Then, complete the following steps. ## Install Docker and set the socket file path -- GitLab