diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-06 12:10:44 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-04-06 12:10:44 +0000 |
commit | ba174c982f40d71a87fd511b091753807174f7e7 (patch) | |
tree | b89d55c715288f2c2f76724c1b7ff4a6ebf90154 /doc/user/project | |
parent | eaea945e0355826c58c3dcf887496ea91064f85c (diff) | |
download | gitlab-ce-ba174c982f40d71a87fd511b091753807174f7e7.tar.gz |
Add latest changes from gitlab-org/gitlab@master
Diffstat (limited to 'doc/user/project')
8 files changed, 41 insertions, 51 deletions
diff --git a/doc/user/project/integrations/gitlab_slack_application.md b/doc/user/project/integrations/gitlab_slack_application.md index 4bc44d1d7d8..1ef2f593621 100644 --- a/doc/user/project/integrations/gitlab_slack_application.md +++ b/doc/user/project/integrations/gitlab_slack_application.md @@ -44,12 +44,12 @@ That's all! You can now start using the Slack slash commands. ## Usage After confirming the installation, you, and everyone else in your Slack team, -can use all the [slash commands]. +can use all the [slash commands](../../../integration/slash_commands.md). When you perform your first slash command you will be asked to authorize your Slack user on GitLab.com. -The only difference with the [manually configurable Slack slash commands][slack-manual] +The only difference with the [manually configurable Slack slash commands](slack_slash_commands.md) is that all the commands should be prefixed with the `/gitlab` keyword. We are working on making this configurable in the future. @@ -59,6 +59,3 @@ project, you would do: ```plaintext /gitlab gitlab-org/gitlab issue show 1001 ``` - -[slash commands]: ../../../integration/slash_commands.md -[slack-manual]: slack_slash_commands.md diff --git a/doc/user/project/integrations/index.md b/doc/user/project/integrations/index.md index 21df15c90f4..75565dd2750 100644 --- a/doc/user/project/integrations/index.md +++ b/doc/user/project/integrations/index.md @@ -2,7 +2,7 @@ You can find the available integrations under your project's **Settings ➔ Integrations** page. You need to have at least -[maintainer permission][permissions] on the project. +[maintainer permission](../../permissions.md) on the project. ## Integrations @@ -20,5 +20,3 @@ like pushes, issues or merge requests. GitLab will send a POST request with data to the webhook URL. [Learn more about webhooks.](webhooks.md) - -[permissions]: ../../permissions.md diff --git a/doc/user/project/integrations/jira.md b/doc/user/project/integrations/jira.md index cef9300fc67..442f3229de2 100644 --- a/doc/user/project/integrations/jira.md +++ b/doc/user/project/integrations/jira.md @@ -37,7 +37,7 @@ configured. Therefore, you will not have to explicitly associate a GitLab project with any single Jira project. If you have one Jira instance, you can pre-fill the settings page with a default -template. See the [Services Templates][services-templates] docs. +template. See the [Services Templates](services_templates.md) docs. In order to enable the Jira service in GitLab, you need to first configure the project in Jira and then enter the correct values in GitLab. @@ -55,7 +55,7 @@ In order to enable the Jira service in GitLab, you need to first configure the p > **Notes:** > -> - The currently supported Jira versions are `v6.x` and `v7.x.`. GitLab 7.8 or +> - The currently supported Jira versions are `v6.x, v7.x, v8.x` . GitLab 7.8 or > higher is required. > - GitLab 8.14 introduced a new way to integrate with Jira which greatly simplified > the configuration options you have to enter. If you are using an older version, @@ -212,5 +212,3 @@ which may lead to a `401 unauthorized` error when testing your Jira integration. If CAPTCHA has been triggered, you will not be able to use Jira's REST API to authenticate with the Jira site. You will need to log in to your Jira instance and complete the CAPTCHA. - -[services-templates]: services_templates.md diff --git a/doc/user/project/integrations/mattermost_slash_commands.md b/doc/user/project/integrations/mattermost_slash_commands.md index 35bcc907185..6abd613a019 100644 --- a/doc/user/project/integrations/mattermost_slash_commands.md +++ b/doc/user/project/integrations/mattermost_slash_commands.md @@ -15,7 +15,7 @@ Mattermost 3.4 and up is required. If you have the Omnibus GitLab package installed, Mattermost is already bundled in it. All you have to do is configure it. Read more in the -[Omnibus GitLab Mattermost documentation][omnimmdocs]. +[Omnibus GitLab Mattermost documentation](https://docs.gitlab.com/omnibus/gitlab-mattermost/). ## Automated Configuration @@ -133,7 +133,7 @@ The available slash commands are: | ------- | ----------- | ------- | | <kbd>/<trigger> issue new <title> <kbd>⇧ Shift</kbd>+<kbd>↵ Enter</kbd> <description></kbd> | Create a new issue in the project that `<trigger>` is tied to. `<description>` is optional. | `/gitlab issue new We need to change the homepage` | | <kbd>/<trigger> issue show <issue-number></kbd> | Show the issue with ID `<issue-number>` from the project that `<trigger>` is tied to. | `/gitlab issue show 42` | -| <kbd>/<trigger> deploy <environment> to <environment></kbd> | Start the CI job that deploys from one environment to another, for example `staging` to `production`. CI/CD must be [properly configured][ciyaml]. | `/gitlab deploy staging to production` | +| <kbd>/<trigger> deploy <environment> to <environment></kbd> | Start the CI job that deploys from one environment to another, for example `staging` to `production`. CI/CD must be [properly configured](../../../ci/yaml/README.md). | `/gitlab deploy staging to production` | To see a list of available commands to interact with GitLab, type the trigger word followed by <kbd>help</kbd>. Example: `/gitlab help` @@ -147,9 +147,5 @@ the [permissions you have on the project](../../permissions.md#project-members-p ## Further reading -- [Mattermost slash commands documentation][mmslashdocs] -- [Omnibus GitLab Mattermost][omnimmdocs] - -[omnimmdocs]: https://docs.gitlab.com/omnibus/gitlab-mattermost/ -[mmslashdocs]: https://docs.mattermost.com/developer/slash-commands.html -[ciyaml]: ../../../ci/yaml/README.md +- [Mattermost slash commands documentation](https://docs.mattermost.com/developer/slash-commands.html) +- [Omnibus GitLab Mattermost](https://docs.gitlab.com/omnibus/gitlab-mattermost/) diff --git a/doc/user/project/integrations/prometheus.md b/doc/user/project/integrations/prometheus.md index 2b1608ad60c..7a21887d29f 100644 --- a/doc/user/project/integrations/prometheus.md +++ b/doc/user/project/integrations/prometheus.md @@ -1,8 +1,8 @@ # Prometheus integration -> [Introduced][ce-8935] in GitLab 9.0. +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8935) in GitLab 9.0. -GitLab offers powerful integration with [Prometheus] for monitoring key metrics of your apps, directly within GitLab. +GitLab offers powerful integration with [Prometheus](https://prometheus.io) for monitoring key metrics of your apps, directly within GitLab. Metrics for each environment are retrieved from Prometheus, and then displayed within the GitLab interface. @@ -727,7 +727,7 @@ If the metric exceeds the threshold of the alert for over 5 minutes, an email wi ## Determining the performance impact of a merge -> - [Introduced][ce-10408] in GitLab 9.2. +> - [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/10408) in GitLab 9.2. > - GitLab 9.3 added the [numeric comparison](https://gitlab.com/gitlab-org/gitlab-foss/issues/27439) of the 30 minute averages. Developers can view the performance impact of their changes within the merge @@ -755,7 +755,7 @@ Prometheus server. ### Embedding GitLab-managed Kubernetes metrics -> [Introduced][ce-29691] in GitLab 12.2. +> [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/29691) in GitLab 12.2. It is possible to display metrics charts within [GitLab Flavored Markdown](../../markdown.md#gitlab-flavored-markdown-gfm) fields such as issue or merge request descriptions. The maximum number of embedded charts allowed in a GitLab Flavored Markdown field is 100. @@ -895,18 +895,3 @@ If the "No data found" screen continues to appear, it could be due to: [run a query](prometheus_library/kubernetes.md#metrics-supported), replacing `$CI_ENVIRONMENT_SLUG` with the name of your environment. - You may need to re-add the GitLab predefined common metrics. This can be done by running the [import common metrics Rake task](../../../administration/raketasks/maintenance.md#import-common-metrics). - -[autodeploy]: ../../../topics/autodevops/index.md#auto-deploy -[kubernetes]: https://kubernetes.io -[kube]: ./kubernetes.md -[prometheus-k8s-sd]: https://prometheus.io/docs/operating/configuration/#<kubernetes_sd_config> -[prometheus]: https://prometheus.io -[gitlab-prometheus-k8s-monitor]: ../../../administration/monitoring/prometheus/index.md#configuring-prometheus-to-monitor-kubernetes -[prometheus-docker-image]: https://hub.docker.com/r/prom/prometheus/ -[prometheus-yml]:samples/prometheus.yml -[gitlab.com-ip-range]: https://gitlab.com/gitlab-com/infrastructure/issues/434 -[ci-environment-slug]: ../../../ci/variables/#predefined-environment-variables -[ce-8935]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/8935 -[ce-10408]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/10408 -[ce-29691]: https://gitlab.com/gitlab-org/gitlab-foss/-/merge_requests/29691 -[promgldocs]: ../../../administration/monitoring/prometheus/index.md diff --git a/doc/user/project/issues/design_management.md b/doc/user/project/issues/design_management.md index 0fbf5ec6f4b..ebb78d5c54a 100644 --- a/doc/user/project/issues/design_management.md +++ b/doc/user/project/issues/design_management.md @@ -126,6 +126,8 @@ to help summarize changes between versions. Designs can be explored in greater detail by zooming in and out of the image. Control the amount of zoom with the `+` and `-` buttons at the bottom of the image. While zoomed, you can still [start new discussions](#starting-discussions-on-designs) on the image, and see any existing ones. +[Introduced](https://gitlab.com/gitlab-org/gitlab/issues/197324) in GitLab 12.10, while zoomed in, +you can click-and-drag on the image to move around it. ![Design zooming](img/design_zooming_v12_7.png) diff --git a/doc/user/project/merge_requests/test_coverage_visualization.md b/doc/user/project/merge_requests/test_coverage_visualization.md index fe7c2c2757b..71fbdaf112f 100644 --- a/doc/user/project/merge_requests/test_coverage_visualization.md +++ b/doc/user/project/merge_requests/test_coverage_visualization.md @@ -34,7 +34,7 @@ for other languages have plugins to add support for it, like: Other coverage analysis frameworks support the format out of the box, for example: - [Istanbul](https://istanbul.js.org/docs/advanced/alternative-reporters/#cobertura) (JavaScript) -- [Coverage.py](https://coverage.readthedocs.io/en/coverage-5.0/cmd.html#xml-reporting) (Python) +- [Coverage.py](https://coverage.readthedocs.io/en/coverage-5.0.4/cmd.html#xml-reporting) (Python) Once configured, if you create a merge request that triggers a pipeline which collects coverage reports, the coverage will be shown in the diff view. This includes reports diff --git a/doc/user/project/pages/custom_domains_ssl_tls_certification/lets_encrypt_integration.md b/doc/user/project/pages/custom_domains_ssl_tls_certification/lets_encrypt_integration.md index 8897ac867d1..42b1570d213 100644 --- a/doc/user/project/pages/custom_domains_ssl_tls_certification/lets_encrypt_integration.md +++ b/doc/user/project/pages/custom_domains_ssl_tls_certification/lets_encrypt_integration.md @@ -7,9 +7,6 @@ description: "Automatic Let's Encrypt SSL certificates for GitLab Pages." > [Introduced](https://gitlab.com/gitlab-org/gitlab-foss/issues/28996) in GitLab 12.1. For versions earlier than GitLab 12.1, see the [manual Let's Encrypt instructions](../lets_encrypt_for_gitlab_pages.md). -NOTE: **Note:** -This feature is in **beta** and may still have bugs. See all the related issues linked from this [issue's description](https://gitlab.com/gitlab-org/gitlab-foss/issues/28996) for more information. - The GitLab Pages integration with Let's Encrypt (LE) allows you to use LE certificates for your Pages website with custom domains without the hassle of having to issue and update them yourself; @@ -63,18 +60,35 @@ associated Pages domain. It also will be renewed automatically by GitLab. ## Troubleshooting -### Error "Certificate misses intermediates" +### Error "Something went wrong while obtaining Let's Encrypt certificate" + +> [Introduced](https://gitlab.com/gitlab-org/gitlab/-/issues/30146) in GitLab 13.0. -If you get an error **Certificate misses intermediates** while trying to enable Let's Encrypt integration for your domain, follow the steps below: +If you get an error **Something went wrong while obtaining Let's Encrypt certificate**, you can try obtaining the certificate again by following these steps: 1. Go to your project's **Settings > Pages**. -1. Turn off **Force HTTPS** if it's turned on. -1. Click **Details** on your domain. -1. Click the **Edit** button in the top right corner of domain details page. -1. Enable Let's Encrypt integration. -1. Click **Save**. +1. Click **Edit** on your domain. +1. Click **Retry**. +1. If you're still seeing the same error: + 1. Make sure you have properly set only one `CNAME` or `A` DNS record for your domain. + 1. Make sure your domain **doesn't have** an `AAAA` DNS record. + 1. If you have a `CAA` DNS record for your domain or any higher level domains, make sure [it includes `letsencrypt.org`](https://letsencrypt.org/docs/caa/). + 1. Make sure [your domain is verified](index.md#1-add-a-custom-domain-to-pages). + 1. Go to step 1. + +### Message "GitLab is obtaining a Let's Encrypt SSL certificate for this domain. This process can take some time. Please try again later." hangs for more than an hour + +If you've enabled Let's Encrypt integration, but a certificate is absent after an hour and you see the message, "GitLab is obtaining a Let's Encrypt SSL certificate for this domain. This process can take some time. Please try again later.", try to remove and add the domain for GitLab Pages again by following these steps: + 1. Go to your project's **Settings > Pages**. -1. Turn on **Force HTTPS**. +1. Click **Remove** on your domain. +1. [Add the domain again and verify it](index.md#1-add-a-custom-domain-to-pages). +1. [Enable Let's Encrypt integration for your domain](#enabling-lets-encrypt-integration-for-your-custom-domain). +1. If you still see the same message after some time: + 1. Make sure you have properly set only one `CNAME` or `A` DNS record for your domain. + 1. Make sure your domain **doesn't have** an `AAAA` DNS record. + 1. If you have a `CAA` DNS record for your domain or any higher level domains, make sure [it includes `letsencrypt.org`](https://letsencrypt.org/docs/caa/). + 1. Go to step 1. <!-- Include any troubleshooting steps that you can foresee. If you know beforehand what issues one might have when setting this up, or when something is changed, or on upgrading, it's |