diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2023-07-18 21:10:24 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2023-07-18 21:10:24 +0300 |
commit | 7488eeff6fdf82ee7b926d684a201212b0509cbb (patch) | |
tree | c7565c44b5042ce711752a48293f38456c6c7ef1 /doc | |
parent | 93d0784e6d8f43ef5a27f506784b4b0d989c0c2b (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc')
-rw-r--r-- | doc/administration/admin_area.md | 2 | ||||
-rw-r--r-- | doc/administration/appearance.md | 2 | ||||
-rw-r--r-- | doc/administration/compliance.md | 6 | ||||
-rw-r--r-- | doc/administration/configure.md | 2 | ||||
-rw-r--r-- | doc/administration/docs_self_host.md | 4 | ||||
-rw-r--r-- | doc/administration/get_started.md | 10 | ||||
-rw-r--r-- | doc/administration/gitaly/troubleshooting.md | 2 | ||||
-rw-r--r-- | doc/administration/instance_limits.md | 22 | ||||
-rw-r--r-- | doc/administration/logs/index.md | 4 | ||||
-rw-r--r-- | doc/administration/packages/index.md | 2 | ||||
-rw-r--r-- | doc/administration/redis/replication_and_failover.md | 2 | ||||
-rw-r--r-- | doc/administration/settings/deprecated_api_rate_limits.md | 2 | ||||
-rw-r--r-- | doc/ci/yaml/signing_examples.md | 4 | ||||
-rw-r--r-- | doc/development/fe_guide/index.md | 6 | ||||
-rw-r--r-- | doc/development/fe_guide/onboarding_course/index.md | 64 | ||||
-rw-r--r-- | doc/development/fe_guide/onboarding_course/lesson_1.md | 183 | ||||
-rw-r--r-- | doc/user/asciidoc.md | 2 | ||||
-rw-r--r-- | doc/user/product_analytics/index.md | 23 | ||||
-rw-r--r-- | doc/user/project/repository/code_suggestions.md | 19 |
19 files changed, 325 insertions, 36 deletions
diff --git a/doc/administration/admin_area.md b/doc/administration/admin_area.md index 82ee7c92c6d..1e103bb55c8 100644 --- a/doc/administration/admin_area.md +++ b/doc/administration/admin_area.md @@ -196,7 +196,7 @@ You must be an administrator to manually add emails to users: ## User cohorts -The [Cohorts](../user/admin_area/user_cohorts.md) tab displays the monthly cohorts of new users and their activities over time. +The [Cohorts](user_cohorts.md) tab displays the monthly cohorts of new users and their activities over time. ## Prevent a user from creating groups diff --git a/doc/administration/appearance.md b/doc/administration/appearance.md index ba63f5bfe76..c5c50d95eb6 100644 --- a/doc/administration/appearance.md +++ b/doc/administration/appearance.md @@ -69,7 +69,7 @@ to activate it in the GitLab instance. You can also select **Sign-in page**, to review the saved appearance settings: NOTE: -You can add also add a [customized hcelp message](../user/admin_area/settings/help_page.md) below the sign in message or add [a Sign in text message](settings/sign_in_restrictions.md#sign-in-information). +You can add also add a [customized hcelp message](settings/help_page.md) below the sign in message or add [a Sign in text message](settings/sign_in_restrictions.md#sign-in-information). ## Progressive Web App diff --git a/doc/administration/compliance.md b/doc/administration/compliance.md index cc162e8ec53..978e43b2e2c 100644 --- a/doc/administration/compliance.md +++ b/doc/administration/compliance.md @@ -20,7 +20,7 @@ and secure supply chain best practices: | Feature | Instances | Groups | Projects | Description | |:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:-----------------------|:-----------------------|:-----------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [Credentials inventory](../user/admin_area/credentials_inventory.md) | **{check-circle}** Yes | **{dotted-circle}** No | **{dotted-circle}** No | Keep track of the credentials used by all of the users in a GitLab instance. | +| [Credentials inventory](credentials_inventory.md) | **{check-circle}** Yes | **{dotted-circle}** No | **{dotted-circle}** No | Keep track of the credentials used by all of the users in a GitLab instance. | | [Granular user roles<br/>and flexible permissions](../user/permissions.md) | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | Manage access and permissions with five different user roles and settings for external users. Set permissions according to people's role, rather than either read or write access to a repository. Don't share the source code with people that only need access to the issue tracker. | | [Merge request approvals](../user/project/merge_requests/approvals/index.md) | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | Configure approvals required for merge requests. | | [Push rules](../user/project/repository/push_rules.md) | **{check-circle}** Yes | **{check-circle}** Yes | **{check-circle}** Yes | Control pushes to your repositories. | @@ -65,8 +65,8 @@ These features can also help with compliance requirements: | Feature | Instances | Groups | Projects | Description | |:------------------------------------------------------------------------------------------------------------------------------------|:-----------------------|:-----------------------|:-----------------------|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| [Email all users of a project,<br/>group, or entire server](../user/admin_area/email_from_gitlab.md) | **{check-circle}** Yes | **{dotted-circle}** No | **{dotted-circle}** No | Email groups of users based on project or group membership, or email everyone using the GitLab instance. These emails are great for scheduled maintenance or upgrades. | -| [Enforce ToS acceptance](../user/admin_area/settings/terms.md) | **{check-circle}** Yes | **{dotted-circle}** No | **{dotted-circle}** No | Enforce your users accepting new terms of service by blocking GitLab traffic. | +| [Email all users of a project,<br/>group, or entire server](email_from_gitlab.md) | **{check-circle}** Yes | **{dotted-circle}** No | **{dotted-circle}** No | Email groups of users based on project or group membership, or email everyone using the GitLab instance. These emails are great for scheduled maintenance or upgrades. | +| [Enforce ToS acceptance](settings/terms.md) | **{check-circle}** Yes | **{dotted-circle}** No | **{dotted-circle}** No | Enforce your users accepting new terms of service by blocking GitLab traffic. | | [External Status Checks](../user/project/merge_requests/status_checks.md) | **{dotted-circle}** No | **{dotted-circle}** No | **{check-circle}** Yes | Interface with third-party systems you already use during development to ensure you remain compliant. | | [Generate reports on permission<br/>levels of users](../administration/admin_area.md#user-permission-export) | **{check-circle}** Yes | **{dotted-circle}** No | **{dotted-circle}** No | Generate a report listing all users' access permissions for groups and projects in the instance. | | [License compliance](../user/compliance/license_compliance/index.md) | **{dotted-circle}** No | **{dotted-circle}** No | **{check-circle}** Yes | Search dependencies for their licenses. This lets you determine if the licenses of your project's dependencies are compatible with your project's license. | diff --git a/doc/administration/configure.md b/doc/administration/configure.md index 72ee7c3da77..8ff2ae5aa9d 100644 --- a/doc/administration/configure.md +++ b/doc/administration/configure.md @@ -35,7 +35,7 @@ Customize and configure your self-managed GitLab installation. - [Agent server for Kubernetes](../administration/clusters/kas.md) - [Server hooks](../administration/server_hooks.md) - [Terraform state](../administration/terraform_state.md) -- [Terraform limits](../user/admin_area/settings/terraform_limits.md) +- [Terraform limits](settings/terraform_limits.md) - [Packages](../administration/packages/index.md) - [Web terminals](../administration/integration/terminal.md) - [Wikis](../administration/wikis/index.md) diff --git a/doc/administration/docs_self_host.md b/doc/administration/docs_self_host.md index 43aa5f3d871..1eecc139d1f 100644 --- a/doc/administration/docs_self_host.md +++ b/doc/administration/docs_self_host.md @@ -173,9 +173,9 @@ documentation URL requests as needed. For example, if your GitLab version is 14.5: - The GitLab documentation URL becomes `http://0.0.0.0:4000/14.5/`. -- The link in GitLab displays as `<instance_url>/help/user/admin_area/settings/help_page#destination-requirements`. +- The link in GitLab displays as `<instance_url>/help/administration/settings/help_page#destination-requirements`. - When you select the link, you are redirected to -`http://0.0.0.0:4000/14.5/ee/user/admin_area/settings/help_page/#destination-requirements`. +`http://0.0.0.0:4000/14.5/ee/administration/settings/help_page/#destination-requirements`. To test the setting, in GitLab, select a **Learn more** link. For example: diff --git a/doc/administration/get_started.md b/doc/administration/get_started.md index bdc57754233..bf3d38657f8 100644 --- a/doc/administration/get_started.md +++ b/doc/administration/get_started.md @@ -85,7 +85,7 @@ While this isn't an exhaustive list, following these steps gives you a solid sta - Set up [email notification for unknown sign-ins](settings/sign_in_restrictions.md#email-notification-for-unknown-sign-ins). - Configure [user and IP rate limits](https://about.gitlab.com/blog/2020/05/20/gitlab-instance-security-best-practices/#user-and-ip-rate-limits). - Limit [webhooks local access](https://about.gitlab.com/blog/2020/05/20/gitlab-instance-security-best-practices/#webhooks). -- Set [rate limits for protected paths](../user/admin_area/settings/protected_paths.md). +- Set [rate limits for protected paths](settings/protected_paths.md). - Sign up for [Security Alerts](https://about.gitlab.com/company/preference-center/) from the Communication Preference Center. - Keep track of security best practices on our [blog page](https://about.gitlab.com/blog/2020/05/20/gitlab-instance-security-best-practices/). @@ -236,10 +236,10 @@ Rate limits also improve the security of your application. You can make changes to your default rate limits from the Admin Area. For more information about configuration, see the [Admin Area page](../security/rate_limits.md#configurable-limits). -- Define [issues rate limits](../user/admin_area/settings/rate_limit_on_issues_creation.md) to set a maximum number of issue creation requests per minute, per user. -- Enforce [user and IP rate limits](../user/admin_area/settings/user_and_ip_rate_limits.md) for unauthenticated web requests. -- Review the [rate limit on raw endpoints](../user/admin_area/settings/rate_limits_on_raw_endpoints.md). The default setting is 300 requests per minute for raw file access. -- Review the [import/export rate limits](../user/admin_area/settings/import_export_rate_limits.md) of the six active defaults. +- Define [issues rate limits](settings/rate_limit_on_issues_creation.md) to set a maximum number of issue creation requests per minute, per user. +- Enforce [user and IP rate limits](settings/user_and_ip_rate_limits.md) for unauthenticated web requests. +- Review the [rate limit on raw endpoints](settings/rate_limits_on_raw_endpoints.md). The default setting is 300 requests per minute for raw file access. +- Review the [import/export rate limits](settings/import_export_rate_limits.md) of the six active defaults. For more information about API and rate limits, see our [API page](../api/rest/index.md). diff --git a/doc/administration/gitaly/troubleshooting.md b/doc/administration/gitaly/troubleshooting.md index afef787e9c3..3d8110e1dab 100644 --- a/doc/administration/gitaly/troubleshooting.md +++ b/doc/administration/gitaly/troubleshooting.md @@ -12,7 +12,7 @@ Refer to the information below when troubleshooting Gitaly and Gitaly Cluster. The following sections provide possible solutions to Gitaly errors. -See also [Gitaly timeout](../../user/admin_area/settings/gitaly_timeouts.md) settings, +See also [Gitaly timeout](../settings/gitaly_timeouts.md) settings, and our advice on [parsing the `gitaly/current` file](../logs/log_parsing.md#parsing-gitalycurrent). ### Check versions when using standalone Gitaly servers diff --git a/doc/administration/instance_limits.md b/doc/administration/instance_limits.md index 81caf0ed62c..679042c3114 100644 --- a/doc/administration/instance_limits.md +++ b/doc/administration/instance_limits.md @@ -21,7 +21,7 @@ Read more about [configuring rate limits](../security/rate_limits.md). This setting limits the request rate to the issue creation endpoint. -Read more about [issue creation rate limits](../user/admin_area/settings/rate_limit_on_issues_creation.md). +Read more about [issue creation rate limits](settings/rate_limit_on_issues_creation.md). - **Default rate limit**: Disabled by default. @@ -29,7 +29,7 @@ Read more about [issue creation rate limits](../user/admin_area/settings/rate_li This setting limits the request rate per user or IP. -Read more about [User and IP rate limits](../user/admin_area/settings/user_and_ip_rate_limits.md). +Read more about [User and IP rate limits](settings/user_and_ip_rate_limits.md). - **Default rate limit**: Disabled by default. @@ -37,7 +37,7 @@ Read more about [User and IP rate limits](../user/admin_area/settings/user_and_i This setting limits the request rate per endpoint. -Read more about [raw endpoint rate limits](../user/admin_area/settings/rate_limits_on_raw_endpoints.md). +Read more about [raw endpoint rate limits](settings/rate_limits_on_raw_endpoints.md). - **Default rate limit**: 300 requests per project, per commit and per file path. @@ -59,14 +59,14 @@ GitLab rate limits the following paths by default: '/admin/session' ``` -Read more about [protected path rate limits](../user/admin_area/settings/protected_paths.md). +Read more about [protected path rate limits](settings/protected_paths.md). - **Default rate limit**: After 10 requests, the client must wait 60 seconds before trying again. ### Package Registry This setting limits the request rate on the Packages API per user or IP. For more information, see -[Package Registry Rate Limits](../user/admin_area/settings/package_registry_rate_limits.md). +[Package Registry Rate Limits](settings/package_registry_rate_limits.md). - **Default rate limit**: Disabled by default. @@ -86,7 +86,7 @@ requests per user. For more information, read > - [Generally available](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/75918) in GitLab 14.6. [Feature flag `files_api_throttling`](https://gitlab.com/gitlab-org/gitlab/-/issues/338903) removed. This setting limits the request rate on the Packages API per user or IP address. For more information, read -[Files API rate limits](../user/admin_area/settings/files_api_rate_limits.md). +[Files API rate limits](settings/files_api_rate_limits.md). - **Default rate limit**: Disabled by default. @@ -95,7 +95,7 @@ This setting limits the request rate on the Packages API per user or IP address. > [Introduced](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/68645) in GitLab 14.4. This setting limits the request rate on deprecated API endpoints per user or IP address. For more information, read -[Deprecated API rate limits](../user/admin_area/settings/deprecated_api_rate_limits.md). +[Deprecated API rate limits](settings/deprecated_api_rate_limits.md). - **Default rate limit**: Disabled by default. @@ -112,7 +112,7 @@ This setting limits the import/export actions for groups and projects. | Group Export | 6 | | Group Export Download | 1 | -Read more about [import/export rate limits](../user/admin_area/settings/import_export_rate_limits.md). +Read more about [import/export rate limits](settings/import_export_rate_limits.md). ### Member Invitations @@ -171,7 +171,7 @@ This endpoint has been requested too many times. Try again later. This setting limits the request rate to the pipeline creation endpoints. -Read more about [pipeline creation rate limits](../user/admin_area/settings/rate_limit_on_pipelines_creation.md). +Read more about [pipeline creation rate limits](settings/rate_limit_on_pipelines_creation.md). ## Gitaly concurrency limit @@ -800,7 +800,7 @@ Plan.default.actual_limits.update!(dotenv_size: 5.kilobytes) This setting limits the number of inbound alert payloads over a period of time. -Read more about [incident management rate limits](../user/admin_area/settings/rate_limit_on_pipelines_creation.md). +Read more about [incident management rate limits](settings/rate_limit_on_pipelines_creation.md). ### Prometheus Alert JSON payloads @@ -945,7 +945,7 @@ More information can be found in these documentations: Total number of changes (branches or tags) in a single push to determine whether individual push events or a bulk push event are created. -More information can be found in the [Push event activities limit and bulk push events documentation](../user/admin_area/settings/push_event_activities_limit.md). +More information can be found in the [Push event activities limit and bulk push events documentation](settings/push_event_activities_limit.md). ## Package Registry Limits diff --git a/doc/administration/logs/index.md b/doc/administration/logs/index.md index 28d4a4eedc9..449f33fbbef 100644 --- a/doc/administration/logs/index.md +++ b/doc/administration/logs/index.md @@ -754,8 +754,8 @@ This file is located at: This log records: -- Requests over the [Rate Limit](../../user/admin_area/settings/rate_limits_on_raw_endpoints.md) on raw endpoints. -- [Protected paths](../../user/admin_area/settings/protected_paths.md) abusive requests. +- Requests over the [Rate Limit](../settings/rate_limits_on_raw_endpoints.md) on raw endpoints. +- [Protected paths](../settings/protected_paths.md) abusive requests. - In GitLab versions [12.3](https://gitlab.com/gitlab-org/gitlab/-/issues/29239) and later, user ID and username, if available. diff --git a/doc/administration/packages/index.md b/doc/administration/packages/index.md index b735204c323..77730384623 100644 --- a/doc/administration/packages/index.md +++ b/doc/administration/packages/index.md @@ -55,7 +55,7 @@ guides you through the process. When downloading packages as dependencies in downstream projects, many requests are made through the Packages API. You may therefore reach enforced user and IP rate limits. To address this issue, you -can define specific rate limits for the Packages API. For more details, see [Package Registry Rate Limits](../../user/admin_area/settings/package_registry_rate_limits.md). +can define specific rate limits for the Packages API. For more details, see [Package Registry Rate Limits](../settings/package_registry_rate_limits.md). ## Enable or disable the Package Registry diff --git a/doc/administration/redis/replication_and_failover.md b/doc/administration/redis/replication_and_failover.md index 4a6f58a8d6a..1db5b82e7dc 100644 --- a/doc/administration/redis/replication_and_failover.md +++ b/doc/administration/redis/replication_and_failover.md @@ -659,7 +659,7 @@ persistence classes. | `shared_state` | Store session-related and other persistent data. | | `actioncable` | Pub/Sub queue backend for ActionCable. | | `trace_chunks` | Store [CI trace chunks](../job_logs.md#enable-or-disable-incremental-logging) data. | -| `rate_limiting` | Store [rate limiting](../../user/admin_area/settings/user_and_ip_rate_limits.md) state. | +| `rate_limiting` | Store [rate limiting](../settings/user_and_ip_rate_limits.md) state. | | `sessions` | Store [sessions](../../../ee/development/session.md#gitlabsession). | | `repository_cache` | Store cache data specific to repositories. | diff --git a/doc/administration/settings/deprecated_api_rate_limits.md b/doc/administration/settings/deprecated_api_rate_limits.md index 40d8d704722..f8db0810af5 100644 --- a/doc/administration/settings/deprecated_api_rate_limits.md +++ b/doc/administration/settings/deprecated_api_rate_limits.md @@ -51,4 +51,4 @@ To override the general user and IP rate limits for requests to deprecated API e ## Related topics - [Rate limits](../../security/rate_limits.md) -- [User and IP rate limits](../../user/admin_area/settings/user_and_ip_rate_limits.md) +- [User and IP rate limits](../settings/user_and_ip_rate_limits.md) diff --git a/doc/ci/yaml/signing_examples.md b/doc/ci/yaml/signing_examples.md index 8aec404502e..5609bd2374e 100644 --- a/doc/ci/yaml/signing_examples.md +++ b/doc/ci/yaml/signing_examples.md @@ -70,7 +70,7 @@ verify: - apk add --update cosign docker - docker login -u "$CI_REGISTRY_USER" -p "$CI_REGISTRY_PASSWORD" $CI_REGISTRY script: - - cosign verify "$CI_REGISTRY_IMAGE:$CI_COMMIT_SHORT_SHA" --certificate-identity "https://gitlab.com/my-group/my-project@refs/heads/main" --certificate-oidc-issuer "https://gitlab.com" + - cosign verify "$CI_REGISTRY_IMAGE:$CI_COMMIT_SHORT_SHA" --certificate-identity "https://gitlab.com/my-group/my-project//path/to/.gitlab-ci.yml@refs/heads/main" --certificate-oidc-issuer "https://gitlab.com" ``` ## Use Sigstore and npm to generate keyless provenance @@ -306,5 +306,5 @@ verify_artifact: before_script: - apk add --update cosign script: - - cosign verify-blob artifact.txt --bundle cosign.bundle --certificate-identity "https://gitlab.com/my-group/my-project@refs/heads/main" --certificate-oidc-issuer "https://gitlab.com" + - cosign verify-blob artifact.txt --bundle cosign.bundle --certificate-identity "https://gitlab.com/my-group/my-project//path/to/.gitlab-ci.yml@refs/heads/main" --certificate-oidc-issuer "https://gitlab.com" ``` diff --git a/doc/development/fe_guide/index.md b/doc/development/fe_guide/index.md index b5ecc000da1..8675866fce6 100644 --- a/doc/development/fe_guide/index.md +++ b/doc/development/fe_guide/index.md @@ -77,7 +77,11 @@ Now that our values have been defined, we can base our goals on these values and - Improve our pipelines speed - Build a better set of shared components with documentation -## Browser Support +### Frontend onboarding course + +The [Frontend onboarding course](onboarding_course/index.md) provides a 6-week structured curriculum to learn how to contribute to the GitLab frontend. + +### Browser Support For supported browsers, see our [requirements](../../install/requirements.md#supported-web-browsers). diff --git a/doc/development/fe_guide/onboarding_course/index.md b/doc/development/fe_guide/onboarding_course/index.md new file mode 100644 index 00000000000..0b0ffc69f1b --- /dev/null +++ b/doc/development/fe_guide/onboarding_course/index.md @@ -0,0 +1,64 @@ +--- +stage: Manage +group: Foundations +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments +--- + +# Frontend onboarding course + +Welcome to the Frontend Onboarding Course at GitLab! +In this course, we walk you through your first professional frontend development experience, helping you gain real world skills and learn how to contribute to a large-scale codebase effectively. + +Throughout the course, we'll follow a structured approach. +Each lesson focuses on solving a specific problem on GitLab, giving you hands-on experience. +You'll learn theory that you can immediately put into practice. +By working on real-world GitLab issues, you'll encounter challenges and learn how to navigate the codebase effectively while at the same time improving GitLab the product. + +We believe in an interactive learning experience. +You'll have the opportunity to ask questions and seek help from the GitLab community. +We appreciate your contributions and are here to support your learning while at the same time making GitLab better. + +Our teaching style prioritizes practical learning. +Lessons include an introduction to the problem, theory, live coding walkthroughs, and similar issues for you to tackle. +As you progress, the complexity of the tasks increase, helping you grow your skills. + +Join us on this journey of front-end development at GitLab. Say hello in [the Discord community](https://discord.gg/gitlab) and let's learn and improve together. + +## Lessons + +- [Lesson 1](lesson_1.md) + +## Structure and timings + +The course is run over 6 weeks, with a required time commitment of 5-10 hours per week. + +The course is free of charge, but we do ask for a commitment to complete the curriculum (including 10 merged merge requests). + +After completing the course, you receive a certificate and GitLab achievement. + +Each week consists of the following sessions: + +- 1-hour relaxed discussion-style lesson with explanation of how GitLab frontend works. Each week features a different guest and includes an AMA portion. +- 2-hour live coding lesson with a practical task for participants to complete. +- 2 x 2-hour dedicated “Office Hours” sessions where participants can work on the task assigned in the lesson with GitLab frontend engineers. (2 sessions in different timezones as this will require participants to join synchronously) + +A fortnightly 1-on-1 mentoring sessions are also available to each participant. + +There are 10 places available on the course. +The date will be set after the course material has been prepared. +Please complete the [Frontend Onboarding Course Application Form](https://forms.gle/39Rs4w4ZxQuByhE4A) to apply. + +You may also participate in the course informally at your own pace, without the benefit of the synchronous office hours or mentoring session. +GitLab team members are happy to support you regardless. + +## Curriculum summary + +### Lesson 1 + +- What is a development environment? + - What is the GDK? + - Installing the GDK. + - GDK tips and tricks. + - Using GitPod to run the GDK. +- Navigating the GitLab codebase. +- Writing a good merge request. diff --git a/doc/development/fe_guide/onboarding_course/lesson_1.md b/doc/development/fe_guide/onboarding_course/lesson_1.md new file mode 100644 index 00000000000..e82d350f854 --- /dev/null +++ b/doc/development/fe_guide/onboarding_course/lesson_1.md @@ -0,0 +1,183 @@ +--- +stage: manage +group: foundations +info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/product/ux/technical-writing/#assignments +--- + +# Lesson 1 + +<div class="video-fallback"> + See the video: <a href="https://www.youtube.com/watch?v=k4C3-FKvZyI">Lesson 1 intro</a>. +</div> +<figure class="video-container"> + <iframe src="https://www.youtube-nocookie.com/embed/k4C3-FKvZyI" frameborder="0" allowfullscreen> </iframe> +</figure> + +In this lesson you tackle the smallest of problems - a one-character text change. To do so, we have to learn: + +- How to set up a GitLab Development Environment. +- How to navigate the GitLab code base. +- How to create a merge request in the GitLab project. + +After we have learned these 3 things, a GitLab team member will do a live coding demo. +In the demo, they'll use each of the things learned by completing one of these small issues, so that you can complete an issue by yourself. + +There is a list of issues that are very similar to the one we'll be live coding [here in the "Linked items" section](https://gitlab.com/gitlab-org/gitlab/-/issues/389920), it would be worth commenting on one of these now to get yourself assigned to one so that you can follow along. + +## What is the GDK? + +<div class="video-fallback"> + See the video: <a href="https://www.youtube.com/watch?v=qXGXshfo934">What is the GDK</a>? +</div> +<figure class="video-container"> + <iframe src="https://www.youtube-nocookie.com/embed/qXGXshfo934" frameborder="0" allowfullscreen> </iframe> +</figure> + +The GDK (GitLab Development Kit) is a local instance of GitLab that allows developers to run and test GitLab on their own computers. +Unlike frontend only applications, the GDK runs the entire GitLab application, including the back-end services, APIs, and a local database. +This allows developers to make changes, test them in real-time, and validate their modifications. + +Tips for using the GDK: + +- Troubleshooting documentation: When encountering issues with the GDK, refer to the troubleshooting documentation in the [GDK repository](https://gitlab.com/gitlab-org/gitlab-development-kit/-/tree/main/doc/troubleshooting). + These resources provide useful commands and tips to help resolve common problems. +- Using the Rails console: The Rails console is an essential tool for interacting with your local instance of GitLab. + You can access it by running `gdk rails c` and use it to enable or disable feature flags, perform backend operations, and more. +- Stay updated: Regularly update your GDK by running `gdk update`. + This command fetches the latest branch of the GitLab project, as well as the latest branch of the GDK and its dependencies. + Keeping your GDK up to date helps ensure you will be working with the latest version of GitLab and make sure you have the latest bug fixes. + +Remember, if you need further assistance or have specific questions, you can reach out to the GitLab community through our [Discord](https://discord.gg/gitlab) or [other available support channels](https://about.gitlab.com/community/contribute/). + +## Installing and using the GDK locally + +<div class="video-fallback"> + See the video: <a href="https://www.youtube.com/watch?v=fcOyjuCizmY">Installing the GDK</a>. +</div> +<figure class="video-container"> + <iframe src="https://www.youtube-nocookie.com/embed/fcOyjuCizmY" frameborder="0" allowfullscreen> </iframe> +</figure> + +For the latest installation instructions, refer to the [GitLab Development Kit documentation](https://gitlab.com/gitlab-org/gitlab-development-kit#installation). + +Here's a step-by-step summary: + +1. Prerequisites: + - 16 GB RAM. If you have less, consider [using Gitpod](#using-gitpod-instead-of-running-the-gdk-locally) + - Ensure that Git is installed on your machine. + - Install a code editor, such as Visual Studio Code. + - [Create an account](https://gitlab.com/users/sign_up) or [sign in](https://gitlab.com/users/sign_in) on GitLab.com and join the [community members group](https://gitlab.com/gitlab-community/meta#request-access-to-community-forks). +1. Installation: + - Choose a directory to install the GitLab Development Kit (GDK). + - Open your terminal and navigate to the chosen directory. + - Download and run the installation script from the terminal: + + ```shell + curl "https://gitlab.com/gitlab-org/gitlab-development-kit/-/raw/main/support/install" | bash + ``` + + - Only run scripts from trusted sources to ensure your safety. + - The installation process may take around 20 minutes or more. +1. Choosing the repository: + - Instead of cloning the main GitLab repository, use the community fork recommended for wider community members. + - Follow the instructions provided to install the community fork. +1. GDK structure: + - After the installation, the GDK directory is created. + - Inside the GDK directory, you'll find the GitLab project folder. +1. Working with the GDK: + - GDK offers lots of commands you can use to interact with your installation. To run those commands you must be inside the GDK or GitLab folder. + - To start the GDK, run the command `gdk start` in your terminal. + - You can explore available commands and options by running `gdk help` in the terminal. + +Remember to consult the documentation or seek community support if you have any further questions or issues. + +## Using Gitpod instead of running the GDK locally + +<div class="video-fallback"> + See the video: <a href="https://www.youtube.com/watch?v=RI2kM5_oii4">Using Gitpod with GitLab</a>. +</div> +<figure class="video-container"> + <iframe src="https://www.youtube-nocookie.com/embed/RI2kM5_oii4" frameborder="0" allowfullscreen> </iframe> +</figure> + +Gitpod is a service that allows you to run a virtual machine, specifically the GitLab Development Kit (GDK), on the Gitpod server instead of running it on your own machine. +It provides a web-based Integrated Development Environment (IDE) where you can edit code and see the GDK in action. +Gitpod is useful for quickly getting a GDK environment up and running, for making small merge requests without installing the GDK locally, or for running GDK on a machine that may not have enough resources. + +To use Gitpod: + +1. Go to the [GitLab community fork website](https://gitlab.com/gitlab-community/gitlab), select **Edit**, then select **Gitpod**. +1. Configure your settings, such as the editor (VS Code desktop or browser) and the context (usually the `main` or `master` branch). +1. Select **Open** to create your Gitpod workspace. This process may take up to 20 minutes. The GitLab Development Kit (GDK) will be installed in the Gitpod workspace. This installation is faster than downloading and installing the full GDK locally. + +After the workspace is created, you'll find your chosen IDE running in your browser. You can also connect it to your desktop IDE if preferred. +Treat Gitpod just like you would use VS Code locally. Create branches, make code changes, commit them, and push them back to the community fork. + +Other tips: + +- Remember to push your code regularly to avoid the workspace timing out. Idle workspaces are eventually destroyed. +- Customize your Gitpod workspace settings if needed, such as making your instance of GitLab frontend publicly available. +- If you run out of minutes, contact the support team on the Discord server. +- Troubleshoot issues by using commands like `gdk start` and `gdk status` in the Gitpod workspace as you would if it was running locally. + +By following these steps, you can leverage Gitpod to efficiently develop with the GitLab Development Kit without the need for local installation. + +## Navigating the GitLab codebase + +<div class="video-fallback"> + See the video: <a href="https://www.youtube.com/watch?v=Wc5u879_0Aw">How to navigate the GitLab codebase</a>. +</div> +<figure class="video-container"> + <iframe src="https://www.youtube-nocookie.com/embed/Wc5u879_0Aw" frameborder="0" allowfullscreen> </iframe> +</figure> + +Understanding how to navigate the GitLab codebase is essential for contributors. +Navigating the codebase and locating specific files can be challenging but crucial for making changes and addressing issues effectively. +Here we'll explore a step-by-step process for finding files and finding where they are rendered in GitLab. + +If you already know the file you are going to work on and now you want to find where it is rendered: + +1. Start by gathering clues to understand the file’s purpose. Look for relevant information within the file itself, such as keywords or specific content that might indicate its context. +1. You can also examine the file path (or folder structure) to gain insights into where the file might be rendered. + A lot of routing in GitLab is very similar to the folder structure. +1. If you can work out which feature (or one of the features) that this component is used in, you can then leverage the GitLab user documentation to find out how to navigate to the feature page. +1. Follow the component hierarchy, do a global search for the file name to identify the parent component that renders the component. + Continue to follow the hierarchy of components to trace back to a feature you recognize or can search for in the GitLab user docs. +1. You can use `git blame` with an extension like GitLens to find a recent MR where this file was changed. + Most MR’s have a "How to validate" section that you can follow, if the MR doesn't have one, look for the previous change and until you find one that have validation steps. + +If you know which page you need to fix and you want to find the file path, here are some things you can try: + +- Look for content that is unique and doesn’t contain variables so that you can search for the translation variable. +- Try using Vue Dev Tools to find the component name. +- Look for unique identifiers like a `data-testid`,`id` or a unique looking CSS class in the HTML of the component and then search globally the codebase for those identifying strings. + +## Writing a good merge request + +<div class="video-fallback"> + See the video: <a href="https://www.youtube.com/watch?v=H5zozDNIn98">How to write a good MR</a>. +</div> +<figure class="video-container"> + <iframe src="https://www.youtube-nocookie.com/embed/H5zozDNIn98" frameborder="0" allowfullscreen> </iframe> +</figure> + +When writing a merge request there are some important things to be aware of: + +- Your MR will become a permanent part of the documentation of the GitLab project. + It may be used in the future to help people understand why some code works the way it does and why it doesn't use an alternative solution. +- At least 2 other engineers are going to review your code. For the sake of efficiency (much like the code itself you have written) it is best to take a little while longer to get your MR right so that it is quicker and easier for others to read. +- The MRs that you create on GitLab are available to the public. This means you can add a link to MRs you are particularly proud of to your portfolio page when looking for a job. +- Since an MR is a technical document, you should try to implement a technical writing style. + If you don’t know what that is, here is a highly recommended short course from [Google on Technical writing](https://developers.google.com/tech-writing/one). + If you are also contributing to the documentation at GitLab, there is a [Technical Writing Fundamentals course available here from GitLab](https://about.gitlab.com/handbook/product/ux/technical-writing/fundamentals/). + +## Live coding + +<div class="video-fallback"> + See the video: <a href="https://www.youtube.com/watch?v=BJCCwc1Czt4">Lesson 1 code walkthrough</a>. +</div> +<figure class="video-container"> + <iframe src="https://www.youtube-nocookie.com/embed/BJCCwc1Czt4" frameborder="0" allowfullscreen> </iframe> +</figure> + +Now it is your turn to complete your first MR, there is a list of issues that are very similar to the one we just finished that need completing [here in the "Linked items" section](https://gitlab.com/gitlab-org/gitlab/-/issues/389920). Thanks for contributing! (if there are none left, let us know on [Discord](https://discord.gg/gitlab) or [other available support channels](https://about.gitlab.com/community/contribute/) and we'll find more for you) diff --git a/doc/user/asciidoc.md b/doc/user/asciidoc.md index f04fece7b76..d2041083d36 100644 --- a/doc/user/asciidoc.md +++ b/doc/user/asciidoc.md @@ -411,7 +411,7 @@ Color written inside backticks is followed by a color "chip": ### Equations and Formulas (STEM) -If you need to include Science, Technology, Engineering and Math (STEM) +If you need to include Science, Technology, Engineering, and Math (STEM) expressions, set the `stem` attribute in the document's header to `latexmath`. Equations and formulas are rendered using [KaTeX](https://katex.org/): diff --git a/doc/user/product_analytics/index.md b/doc/user/product_analytics/index.md index 0446f720430..e04c61b2c00 100644 --- a/doc/user/product_analytics/index.md +++ b/doc/user/product_analytics/index.md @@ -125,6 +125,29 @@ The `cube_analytics` data type connects to the Cube instance defined when [produ All filters and queries are sent to the Cube instance and the returned data is processed by the product analytics data source to be rendered by the appropriate visualizations. +### Filling missing data + +- Introduced in GitLab 16.3 behind the [feature flag](../../administration/feature_flags.md) named `product_analytics_dashboards`. Disabled by default. + +When [exporting data](#raw-data-export) or [viewing dashboards](../analytics/analytics_dashboards.md#view-project-dashboards), +if there is no data for a given day, the missing data is autofilled with `0`. + +This approach has the following benefits: + +- The visualization's day axis matches the selected date range, removing ambiguity about missing data. +- Data exports have rows for the entire date range, making data analysis easier. + +However, this approach also has the following limitations: + +- The `day` [granularity](https://cube.dev/docs/product/apis-integrations/rest-api/query-format) must be used. + All other granularities are not supported at this time. +- It only fills a date range defined by the [`inDateRange`](https://cube.dev/docs/product/apis-integrations/rest-api/query-format#indaterange) filter. + - The date selector in the UI already uses this filter. +- The filling of data ignores the query-defined limit. If you set a limit of 10 data points over 20 days, it + returns 20 data points, with the missing data filled by `0`. + +[Issue 417231](https://gitlab.com/gitlab-org/gitlab/-/issues/417231) proposes a solution to this limitation. + ## Funnel analysis Use funnel analysis to understand the flow of users through your application, and where diff --git a/doc/user/project/repository/code_suggestions.md b/doc/user/project/repository/code_suggestions.md index 7976b0a9dea..95d5873a535 100644 --- a/doc/user/project/repository/code_suggestions.md +++ b/doc/user/project/repository/code_suggestions.md @@ -291,7 +291,7 @@ To confirm that your account is enabled, go to [https://gitlab.com/api/v4/ml/ai- #### Code Suggestions not displayed in VS Code or GitLab WebIDE -Check all steps above first. +Check all the steps in [Code Suggestions aren't displayed](#code-suggestions-arent-displayed) first. If you are a self-managed user, ensure that Code Suggestions for the [GitLab WebIDE](../../project/web_ide/index.md) are enabled. The same settings apply to VS Code as local IDE. @@ -303,7 +303,7 @@ If you are a self-managed user, ensure that Code Suggestions for the [GitLab Web If the settings are enabled, but Code Suggestions are still not displayed, try the following steps: 1. Enable the `Debug` checkbox in the GitLab Workflow **Extension Settings**. -1. Open the extension log in **View > Output** and change the dropdown to **GitLab Workflow** as log filter. The command palette command is `GitLab: Show Extension Logs`. +1. Open the extension log in **View > Output** and change the dropdown list to **GitLab Workflow** as the log filter. The command palette command is `GitLab: Show Extension Logs`. 1. Disable and re-enable the **Enable code completion (Beta)** checkbox. 1. Verify that the debug log contains similar output: @@ -313,6 +313,21 @@ If the settings are enabled, but Code Suggestions are still not displayed, try t 2023-07-14T17:29:01:802 [debug]: AI Assist: Using server: https://codesuggestions.gitlab.com/v2/completions ``` +#### Code Suggestions not displayed in Microsoft Visual Studio + +Check all the steps in [Code Suggestions aren't displayed](#code-suggestions-arent-displayed) first. + +1. Ensure you have properly [set up the extension](https://gitlab.com/gitlab-org/editor-extensions/gitlab-visual-studio-extension#setup). +1. From the **Tools > Options** menu, find the **GitLab** option. Ensure **Log Level** is set to **Debug**. +1. Open the extension log in **View > Output** and change the dropdown list to **GitLab Extension** as the log filter. +1. Verify that the debug log contains similar output: + +```shell +14:48:21:344 GitlabProposalSource.GetCodeSuggestionAsync +14:48:21:344 LsClient.SendTextDocumentCompletionAsync("GitLab.Extension.Test\TestData.cs", 34, 0) +14:48:21:346 LS(55096): time="2023-07-17T14:48:21-05:00" level=info msg="update context" +``` + ### Authentication troubleshooting If the above steps do not solve your issue, the problem may be related to the recent changes in authentication, |