summaryrefslogtreecommitdiff
path: root/doc/user
diff options
context:
space:
mode:
authorGitLab Bot <gitlab-bot@gitlab.com>2023-04-11 09:12:15 +0000
committerGitLab Bot <gitlab-bot@gitlab.com>2023-04-11 09:12:15 +0000
commita48957b317edf23b1bcfc6df0c098a824eae86f4 (patch)
tree9a8ce03341e088db5cdba549f4a2fee6afef6e3c /doc/user
parenta3e10bf32044486be8923176581670cf9ccacc8b (diff)
downloadgitlab-ce-a48957b317edf23b1bcfc6df0c098a824eae86f4.tar.gz
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/user')
-rw-r--r--doc/user/group/manage.md2
-rw-r--r--doc/user/project/repository/code_suggestions.md60
-rw-r--r--doc/user/project/repository/forking_workflow.md8
-rw-r--r--doc/user/project/repository/vscode.md1
4 files changed, 37 insertions, 34 deletions
diff --git a/doc/user/group/manage.md b/doc/user/group/manage.md
index 6bdd58d8314..6989f746e92 100644
--- a/doc/user/group/manage.md
+++ b/doc/user/group/manage.md
@@ -658,7 +658,7 @@ Support for group-level settings for merge request approval rules is tracked in
> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/405126) in GitLab 15.11.
WARNING:
-This feature is in [Open Beta](/ee/policy/alpha-beta-support.md#open-beta-features). Code Suggestions is a generative AI feature that suggests code for developers. Due to high demand, we expect this feature will have unscheduled downtime and delays in code suggestions appearing in VS Code. We strongly encourage beta users to read about the [known limitations](../project/repository/code_suggestions.md#known-limitations). We look forward to hearing your feedback.
+This feature is in [Open Beta](/ee/policy/alpha-beta-support.md#open-beta-features). Code Suggestions use generative AI to suggest code while you're developing. Due to high demand, this feature will have unscheduled downtime and code suggestions in VS Code may be delayed. Code Suggestions may produce [low-quality or incomplete suggestions](../project/repository/code_suggestions.md#model-accuracy-and-quality). Beta users should read about the [known limitations](../project/repository/code_suggestions.md#known-limitations). We look forward to hearing your feedback.
This setting enables users in the group to access [Code Suggestions](../project/repository/code_suggestions.md).
This setting [cascades to all projects](../project/merge_requests/approvals/settings.md#settings-cascading)
diff --git a/doc/user/project/repository/code_suggestions.md b/doc/user/project/repository/code_suggestions.md
index 42465f5cd63..f9f6b2f75fd 100644
--- a/doc/user/project/repository/code_suggestions.md
+++ b/doc/user/project/repository/code_suggestions.md
@@ -5,21 +5,21 @@ info: To determine the technical writer assigned to the Stage/Group associated w
type: index, reference
---
-# Code Suggestions (Open Beta) **(ULTIMATE)**
+# Code Suggestions (Open Beta) **(ULTIMATE SAAS)**
> - Enabled as opt-in with GitLab 15.11 as [Open Beta](/ee/policy/alpha-beta-support.md#open-beta-features).
> - [Introduced](https://about.gitlab.com/releases/2023/02/22/gitlab-15-9-released/#code-suggestions-available-in-closed-beta) in GitLab 15.9 as [Closed Beta](/ee/policy/alpha-beta-support.md#closed-beta-features).
WARNING:
-This feature is in [Open Beta](/ee/policy/alpha-beta-support.md#open-beta-features). Code Suggestions is a generative AI feature that suggests code for developers. Due to high demand, we expect this feature will have unscheduled downtime and delays in code suggestions appearing in VS Code. We strongly encourage beta users to read about the [known limitations](#known-limitations). We look forward to hearing your feedback.
+This feature is in [Open Beta](/ee/policy/alpha-beta-support.md#open-beta-features). Code Suggestions use generative AI to suggest code while you're developing. Due to high demand, this feature will have unscheduled downtime and code suggestions in VS Code may be delayed. Code Suggestions may produce [low-quality or incomplete suggestions](#model-accuracy-and-quality). Beta users should read about the [known limitations](#known-limitations). We look forward to hearing your feedback.
-Use Code Suggestions to code more efficiently by viewing code suggestions
+Use Code Suggestions to write code more efficiently by viewing code suggestions
as you type. Depending on the cursor position, the extension either:
- Provides entire code snippets, like generating functions.
- Completes the current line.
-You can press <kbd>Tab</kbd> to accept suggestions.
+To accept a suggestion, press <kbd>Tab</kbd>.
Code Suggestions are supported in Visual Studio Code with the GitLab Workflow extension. GitLab plans to support the [new GitLab WebIDE in an upcoming release](../web_ide_beta/index.md) in the future.
@@ -34,20 +34,20 @@ The best results from Code Suggestions are expected for these six languages:
Suggestions may be mixed for other languages. Using natural language code comments to request completions may also not function as expected.
-GitLab is continuously improving the model and expect to support an additional seven languages soon, as well as natural language code comments.
+GitLab is continuously improving the model and expects to support an additional seven languages soon, as well as natural language code comments.
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).
-## Group level setting **(ULTIMATE)**
+## Group level setting
[Group owners](../../permissions.md#group-members-permissions) can enable Code Suggestions for all projects in a group by using the [group level Code Suggestions setting](../../group/manage.md#group-code-suggestions).
-## Enable Code Suggestions in VS Code **(ULTIMATE)**
+## Enable Code Suggestions in VS Code
Prerequisites:
-- Your group owner has enabled the [group level Code Suggestions setting](#group-level-setting).
-- You have [created a personal access token](../../profile/personal_access_tokens.md#create-a-personal-access-token) with the `read_api` and `read_user` scopes.
+- Your group owner must enable the [group level code suggestions setting](../../group/manage.md#group-code-suggestions).
+- You must have [a personal access token](../../profile/personal_access_tokens.md#create-a-personal-access-token) with the `read_api` and `read_user` scopes.
To enable Code Suggestions in VS Code:
@@ -61,12 +61,12 @@ To enable Code Suggestions in VS Code:
1. Provide your personal access token.
1. After your GitLab account connects successfully, in the left sidebar, select **Extensions**.
1. Find the **GitLab workflow** extension, select **Settings** (**{settings}**), and select **Extension Settings**.
-1. Enable **GitLab › AI Assisted Code Suggestions**.
+1. Enable **GitLab > AI Assisted Code Suggestions**.
Start typing and receive suggestions for your GitLab projects.
<div class="video-fallback">
- See an end-to-end demo: <a href="https://www.youtube.com/watch?v=WnxBYxN2-p4">How to get started with GitLab Code Suggestions in VS Code</a>.
+ See an end-to-end demo: <a href="https://www.youtube.com/watch?v=WnxBYxN2-p4">Get started with GitLab Code Suggestions in VS Code</a>.
</div>
<figure class="video-container">
<iframe src="https://www.youtube-nocookie.com/embed/WnxBYxN2-p4" frameborder="0" allowfullscreen> </iframe>
@@ -78,11 +78,15 @@ Start typing and receive suggestions for your GitLab projects.
Code Suggestions is a generative artificial intelligence (AI) model hosted on GitLab.com that can empower your developers to code more efficiently by suggesting code as they type.
-This feature uses a VS Code plugin to securely connect to a GitLab API hosted in GitLab.com's enterprise infrastructure that inferences a GitLab managed generative AI model.
+The personal access token enables a secure API connection to GitLab.com. This API connection securely transmits a context window from VS Code to the Code Suggestions ML model for inference, and the generated suggestion is transmitted back to VS Code.
-#### Enabling the feature
+#### Progressive enhancement
-Code Suggestions are managed by a group-level setting that is disabled by default. This group-level setting can only be enabled by group owners.
+This feature is designed as a progressive enhancement to the existing VS Code GitLab Workflow plugin. Code Suggestions offer a completion if the machine learning engine can generate a recommendation. 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 VS Code.
+
+#### Off by default
+
+Code Suggestions are off by default and require a group owner to enable the feature with a [group-level setting](#group-level-setting).
After the group level setting is enabled, Developers using Visual Studio Code with the [GitLab Workflow extension](https://marketplace.visualstudio.com/items?itemName=GitLab.gitlab-workflow) can connect to GitLab.com via a GitLab [personal access token](../../profile/personal_access_tokens.md#create-a-personal-access-token) with the `read_api` and `read_user` scopes.
@@ -90,37 +94,29 @@ After the group level setting is enabled, Developers using Visual Studio Code wi
Once configured by a developer in VS Code. The personal access token enables a secure API connection to GitLab.com. This API connection securely transmits a context window from VS Code to the Code Suggestions ML model for inference, and the generated suggestion is transmitted back to VS Code.
-Code Suggestions only works when developers have internet connectivity and can access GitLab.com. Code Suggestions is not available for self-managed customers, nor customers operating within an air-gapped environment.
-
-### Progressive enhancement
-
-This feature is designed as a progressive enhancement to the existing VS Code GitLab Workflow plugin. Code Suggestions only offers a completion if the ML engine is able to generate a recommendation. In the event of a connection issue or model inference failure, the feature gracefully degrades. At no point with the usage of Code Suggestions prevent a user from being able to write code in VS Code.
-
-### Off by default
-
-Code Suggestions is off by default and requires a Group Owner to enable the feature.
+Code Suggestions only work when you have internet connectivity and can access GitLab.com. Code Suggestions are not available for self-managed customers, nor customers operating within an air-gapped environment.
### Stability and performance
-This feature is currently marked as [open beta](/ee/policy/alpha-beta-support.md#open-beta-features). While the Code Suggestions inference API operates completely within GitLab.com's enterprise infrastructure, we expect a high demand for this beta feature, which may cause degraded performance or unexpected downtime of the feature. We have built this feature to gracefully degrade and have controls in place to allow us to mitigate abuse or misuse. GitLab may disable this feature for any or all customers at anytime at our discretion.
+This feature is currently in [Open Beta](/ee/policy/alpha-beta-support.md#open-beta-features). While the Code Suggestions inference API operates completely within GitLab.com's enterprise infrastructure, we expect a high demand for this Beta feature, which may cause degraded performance or unexpected downtime of the feature. We have built this feature to gracefully degrade and have controls in place to allow us to mitigate abuse or misuse. GitLab may disable this feature for any or all customers at any time at our discretion.
## Data privacy
-Code Suggestions operates completely in the GitLab.com infrastructure, providing the same level of [security](https://about.gitlab.com/security/) as any other feature of GitLab.com, and processing any Personal Data in accordance with our [Privacy Statement](https://about.gitlab.com/privacy/).
+Code Suggestions operate completely in the GitLab.com infrastructure, providing the same level of [security](https://about.gitlab.com/security/) as any other feature of GitLab.com, and processing any personal data in accordance with our [Privacy Statement](https://about.gitlab.com/privacy/).
No new additional data is collected to enable this feature. The content of your GitLab hosted source code is not used as training data. Source code inference against the Code Suggestions model is not used to re-train the model. Your data also never leaves GitLab.com. All training and inference is done in GitLab.com infrastructure.
[Read more about the security of GitLab.com](https://about.gitlab.com/security/faq/).
-### Model Accuracy and quality
+### Model accuracy and quality
-We use a customized open source dataset to fine-tune the model to support multiple languages. Based on the languages the developer codes in, we route the request to a targeted inference and prompt engine to get relevant context.
+While in Beta, Code Suggestions can generate low-quality, incomplete, and possibly insecure code. We strongly encourage all beta users to leverage GitLab native [Code Quality Scanning](../../../ci/testing/code_quality.md) and [Security Scanning](../../application_security/index.md) capabilities.
-We are actively refining these models to improve the quality of recommendations, add support for more languages, and add protections to limit Personal Data, insecure code, and other unwanted behavior that the model may have learned from training data.
+GitLab uses a customized open source dataset to fine-tune the model to support multiple languages. Based on the languages you code in, GitLab routes the request to a targeted inference and prompt engine to get relevant suggestions.
-While in beta, it is possible for Code Suggestions to generate low-quality and possibly insecure code. We strongly encourage all beta users to leverage GitLab native [Code Quality Scanning](../../../ci/testing/code_quality.md) and [Security Scanning](../../application_security/index.md) capabilities.
+GitLab is actively refining these models to improve the quality of recommendations, add support for more languages, and add protections to limit personal data, insecure code, and other unwanted behavior that the model may have learned from training data.
-### Training Data
+### Training data
Code Suggestions uses open source pre-trained base models from the [CodeGen family](https://openreview.net/forum?id=iaYcJKpY2B_) including CodeGen-MULTI and CodeGen-NL. We then re-train and fine-tune these base models with a customized open source dataset to enable multi-language support and additional use cases. This customized dataset contains non-preprocessed open source code in 13 programming languages from [The Pile](https://pile.eleuther.ai/) and [Google's BigQuery source code dataset](https://cloud.google.com/blog/topics/public-datasets/github-on-bigquery-analyze-all-the-open-source-code). We then process this raw dataset against heuristics that aim to increase the quality of the dataset.
@@ -128,7 +124,7 @@ The Code Suggestions model is not trained on GitLab customer data.
## Known limitations
-While in beta, we are working on improving the accuracy of overall generated content. However, Code Suggestions may generate suggestions that are:
+While in Beta, we are working on improving the accuracy of overall generated content. However, Code Suggestions may generate suggestions that are:
- Low-quality
- Incomplete
@@ -143,4 +139,4 @@ We are also aware of specific situations that can produce unexpected or incohere
## Feedback
-You may report issues in our [feedback issue](https://gitlab.com/gitlab-org/gitlab/-/issues/405152).
+Report issues in the [feedback issue](https://gitlab.com/gitlab-org/gitlab/-/issues/405152).
diff --git a/doc/user/project/repository/forking_workflow.md b/doc/user/project/repository/forking_workflow.md
index 690cf4a04a5..85414a55e81 100644
--- a/doc/user/project/repository/forking_workflow.md
+++ b/doc/user/project/repository/forking_workflow.md
@@ -101,7 +101,7 @@ an `upstream` remote repository for your fork:
A fork can be configured as a mirror of the upstream if all these conditions are met:
-1. Your subscription is **(PREMIUM)** or a higher tier.
+1. Your subscription is **Premium** or higher.
1. You create all changes in branches (not `main`).
1. You do not work on [merge requests for confidential issues](../merge_requests/confidential.md),
which requires changes to `main`.
@@ -132,6 +132,12 @@ changes are added to the repository and branch you're merging into.
You can unlink your fork from its upstream project in the [advanced settings](../settings/index.md#remove-a-fork-relationship).
+If you unlink a fork in this way and if [pool repositories](../../../development/git_object_deduplication.md#pool-repositories) are used, all objects are
+copied from the pool into the fork.
+
+After this copy is complete, the relationship is broken and the fork becomes an independent project. From this point, any updates to objects in the pool are
+not propagated to the project that was previously a fork.
+
## Related topics
- GitLab blog post: [Keep your fork up to date with its origin](https://about.gitlab.com/blog/2016/12/01/how-to-keep-your-fork-up-to-date-with-its-origin/)
diff --git a/doc/user/project/repository/vscode.md b/doc/user/project/repository/vscode.md
index 8e1d76a94f9..94824f3c492 100644
--- a/doc/user/project/repository/vscode.md
+++ b/doc/user/project/repository/vscode.md
@@ -22,6 +22,7 @@ do more day-to-day tasks in Visual Studio Code, such as:
and paste snippets to, and from, your editor.
- [Browse repositories](https://marketplace.visualstudio.com/items?itemName=GitLab.gitlab-workflow#browse-a-repository-without-cloning)
without cloning them.
+- [Receive Code Suggestions](code_suggestions.md)
## Download the extension