diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2019-10-10 00:06:44 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2019-10-10 00:06:44 +0000 |
commit | 308146dc398fd4c13453048105498018459e0985 (patch) | |
tree | d843eb63c1672e4b18c483907e2cd4aa7fca708e /doc/user | |
parent | 4b28d5ae770c6bd332283a3f13ceae06329c409b (diff) | |
download | gitlab-ce-308146dc398fd4c13453048105498018459e0985.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/user')
-rw-r--r-- | doc/user/admin_area/index.md | 12 | ||||
-rw-r--r-- | doc/user/analytics/cycle_analytics.md | 2 | ||||
-rw-r--r-- | doc/user/clusters/applications.md | 6 | ||||
-rw-r--r-- | doc/user/gitlab_com/index.md | 12 | ||||
-rw-r--r-- | doc/user/group/epics/index.md | 2 | ||||
-rw-r--r-- | doc/user/group/saml_sso/index.md | 6 | ||||
-rw-r--r-- | doc/user/markdown.md | 22 | ||||
-rw-r--r-- | doc/user/permissions.md | 2 | ||||
-rw-r--r-- | doc/user/profile/account/delete_account.md | 46 | ||||
-rw-r--r-- | doc/user/project/clusters/eks_and_gitlab/index.md | 2 | ||||
-rw-r--r-- | doc/user/project/clusters/index.md | 6 | ||||
-rw-r--r-- | doc/user/project/clusters/runbooks/index.md | 2 | ||||
-rw-r--r-- | doc/user/project/deploy_boards.md | 4 | ||||
-rw-r--r-- | doc/user/project/service_desk.md | 2 |
14 files changed, 88 insertions, 38 deletions
diff --git a/doc/user/admin_area/index.md b/doc/user/admin_area/index.md index 043345093f5..5fd9f4252d4 100644 --- a/doc/user/admin_area/index.md +++ b/doc/user/admin_area/index.md @@ -105,8 +105,16 @@ You can administer all users in the GitLab instance from the Admin Area's Users To access the Users page, go to **Admin Area > Overview > Users**. -Click the **Active**, **Admins**, **2FA Enabled**, or **2FA Disabled**, **External**, or -**Without projects** tab to list only users of that criteria. +To list users matching a specific criteria, click on one of the following tabs on the **Users** page: + +- **Active** +- **Admins** +- **2FA Enabled** +- **2FA Disabled** +- **External** +- **Blocked** +- **Deactivated** +- **Without projects** For each user, their username, email address, are listed, also the date their account was created and the date of last activity. To edit a user, click the **Edit** button in that user's diff --git a/doc/user/analytics/cycle_analytics.md b/doc/user/analytics/cycle_analytics.md index 743b0c217d7..b4b053ded42 100644 --- a/doc/user/analytics/cycle_analytics.md +++ b/doc/user/analytics/cycle_analytics.md @@ -169,7 +169,7 @@ For Cycle Analytics functionality introduced in GitLab 12.3 and later: Learn more about Cycle Analytics in the following resources: -- [Cycle Analytics feature page](https://about.gitlab.com/features/cycle-analytics/) +- [Cycle Analytics feature page](https://about.gitlab.com/product/cycle-analytics/) - [Cycle Analytics feature preview](https://about.gitlab.com/2016/09/16/feature-preview-introducing-cycle-analytics/) - [Cycle Analytics feature highlight](https://about.gitlab.com/2016/09/21/cycle-analytics-feature-highlight/) diff --git a/doc/user/clusters/applications.md b/doc/user/clusters/applications.md index c525bf04d99..db832a4accf 100644 --- a/doc/user/clusters/applications.md +++ b/doc/user/clusters/applications.md @@ -62,7 +62,7 @@ can lead to confusion during deployments. > - Introduced in GitLab 10.2 for project-level clusters. > - Introduced in GitLab 11.6 for group-level clusters. -[Helm](https://docs.helm.sh/) is a package manager for Kubernetes and is +[Helm](https://helm.sh/docs/) is a package manager for Kubernetes and is required to install all the other applications. It is installed in its own pod inside the cluster which can run the `helm` CLI in a safe environment. @@ -174,7 +174,7 @@ higher](../permissions.md) access to the associated project or group. We use a [custom Jupyter image](https://gitlab.com/gitlab-org/jupyterhub-user-image/blob/master/Dockerfile) that installs additional useful packages on top of the base Jupyter. You -will also see ready-to-use DevOps Runbooks built with Nurtch's [Rubix library](https://github.com/amit1rrr/rubix). +will also see ready-to-use DevOps Runbooks built with Nurtch's [Rubix library](https://github.com/Nurtch/rubix). More information on creating executable runbooks can be found in [our Runbooks @@ -221,7 +221,7 @@ You can clone repositories from the files tab in Jupyter: > - Introduced in GitLab 11.5 for project-level clusters. > - Introduced in GitLab 12.3 for group- and instance-level clusters. -[Knative](https://cloud.google.com/knative) provides a platform to +[Knative](https://cloud.google.com/knative/) provides a platform to create, deploy, and manage serverless workloads from a Kubernetes cluster. It is used in conjunction with, and includes [Istio](https://istio.io) to provide an external IP address for all diff --git a/doc/user/gitlab_com/index.md b/doc/user/gitlab_com/index.md index cfb561481d6..035ec15b453 100644 --- a/doc/user/gitlab_com/index.md +++ b/doc/user/gitlab_com/index.md @@ -41,7 +41,7 @@ Host gitlab.com ## GitLab Pages -Below are the settings for [GitLab Pages]. +Below are the settings for [GitLab Pages](https://about.gitlab.com/product/pages/). | Setting | GitLab.com | Default | | --------------------------- | ---------------- | ------------- | @@ -103,13 +103,11 @@ Below are the shared Runners settings. | Setting | GitLab.com | Default | | ----------- | ----------------- | ---------- | -| [GitLab Runner] | [Runner versions dashboard][ci_version_dashboard] | - | +| [GitLab Runner] | [Runner versions dashboard](https://dashboards.gitlab.com/d/000000159/ci?from=now-1h&to=now&refresh=5m&orgId=1&panelId=12&fullscreen&theme=light) | - | | Executor | `docker+machine` | - | | Default Docker image | `ruby:2.5` | - | | `privileged` (run [Docker in Docker]) | `true` | `false` | -[ci_version_dashboard]: https://dashboards.gitlab.com/dashboard/db/ci?from=now-1h&to=now&refresh=5m&orgId=1&panelId=12&fullscreen&theme=light - ### `config.toml` The full contents of our `config.toml` are: @@ -174,7 +172,7 @@ sentry_dsn = "X" ## Sidekiq -GitLab.com runs [Sidekiq][sidekiq] with arguments `--timeout=4 --concurrency=4` +GitLab.com runs [Sidekiq](https://sidekiq.org) with arguments `--timeout=4 --concurrency=4` and the following environment variables: | Setting | GitLab.com | Default | @@ -275,7 +273,7 @@ released depending on the type of block, as described below. If you receive a `403 Forbidden` error for all requests to GitLab.com, please check for any automated processes that may be triggering a block. For -assistance, contact [GitLab Support](https://support.gitlab.com) +assistance, contact [GitLab Support](https://support.gitlab.com/hc/en-us) with details, such as the affected IP address. ### HAProxy API throttle @@ -390,10 +388,8 @@ High Performance TCP/HTTP Load Balancer: [runners-post]: https://about.gitlab.com/2016/04/05/shared-runners/ "Shared Runners on GitLab.com" [GitLab Runner]: https://gitlab.com/gitlab-org/gitlab-runner [altssh]: https://about.gitlab.com/2016/02/18/gitlab-dot-com-now-supports-an-alternate-git-plus-ssh-port/ "GitLab.com now supports an alternate git+ssh port" -[GitLab Pages]: https://about.gitlab.com/features/pages "GitLab Pages" [docker in docker]: https://hub.docker.com/_/docker/ "Docker in Docker at DockerHub" [mailgun]: https://www.mailgun.com/ "Mailgun website" -[sidekiq]: http://sidekiq.org/ "Sidekiq website" [unicorn-worker-killer]: https://rubygems.org/gems/unicorn-worker-killer "unicorn-worker-killer" [4010]: https://gitlab.com/gitlab-com/infrastructure/issues/4010 "Find a good value for maximum timeout for Shared Runners" [4070]: https://gitlab.com/gitlab-com/infrastructure/issues/4070 "Configure per-runner timeout for shared-runners-manager-X on GitLab.com" diff --git a/doc/user/group/epics/index.md b/doc/user/group/epics/index.md index d04ecedc7a2..51e779cce6a 100644 --- a/doc/user/group/epics/index.md +++ b/doc/user/group/epics/index.md @@ -85,7 +85,7 @@ the re-calculation will happen immediately to set a new dynamic date. ## Roadmap in epics -> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/7327) in [GitLab Ultimate](https://about.gitlab.com/pricing) 11.10. +> [Introduced](https://gitlab.com/gitlab-org/gitlab/issues/7327) in [GitLab Ultimate](https://about.gitlab.com/pricing/) 11.10. If your epic contains one or more [child epics](#multi-level-child-epics) which have a [start or due date](#start-date-and-due-date), then you can see a diff --git a/doc/user/group/saml_sso/index.md b/doc/user/group/saml_sso/index.md index fecf543af5f..d40ddb00390 100644 --- a/doc/user/group/saml_sso/index.md +++ b/doc/user/group/saml_sso/index.md @@ -105,13 +105,13 @@ NOTE: **Note:** GitLab is unable to provide support for IdPs that are not listed | Provider | Documentation | |----------|---------------| | ADFS (Active Directory Federation Services) | [Create a Relying Party Trust](https://docs.microsoft.com/en-us/windows-server/identity/ad-fs/operations/create-a-relying-party-trust) | -| Azure | [Configuring single sign-on to applications](https://docs.microsoft.com/en-us/azure/active-directory/active-directory-saas-custom-apps) | +| Azure | [Configuring single sign-on to applications](https://docs.microsoft.com/en-us/azure/active-directory/manage-apps/configure-single-sign-on-non-gallery-applications) | | Auth0 | [Auth0 as Identity Provider](https://auth0.com/docs/protocols/saml/saml-idp-generic) | | G Suite | [Set up your own custom SAML application](https://support.google.com/a/answer/6087519?hl=en) | | JumpCloud | [Single Sign On (SSO) with GitLab](https://support.jumpcloud.com/customer/en/portal/articles/2810701-single-sign-on-sso-with-gitlab) | -| Okta | [Setting up a SAML application in Okta](https://developer.okta.com/standards/SAML/setting_up_a_saml_application_in_okta) | +| Okta | [Setting up a SAML application in Okta](https://developer.okta.com/docs/guides/saml-application-setup/overview/) | | OneLogin | [Use the OneLogin SAML Test Connector](https://onelogin.service-now.com/support?id=kb_article&sys_id=93f95543db109700d5505eea4b96198f) | -| Ping Identity | [Add and configure a new SAML application](https://docs.pingidentity.com/bundle/p1_enterpriseConfigSsoSaml_cas/page/enableAppWithoutURL.html) | +| Ping Identity | [Add and configure a new SAML application](https://support.pingidentity.com/s/document-item?bundleId=pingone&topicId=xsh1564020480660-1.html) | ## Linking SAML to your existing GitLab.com account diff --git a/doc/user/markdown.md b/doc/user/markdown.md index 65ff176df27..0b4bb43b4bf 100644 --- a/doc/user/markdown.md +++ b/doc/user/markdown.md @@ -14,7 +14,7 @@ NOTE: **Note:** We encourage you to view this document as [rendered by GitLab it GitLab uses "GitLab Flavored Markdown" (GFM). It extends the [CommonMark specification](https://spec.commonmark.org/current/) (which is based on standard Markdown) in several ways to add additional useful functionality. -It was inspired by [GitHub Flavored Markdown](https://help.github.com/articles/basic-writing-and-formatting-syntax/). +It was inspired by [GitHub Flavored Markdown](https://help.github.com/en/articles/basic-writing-and-formatting-syntax). You can use GFM in the following areas: @@ -352,7 +352,7 @@ However the wrapping tags cannot be mixed: > If this is not rendered correctly, [view it in GitLab itself](https://gitlab.com/gitlab-org/gitlab/blob/master/doc/user/markdown.md#math). -It is possible to have math written with LaTeX syntax rendered using [KaTeX](https://github.com/Khan/KaTeX). +It is possible to have math written with LaTeX syntax rendered using [KaTeX](https://github.com/KaTeX/KaTeX). Math written between dollar signs `$` will be rendered inline with the text. Math written inside a [code block](#code-spans-and-blocks) with the language declared as `math`, will be rendered @@ -379,7 +379,7 @@ a^2+b^2=c^2 _Be advised that KaTeX only supports a [subset](https://katex.org/docs/supported.html) of LaTeX._ NOTE: **Note:** This also works for the asciidoctor `:stem: latexmath`. For details see -the [asciidoctor user manual](http://asciidoctor.org/docs/user-manual/#activating-stem-support). +the [asciidoctor user manual](https://asciidoctor.org/docs/user-manual/#activating-stem-support). ### Special GitLab references @@ -641,7 +641,7 @@ Tildes are OK too. GitLab uses the [Rouge Ruby library](http://rouge.jneen.net/) for more colorful syntax highlighting in code blocks. For a list of supported languages visit the -[Rouge project wiki](https://github.com/jneen/rouge/wiki/List-of-supported-languages-and-lexers). +[Rouge project wiki](https://github.com/rouge-ruby/rouge/wiki/List-of-supported-languages-and-lexers). Syntax highlighting is only supported in code blocks, it is not possible to highlight code when it is inline. @@ -922,7 +922,7 @@ Here's a sample audio clip: You can also use raw HTML in your Markdown, and it'll usually work pretty well. -See the documentation for HTML::Pipeline's [SanitizationFilter](http://www.rubydoc.info/gems/html-pipeline/1.11.0/HTML/Pipeline/SanitizationFilter#WHITELIST-constant) +See the documentation for HTML::Pipeline's [SanitizationFilter](https://www.rubydoc.info/gems/html-pipeline/1.11.0/HTML/Pipeline/SanitizationFilter#WHITELIST-constant) class for the list of allowed HTML tags and attributes. In addition to the default `SanitizationFilter` whitelist, GitLab allows `span`, `abbr`, `details` and `summary` elements. @@ -1126,8 +1126,8 @@ Using references: Some text to show that the reference links can follow later. -[arbitrary case-insensitive reference text]: https://www.mozilla.org -[1]: http://slashdot.org +[arbitrary case-insensitive reference text]: https://www.mozilla.org/en-US/ +[1]: https://slashdot.org [link text itself]: https://www.reddit.com ``` @@ -1149,8 +1149,8 @@ Using references: Some text to show that the reference links can follow later. -[arbitrary case-insensitive reference text]: https://www.mozilla.org -[1]: http://slashdot.org +[arbitrary case-insensitive reference text]: https://www.mozilla.org/en-US/ +[1]: https://slashdot.org [link text itself]: https://www.reddit.com NOTE: **Note:** Relative links do not allow the referencing of project files in a wiki @@ -1164,7 +1164,7 @@ GFM will autolink almost any URL you put into your text: ```markdown - https://www.google.com -- https://google.com/ +- https://www.google.com - ftp://ftp.us.debian.org/debian/ - smb://foo/bar/baz - irc://irc.freenode.net/ @@ -1172,7 +1172,7 @@ GFM will autolink almost any URL you put into your text: ``` - <https://www.google.com> -- <https://google.com/> +- <https://www.google.com> - <ftp://ftp.us.debian.org/debian/> - <smb://foo/bar/baz> - <irc://irc.freenode.net/> diff --git a/doc/user/permissions.md b/doc/user/permissions.md index 2bf7f24bbab..85930365708 100644 --- a/doc/user/permissions.md +++ b/doc/user/permissions.md @@ -24,7 +24,7 @@ For information on eligible approvers for Merge Requests, see ## Principles behind permissions -See our [product handbook on permissions](https://about.gitlab.com/handbook/product#permissions-in-gitlab) +See our [product handbook on permissions](https://about.gitlab.com/handbook/product/#permissions-in-gitlab) ## Instance-wide user permissions diff --git a/doc/user/profile/account/delete_account.md b/doc/user/profile/account/delete_account.md index 9b72956a55e..fda0936355e 100644 --- a/doc/user/profile/account/delete_account.md +++ b/doc/user/profile/account/delete_account.md @@ -42,6 +42,52 @@ a user can be blocked directly from the Admin area. To do this: 1. Selecting a user. 1. Under the **Account** tab, click **Block user**. +### Deactivating a user + +> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/63921) in GitLab 12.4. + +A user can be deactivated from the Admin area. Deactivating a user is functionally identical to blocking a user, with the following differences: + +- It does not prohibit the user from logging back in via the UI. +- Once a deactivated user logs back into the GitLab UI, their account is set to active. + +A deactivated user: + +- Cannot access Git repositories or the API. +- Will not receive any notifications from GitLab. + +Personal projects, group and user history of the deactivated user will be left intact. + +NOTE: **Note:** +A deactivated user does not consume a [seat](../../../subscriptions/index.md#managing-subscriptions). + +To do this: + +1. Navigate to **Admin Area > Overview > Users**. +1. Select a user. +1. Under the **Account** tab, click **Deactivate user**. + +Please note that for the deactivation option to be visible to an admin, the user: + +- Must be currently active. +- Should not have any activity in the last 14 days. + +### Activating a user + +> [Introduced](https://gitlab.com/gitlab-org/gitlab-ce/issues/63921) in GitLab 12.4. + +A deactivated user can be activated from the Admin area. Activating a user sets their account to active state. + +To do this: + +1. Navigate to **Admin Area > Overview > Users**. +1. Click on the **Deactivated** tab. +1. Select a user. +1. Under the **Account** tab, click **Activate user**. + +TIP: **Tip:** +A deactivated user can also activate their account by themselves by simply logging back via the UI. + ## Associated Records > - Introduced for issues in diff --git a/doc/user/project/clusters/eks_and_gitlab/index.md b/doc/user/project/clusters/eks_and_gitlab/index.md index 28f3420de35..22576b84926 100644 --- a/doc/user/project/clusters/eks_and_gitlab/index.md +++ b/doc/user/project/clusters/eks_and_gitlab/index.md @@ -192,7 +192,7 @@ deployment of the other applications. Next, if you would like the deployed app to be reachable on the internet, deploy the Ingress. Note that this will also cause an -[Elastic Load Balancer](https://aws.amazon.com/documentation/elastic-load-balancing/) +[Elastic Load Balancer](https://docs.aws.amazon.com/elasticloadbalancing/) to be created, which will incur additional AWS costs. Once installed, you may see a `?` for "Ingress IP Address". This is because the diff --git a/doc/user/project/clusters/index.md b/doc/user/project/clusters/index.md index 9d61cba8e7e..9ecb785d6fe 100644 --- a/doc/user/project/clusters/index.md +++ b/doc/user/project/clusters/index.md @@ -112,7 +112,7 @@ There are two options when adding a new cluster to your project: TIP: **Tip:** Every new Google Cloud Platform (GCP) account receives [$300 in credit upon sign up](https://console.cloud.google.com/freetrial), and in partnership with Google, GitLab is able to offer an additional $200 for new GCP accounts to get started with GitLab's -Google Kubernetes Engine Integration. All you have to do is [follow this link](https://goo.gl/AaJzRW) and apply for credit. +Google Kubernetes Engine Integration. All you have to do is [follow this link](https://cloud.google.com/partners/partnercredit/?PCN=a0n60000006Vpz4AAC) and apply for credit. NOTE: **Note:** The [Google authentication integration](../../../integration/google.md) must @@ -390,8 +390,8 @@ you can either: When creating a cluster in GitLab, you will be asked if you would like to create either: -- An [Attribute-based access control (ABAC)](https://kubernetes.io/docs/admin/authorization/abac/) cluster. -- A [Role-based access control (RBAC)](https://kubernetes.io/docs/admin/authorization/rbac/) cluster. +- An [Attribute-based access control (ABAC)](https://kubernetes.io/docs/reference/access-authn-authz/abac/) cluster. +- A [Role-based access control (RBAC)](https://kubernetes.io/docs/reference/access-authn-authz/rbac/) cluster. NOTE: **Note:** [RBAC](#rbac-cluster-resources) is recommended and the GitLab default. diff --git a/doc/user/project/clusters/runbooks/index.md b/doc/user/project/clusters/runbooks/index.md index 26ce4820174..7b17ec68234 100644 --- a/doc/user/project/clusters/runbooks/index.md +++ b/doc/user/project/clusters/runbooks/index.md @@ -50,7 +50,7 @@ To create an executable runbook, you will need: Nurtch is the company behind the [Rubix library](https://github.com/Nurtch/rubix). Rubix is an open-source Python library that makes it easy to perform common DevOps tasks inside Jupyter Notebooks. Tasks such as plotting Cloudwatch metrics and rolling your ECS/Kubernetes app are simplified -down to a couple of lines of code. See the [Nurtch Documentation](http://docs.nurtch.com/en/latest) +down to a couple of lines of code. See the [Nurtch Documentation](http://docs.nurtch.com/en/latest/) for more information. ## Configure an executable runbook with GitLab diff --git a/doc/user/project/deploy_boards.md b/doc/user/project/deploy_boards.md index a1a4e589c84..b14d7f821bb 100644 --- a/doc/user/project/deploy_boards.md +++ b/doc/user/project/deploy_boards.md @@ -29,9 +29,9 @@ to the latest release. Since Deploy Boards are tightly coupled with Kubernetes, there is some required knowledge. In particular you should be familiar with: -- [Kubernetes pods](https://kubernetes.io/docs/user-guide/pods) +- [Kubernetes pods](https://kubernetes.io/docs/concepts/workloads/pods/pod/) - [Kubernetes labels](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/) -- [Kubernetes namespaces](https://kubernetes.io/docs/user-guide/namespaces/) +- [Kubernetes namespaces](https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/) - [Kubernetes canary deployments](https://kubernetes.io/docs/concepts/cluster-administration/manage-deployment/#canary-deployments) ## Use cases diff --git a/doc/user/project/service_desk.md b/doc/user/project/service_desk.md index 3f3536838e7..a2094c05635 100644 --- a/doc/user/project/service_desk.md +++ b/doc/user/project/service_desk.md @@ -50,7 +50,7 @@ users will only see the thread through email. > **Note:** Service Desk is enabled on GitLab.com. If you're a -[Silver subscriber](https://about.gitlab.com/gitlab-com/), +[Silver subscriber](https://about.gitlab.com/pricing/#gitlab-com), you can skip the step 1 below; you only need to enable it per project. 1. [Set up incoming email](../../administration/incoming_email.md#set-it-up) for the GitLab instance. This must |