diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-12-07 00:12:50 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-12-07 00:12:50 +0300 |
commit | aa74b7b4c5f326e82fcd6bb681296dce435ea024 (patch) | |
tree | f9382e543ae4bc90c8b8b335e1f9d2eeae673407 /doc/user | |
parent | bf03e90e020f59322873be25e5fc13ba1170eb02 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/user')
3 files changed, 44 insertions, 39 deletions
diff --git a/doc/user/project/repository/code_suggestions/index.md b/doc/user/project/repository/code_suggestions/index.md index f7a8d9cac8f..d73668c632c 100644 --- a/doc/user/project/repository/code_suggestions/index.md +++ b/doc/user/project/repository/code_suggestions/index.md @@ -16,16 +16,18 @@ Beta users should read about the [known limitations](#known-limitations). We loo Write code more efficiently by using generative AI to suggest code while you're developing. -Code Suggestions supports two distinct types of interactions: +With Code Suggestions, you get: - Code Completion, which suggests completions the current line you are typing. These suggestions are usually low latency. - Code Generation, which generates code based on a natural language code comment block. Generating code can exceed multiple seconds. +## Start using Code Suggestions + GitLab Duo Code Suggestions are available: -- On [self-managed](self_managed.md) and [SaaS](saas.md). +- On [self-managed](self_managed.md) and [SaaS](saas.md). View these pages to get started. - In VS Code, Microsoft Visual Studio, JetBrains IDEs, and Neovim. You must have the corresponding GitLab extension installed. -- In the GitLab WebIDE. +- In the GitLab Web IDE. <div class="video-fallback"> <a href="https://youtu.be/wAYiy05fjF0">View how to setup and use GitLab Duo Code Suggestions</a>. @@ -37,36 +39,6 @@ GitLab Duo Code Suggestions are available: During Beta, usage of Code Suggestions is governed by the [GitLab Testing Agreement](https://about.gitlab.com/handbook/legal/testing-agreement/). Learn about [data usage when using Code Suggestions](#code-suggestions-data-usage). As Code Suggestions matures to General Availability it will be governed by our [AI Functionality Terms](https://about.gitlab.com/handbook/legal/ai-functionality-terms/). -## Use Code Suggestions - -Prerequisites: - -- You must have installed and configured a [supported IDE editor extension](index.md#supported-editor-extensions). -- If you are a **SaaS** user, you must enable Code Suggestions for: - - [The top-level group](../../../group/manage.md#enable-code-suggestions) (you must have the Owner role for that group). - - [Your own account](../../../profile/preferences.md#enable-code-suggestions). -- If you are a **self-managed** user, you must enable Code Suggestions [for your instance](self_managed.md#enable-code-suggestions-on-self-managed-gitlab). How you enable Code Suggestions differs depending on your version of GitLab. - -To use Code Suggestions: - -1. Author your code. As you type, suggestions are displayed. Code Suggestions, depending on the cursor position, either provides code snippets or completes the current line. -1. Describe the requirements in natural language. Be concise and specific. Code Suggestions generates functions and code snippets as appropriate. -1. To accept a suggestion, press <kbd>Tab</kbd>. -1. To ignore a suggestion, keep typing as you usually would. -1. To explicitly reject a suggestion, press <kbd>esc</kbd>. - -Things to remember: - -- AI is non-deterministic, so you may not get the same suggestion every time with the same input. -- Just like product requirements, writing clear, descriptive, and specific tasks results in quality generated code. - -### Progressive enhancement - -This feature is designed as a progressive enhancement to developer's IDEs. -Code Suggestions offer a completion if a suitable recommendation is provided to the user in a timely matter. -In the event of a connection issue or model inference failure, the feature gracefully degrades. -Code Suggestions do not prevent you from writing code in your IDE. - ## Supported languages Code Suggestions support is a function of the: @@ -170,6 +142,13 @@ However, Code Suggestions may generate suggestions that are: - Insecure code - Offensive or insensitive +## Progressive enhancement + +This feature is designed as a progressive enhancement to developer's IDEs. +Code Suggestions offer a completion if a suitable recommendation is provided to the user in a timely matter. +In the event of a connection issue or model inference failure, the feature gracefully degrades. +Code Suggestions do not prevent you from writing code in your IDE. + ## Feedback Report issues in the [feedback issue](https://gitlab.com/gitlab-org/gitlab/-/issues/405152). diff --git a/doc/user/project/repository/code_suggestions/saas.md b/doc/user/project/repository/code_suggestions/saas.md index 77a364f14ff..9abafa72616 100644 --- a/doc/user/project/repository/code_suggestions/saas.md +++ b/doc/user/project/repository/code_suggestions/saas.md @@ -34,7 +34,21 @@ If you are having issues enabling Code Suggestions, view the Prerequisites: -- Ensure Code Suggestions is enabled for your user and group. -- You must have installed and configured a [supported IDE editor extension](index.md#supported-editor-extensions). +- You must have a [supported IDE editor extension](index.md#supported-editor-extensions). +- Code Suggestions must be enabled for: + - [The top-level group](../../../group/manage.md#enable-code-suggestions). + - [Your own account](../../../profile/preferences.md#enable-code-suggestions). -[Use Code Suggestions](index.md#use-code-suggestions). +To use Code Suggestions: + +1. Author your code. As you type, suggestions are displayed. + Code Suggestions provide code snippets or complete the current line, depending on the cursor position. +1. Describe the requirements in natural language. Be concise and specific. Code Suggestions generates functions and code snippets as appropriate. +1. To accept a suggestion, press <kbd>Tab</kbd>. +1. To ignore a suggestion, keep typing as you usually would. +1. To explicitly reject a suggestion, press <kbd>Esc</kbd>. + +Things to remember: + +- AI is non-deterministic, so you may not get the same suggestion every time with the same input. +- Just like product requirements, writing clear, descriptive, and specific tasks results in quality generated code. diff --git a/doc/user/project/repository/code_suggestions/self_managed.md b/doc/user/project/repository/code_suggestions/self_managed.md index 2e06191a002..6d05aacca54 100644 --- a/doc/user/project/repository/code_suggestions/self_managed.md +++ b/doc/user/project/repository/code_suggestions/self_managed.md @@ -151,10 +151,22 @@ Without the manual synchronization, it might take up to 24 hours to active Code Prerequisites: -- Code Suggestions must be enabled [for the instance](#enable-code-suggestions-on-self-managed-gitlab). -- You must have installed and configured a [supported IDE editor extension](index.md#supported-editor-extensions). +- You must have a [supported IDE editor extension](index.md#supported-editor-extensions). +- Code Suggestions must be enabled [for your instance](self_managed.md#enable-code-suggestions-on-self-managed-gitlab). -[Use Code Suggestions](index.md#use-code-suggestions). +To use Code Suggestions: + +1. Author your code. As you type, suggestions are displayed. + Code Suggestions provide code snippets or complete the current line, depending on the cursor position. +1. Describe the requirements in natural language. Be concise and specific. Code Suggestions generates functions and code snippets as appropriate. +1. To accept a suggestion, press <kbd>Tab</kbd>. +1. To ignore a suggestion, keep typing as you usually would. +1. To explicitly reject a suggestion, press <kbd>Esc</kbd>. + +Things to remember: + +- AI is non-deterministic, so you may not get the same suggestion every time with the same input. +- Just like product requirements, writing clear, descriptive, and specific tasks results in quality generated code. ### Data privacy |