diff --git a/doc/administration/settings/jira_cloud_app_troubleshooting.md b/doc/administration/settings/jira_cloud_app_troubleshooting.md index 3ce9ad70adb399e80ca46d9faf51f17b99bc3932..cccd6e9654ab3fd0766a43def5781670057dc49e 100644 --- a/doc/administration/settings/jira_cloud_app_troubleshooting.md +++ b/doc/administration/settings/jira_cloud_app_troubleshooting.md @@ -61,7 +61,7 @@ If the issue persists, verify that your self-managed GitLab instance can connect To test connectivity, run the following command: ```shell -# A `404` status code is expected because you're not passing a token +# A `404 Not Found` is expected because you're not passing a token curl --head "https://connect-install-keys.atlassian.com" ``` @@ -77,7 +77,7 @@ To resolve this issue on your self-managed GitLab instance: - GitLab.com (if you [installed the app from the official Atlassian Marketplace listing](jira_cloud_app.md#connect-the-gitlab-for-jira-cloud-app)). - Jira Cloud (if you [installed the app manually](jira_cloud_app.md#install-the-gitlab-for-jira-cloud-app-manually)). - Ensure the token request sent to the `/-/jira_connect/events/installed` endpoint when you install the app is accessible from Jira. - The following `curl` command must return a `401` status code: + The following command should return a `401 Unauthorized`: ```shell curl --include --request POST "https://gitlab.example.com/-/jira_connect/events/installed" @@ -194,8 +194,8 @@ Each `GET` request to the Jira Connect Proxy URL `https://gitlab.com/-/jira_conn For the first log: -- `json.status` is `422`. -- `json.params.value` should match the GitLab self-managed URL `[[FILTERED], {"instance_url"=>"https://gitlab.example.com"}]`. +- `json.status` is `422 Unprocessable Entity`. +- `json.params.value` should match the self-managed GitLab URL `[[FILTERED], {"instance_url"=>"https://gitlab.example.com"}]`. For the second log, you might have one of the following scenarios: @@ -203,8 +203,8 @@ For the second log, you might have one of the following scenarios: - `json.message`, `json.jira_status_code`, and `json.jira_body` are present. - `json.message` is `Proxy lifecycle event received error response` or similar. - `json.jira_status_code` and `json.jira_body` might contain the response received from the self-managed instance or a proxy in front of the instance. - - If `json.jira_status_code` is `401` and `json.jira_body` is empty, [**Jira Connect Proxy URL**](jira_cloud_app.md#set-up-your-instance) might not be set to - `https://gitlab.com`. + - If `json.jira_status_code` is `401 Unauthorized` and `json.jira_body` is empty, + [**Jira Connect Proxy URL**](jira_cloud_app.md#set-up-your-instance) might not be set to `https://gitlab.com`. - Scenario 2: - `json.exception.class` and `json.exception.message` are present. - `json.exception.class` and `json.exception.message` contain whether an issue occurred while contacting the self-managed instance. diff --git a/doc/integration/jira/connect-app.md b/doc/integration/jira/connect-app.md index 8ddc0f5af9afcc549bf31d47f025b63913d940e5..a1b259ed6596caa53193a0835f1ff4a7d459134d 100644 --- a/doc/integration/jira/connect-app.md +++ b/doc/integration/jira/connect-app.md @@ -126,5 +126,5 @@ Failed to link group. Please try again. A `403 Forbidden` is returned if the user information cannot be fetched from Jira because of insufficient permissions. -To resolve this issue, ensure the Jira user that installs and configures the app meets certain -[requirements](../../administration/settings/jira_cloud_app.md#jira-user-requirements). +To resolve this issue, ensure you meet certain +[Jira user requirements](../../administration/settings/jira_cloud_app.md#jira-user-requirements).