diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2021-08-09 09:10:01 +0300 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2021-08-09 09:10:01 +0300 |
commit | 4b8939db3d80469826a62f1409b921f96dac2498 (patch) | |
tree | 7a3a0a8dab9b45c1c8071a0717267d87d4b01ee8 /doc/user | |
parent | 53f7c2edf478dac9e6b8e52c4b9a59c53659eb31 (diff) |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/user')
-rw-r--r-- | doc/user/admin_area/license.md | 2 | ||||
-rw-r--r-- | doc/user/application_security/dast/browser_based.md | 8 | ||||
-rw-r--r-- | doc/user/infrastructure/clusters/manage/management_project_applications/apparmor.md | 6 | ||||
-rw-r--r-- | doc/user/infrastructure/clusters/manage/management_project_applications/ingress.md | 2 | ||||
-rw-r--r-- | doc/user/infrastructure/clusters/manage/management_project_applications/sentry.md | 2 | ||||
-rw-r--r-- | doc/user/infrastructure/iac/index.md | 2 | ||||
-rw-r--r-- | doc/user/markdown.md | 2 | ||||
-rw-r--r-- | doc/user/project/issue_board.md | 2 | ||||
-rw-r--r-- | doc/user/project/settings/project_access_tokens.md | 12 | ||||
-rw-r--r-- | doc/user/search/advanced_search.md | 6 | ||||
-rw-r--r-- | doc/user/workspace/img/hardware_settings.png | bin | 0 -> 76085 bytes | |||
-rw-r--r-- | doc/user/workspace/index.md | 13 |
12 files changed, 37 insertions, 20 deletions
diff --git a/doc/user/admin_area/license.md b/doc/user/admin_area/license.md index db2db4a0e68..15af1a09a62 100644 --- a/doc/user/admin_area/license.md +++ b/doc/user/admin_area/license.md @@ -30,7 +30,7 @@ To begin the activation process with your activation code: ## Activate GitLab EE with a License File **(PREMIUM SELF)** -If you receive a license file from GitLab (for example a new trial), you can upload it by signing into your GitLab instance as an admin or adding it during installation. The license is a base64-encoded ASCII text file with a `.gitlab-license` extension. +If you receive a license file from GitLab (for example a new trial), you can upload it by signing into your GitLab instance as an admin or adding it during installation. The license is a base64-encoded ASCII text file with a `.gitlab-license` extension. ## Uploading your license diff --git a/doc/user/application_security/dast/browser_based.md b/doc/user/application_security/dast/browser_based.md index 39df1000289..e8fbc17327c 100644 --- a/doc/user/application_security/dast/browser_based.md +++ b/doc/user/application_security/dast/browser_based.md @@ -98,17 +98,17 @@ You can manage the trade-off between coverage and scan time with the following m Due to poor network conditions or heavy application load, the default timeouts may not be applicable to your application. -Browser-based scans offer the ability to adjust various timeouts to ensure it continues smoothly as it transitions from one page to the next. These values are configured using a [Duration string](https://golang.org/pkg/time/#ParseDuration) which allow you to configure durations with a prefix: `m` for minutes, `s` for seconds, and `ms` for milliseconds. +Browser-based scans offer the ability to adjust various timeouts to ensure it continues smoothly as it transitions from one page to the next. These values are configured using a [Duration string](https://golang.org/pkg/time/#ParseDuration) which allow you to configure durations with a prefix: `m` for minutes, `s` for seconds, and `ms` for milliseconds. -Navigations, or the act of loading a new page, usually require the most amount of time as they are -loading multiple new resources such as JavaScript or CSS files. Depending on the size of these resources, or the speed at which they are returned, the default `DAST_BROWSER_NAVIGATION_TIMEOUT` may not be sufficient. +Navigations, or the act of loading a new page, usually require the most amount of time as they are +loading multiple new resources such as JavaScript or CSS files. Depending on the size of these resources, or the speed at which they are returned, the default `DAST_BROWSER_NAVIGATION_TIMEOUT` may not be sufficient. Stability timeouts, such as those configurable with `DAST_BROWSER_NAVIGATION_STABILITY_TIMEOUT`, `DAST_BROWSER_STABILITY_TIMEOUT`, and `DAST_BROWSER_ACTION_STABILITY_TIMEOUT` can also be configured. Stability timeouts determine when browser-based scans consider a page fully loaded. Browser-based scans consider a page loaded when: 1. The [DOMContentLoaded](https://developer.mozilla.org/en-US/docs/Web/API/Window/DOMContentLoaded_event) event has fired. 1. There are no open or outstanding requests that are deemed important, such as JavaScript and CSS. Media files are usually deemed unimportant. -1. Depending on whether the browser executed a navigation, was forcibly transitioned, or action: +1. Depending on whether the browser executed a navigation, was forcibly transitioned, or action: - There are no new Document Object Model (DOM) modification events after the `DAST_BROWSER_NAVIGATION_STABILITY_TIMEOUT`, `DAST_BROWSER_STABILITY_TIMEOUT` or `DAST_BROWSER_ACTION_STABILITY_TIMEOUT` durations diff --git a/doc/user/infrastructure/clusters/manage/management_project_applications/apparmor.md b/doc/user/infrastructure/clusters/manage/management_project_applications/apparmor.md index 021fab22274..7fbbbac866c 100644 --- a/doc/user/infrastructure/clusters/manage/management_project_applications/apparmor.md +++ b/doc/user/infrastructure/clusters/manage/management_project_applications/apparmor.md @@ -8,8 +8,8 @@ info: To determine the technical writer assigned to the Stage/Group associated w > [Introduced](https://gitlab.com/gitlab-org/project-templates/cluster-management/-/merge_requests/5) in GitLab 14.0. -Assuming you already have a [Cluster management project](../../../../../user/clusters/management_project.md) created from a -[management project template](../../../../../user/clusters/management_project_template.md), to install AppArmor you should +Assuming you already have a [Cluster management project](../../../../../user/clusters/management_project.md) created from a +[management project template](../../../../../user/clusters/management_project_template.md), to install AppArmor you should uncomment this line from your `helmfile.yaml`: ```yaml @@ -27,4 +27,4 @@ profiles: } ``` -Refer to the [AppArmor chart](https://gitlab.com/gitlab-org/charts/apparmor) for more information on this chart. +Refer to the [AppArmor chart](https://gitlab.com/gitlab-org/charts/apparmor) for more information on this chart. diff --git a/doc/user/infrastructure/clusters/manage/management_project_applications/ingress.md b/doc/user/infrastructure/clusters/manage/management_project_applications/ingress.md index 0a2231cbf49..4f17dbab11b 100644 --- a/doc/user/infrastructure/clusters/manage/management_project_applications/ingress.md +++ b/doc/user/infrastructure/clusters/manage/management_project_applications/ingress.md @@ -28,4 +28,4 @@ for the available configuration options. Support for installing the Ingress managed application is provided by the GitLab Configure group. If you run into unknown issues, [open a new issue](https://gitlab.com/gitlab-org/gitlab/-/issues/new), and ping at least 2 people from the -[Configure group](https://about.gitlab.com/handbook/product/categories/#configure-group). +[Configure group](https://about.gitlab.com/handbook/product/categories/#configure-group). diff --git a/doc/user/infrastructure/clusters/manage/management_project_applications/sentry.md b/doc/user/infrastructure/clusters/manage/management_project_applications/sentry.md index 32eb4efdf45..1fe9b57cd4b 100644 --- a/doc/user/infrastructure/clusters/manage/management_project_applications/sentry.md +++ b/doc/user/infrastructure/clusters/manage/management_project_applications/sentry.md @@ -73,4 +73,4 @@ Support for installing the Sentry managed application is provided by the GitLab Health group. If you run into unknown issues, [open a new issue](https://gitlab.com/gitlab-org/gitlab/-/issues/new), and ping at least 2 people from the -[Health group](https://about.gitlab.com/handbook/product/categories/#health-group). +[Health group](https://about.gitlab.com/handbook/product/categories/#health-group). diff --git a/doc/user/infrastructure/iac/index.md b/doc/user/infrastructure/iac/index.md index bdcf1451420..2813b955a07 100644 --- a/doc/user/infrastructure/iac/index.md +++ b/doc/user/infrastructure/iac/index.md @@ -107,7 +107,7 @@ Learn how to [create a new cluster on Google Kubernetes Engine (GKE)](../cluster The GitLab Terraform provider can fail to detect existing `gitlab_group_share_group` resources due to the issue ["User with permissions cannot retrieve `share_with_groups` from the API"](https://gitlab.com/gitlab-org/gitlab/-/issues/328428). This results in an error when running `terraform apply` because Terraform attempts to recreate an -existing resource. +existing resource. For example, consider the following group/subgroup configuration: diff --git a/doc/user/markdown.md b/doc/user/markdown.md index b7c2ea75ba6..4149307c45a 100644 --- a/doc/user/markdown.md +++ b/doc/user/markdown.md @@ -511,7 +511,7 @@ This example links to `<wiki_root>/miscellaneous.md`: GitLab Flavored Markdown renders GitLab-specific references. For example, you can reference an issue, a commit, a team member, or even an entire project team. GitLab Flavored Markdown turns -that reference into a link so you can navigate between them. All references to projects should use the +that reference into a link so you can navigate between them. All references to projects should use the **project slug** rather than the project name. Additionally, GitLab Flavored Markdown recognizes certain cross-project references and also has a shorthand diff --git a/doc/user/project/issue_board.md b/doc/user/project/issue_board.md index 125cd13096d..0c624d7df01 100644 --- a/doc/user/project/issue_board.md +++ b/doc/user/project/issue_board.md @@ -383,7 +383,7 @@ To group issues by epic in an issue board: ![Epics Swimlanes](img/epics_swimlanes_v14_1.png) To edit an issue without leaving this view, select the issue card (not its title), and a sidebar -appears on the right. There you can see and edit the issue's: +appears on the right. There you can see and edit the issue's: - Title - Assignees diff --git a/doc/user/project/settings/project_access_tokens.md b/doc/user/project/settings/project_access_tokens.md index db0731aa524..643042cb96a 100644 --- a/doc/user/project/settings/project_access_tokens.md +++ b/doc/user/project/settings/project_access_tokens.md @@ -132,6 +132,18 @@ token = bot.personal_access_tokens.create(scopes:[:api, :write_repository], name gtoken = token.token # get the token value ``` +Test if the generated group access token works: + +1. Pass the group access token in the `PRIVATE-TOKEN` header to GitLab REST APIs. For example: + + - [Create an epic](../../../api/epics.md#new-epic) on the group. + - [Create a project pipeline](../../../api/pipelines.md#create-a-new-pipeline) + in one of the group's projects. + - [Create an issue](../../../api/issues.md#new-issue) in one of the group's projects. + +1. Use the group token to [clone a group's project](../../../gitlab-basics/start-using-git.md#clone-with-https) + using HTTPS. + ### Revoke a group access token To revoke a group access token, run the following in a Rails console: diff --git a/doc/user/search/advanced_search.md b/doc/user/search/advanced_search.md index bb74a035121..f29ac531d2e 100644 --- a/doc/user/search/advanced_search.md +++ b/doc/user/search/advanced_search.md @@ -35,9 +35,9 @@ The Advanced Search can be useful in various scenarios: Advanced Search is based on Elasticsearch, which is a purpose-built full text search engine that can be horizontally scaled so that it can provide search results in 1-2 seconds in most cases. -- **Code Maintenance:** - Finding all the code that needs to be updated at once across an entire - instance can save time spent maintaining code. +- **Code Maintenance:** + Finding all the code that needs to be updated at once across an entire + instance can save time spent maintaining code. This is especially helpful for organizations with more than 10 active projects. This can also help build confidence is code refactoring to identify unknown impacts. - **Promote innersourcing:** diff --git a/doc/user/workspace/img/hardware_settings.png b/doc/user/workspace/img/hardware_settings.png Binary files differnew file mode 100644 index 00000000000..ff460918f25 --- /dev/null +++ b/doc/user/workspace/img/hardware_settings.png diff --git a/doc/user/workspace/index.md b/doc/user/workspace/index.md index f098cef6053..d9c9d19721b 100644 --- a/doc/user/workspace/index.md +++ b/doc/user/workspace/index.md @@ -6,17 +6,20 @@ info: To determine the technical writer assigned to the Stage/Group associated w # Workspace -Workspace will be the top-level [namespace](../group/index.md#namespaces) for you to manage +Workspace will be the top [namespace](../group/index.md#namespaces) for you to manage everything GitLab, including: - Defining and applying settings to all of your groups, subgroups, and projects. - Aggregating data from all your groups, subgroups, and projects. Workspace will take many of the features from the -[Admin Area](../admin_area/index.md), and there will be one workspace per: +[Admin Area](../admin_area/index.md) and will: -- Instance, for self-managed instances. -- Namespace, for GitLab.com. +- Enable a top namespace for GitLab.com. +- Eventually replace the instance level for self-managed installations. + +Our goal is to reach feature parity between SaaS and self-managed installations, with one +exception: **Hardware Controls** will appear **only** on self-managed installations. NOTE: Workspace is currently in development. @@ -32,3 +35,5 @@ The following provide a preview to the Workspace concept. ![Admin Overview](img/1.3-Admin.png) ![Admin Overview](img/Admin_Settings.png) + +![Admin Overview](img/hardware_settings.png) |