Merge branch 'msj-redmine-integration' into 'master'

Review and revise Redmine integration UI text

See merge request gitlab-org/gitlab!58899

app/models/project_services/redmine_service.rb

 # frozen_string_literal: true
 
 class RedmineService < IssueTrackerService
+  include ActionView::Helpers::UrlHelper
   validates :project_url, :issues_url, :new_issue_url, presence: true, public_url: true, if: :activated?
 
   def title
@@ -8,7 +9,12 @@ class RedmineService < IssueTrackerService
   end
 
   def description
-    s_('IssueTracker|Redmine issue tracker')
+    s_('IssueTracker|Use Redmine as the issue tracker.')
+  end
+
+  def help
+    docs_link = link_to _('Learn more.'), Rails.application.routes.url_helpers.help_page_url('user/project/integrations/redmine'), target: '_blank', rel: 'noopener noreferrer'
+    s_('IssueTracker|Use Redmine as the issue tracker. %{docs_link}').html_safe % { docs_link: docs_link.html_safe }
   end
 
   def self.to_param

changelogs/unreleased/msj-redmine-integration.yml

+---
+title: Review and revise Redmine Integration UI text
+merge_request: 58899
+author:
+type: other

doc/user/project/integrations/redmine.md

@@ -4,37 +4,52 @@ group: Ecosystem
 info: To determine the technical writer assigned to the Stage/Group associated with this page, see https://about.gitlab.com/handbook/engineering/ux/technical-writing/#assignments
 ---
 
-# Redmine Service **(FREE)**
+# Redmine service **(FREE)**
 
-1. To enable the Redmine integration in a project, navigate to the
-   [Integrations page](overview.md#accessing-integrations), click
-   the **Redmine** service, and fill in the required details on the page as described
-   in the table below.
+Use [Redmine](https://www.redmine.org/) as the issue tracker.
 
-   | Field | Description |
-   | ----- | ----------- |
-   | `project_url`   | The URL to the project in Redmine which is being linked to this GitLab project |
-   | `issues_url`    | The URL to the issue in Redmine project that is linked to this GitLab project. Note that the `issues_url` requires `:id` in the URL. This ID is used by GitLab as a placeholder to replace the issue number. |
-   | `new_issue_url` | This is the URL to create a new issue in Redmine for the project linked to this GitLab project. **This is currently not being used and is planned be removed in a future release.** |
+To enable the Redmine integration in a project:
 
-   Once you have configured and enabled Redmine, you see the Redmine link on the GitLab project pages that takes you to the appropriate Redmine project.
+1. Go to the [Integrations page](overview.md#accessing-integrations).
+1. Select **Redmine**.
+1. Select the checkbox under **Enable integration**.
+1. Fill in the required fields:
 
-   As an example, below is a configuration for a project named `gitlab-ci`.
+   - **Project URL**: The URL to the Redmine project to link to this GitLab project.
+   - **Issue URL**: The URL to the Redmine project issue to link to this GitLab project.
+     The URL must contain `:id`. GitLab replaces this ID with the issue number.
+   - **New issue URL**: The URL to use to create a new issue in the Redmine project linked to
+     this GitLab project.
+     <!-- The line below was originally added in January 2018: https://gitlab.com/gitlab-org/gitlab/-/commit/778b231f3a5dd42ebe195d4719a26bf675093350 -->
+     **This URL is not used and removal is planned in a future release.**
+     For more information, see [issue 327503](https://gitlab.com/gitlab-org/gitlab/-/issues/327503).
 
-   ![Redmine configuration](img/redmine_configuration.png)
+1. Select **Save changes** or optionally select **Test settings**.
 
-1. To disable the internal issue tracking system in a project, navigate to the General page, expand the [permissions](../settings/index.md#sharing-and-permissions) section and switch the **Issues** toggle to disabled.
+After you have configured and enabled Redmine, you see the Redmine link on the GitLab project pages,
+which takes you to your Redmine project.
 
-## Referencing issues in Redmine
+For example, this is a configuration for a project named `gitlab-ci`:
 
-Issues in Redmine can be referenced in two alternative ways:
+- Project URL: `https://redmine.example.com/projects/gitlab-ci`
+- Issue URL: `https://redmine.example.com/issues/:id`
+- New issue URL: `https://redmine.example.com/projects/gitlab-ci/issues/new`
 
-- `#<ID>` where `<ID>` is a number (example `#143`).
-- `<PROJECT>-<ID>` where `<PROJECT>` starts with a capital letter which is
-  then followed by capital letters, numbers or underscores, and `<ID>` is
-  a number (example `API_32-143`).
+You can also disable [GitLab internal issue tracking](../issues/index.md) in this project.
+Learn more about the steps and consequences of disabling GitLab issues in
+[Sharing and permissions](../settings/index.md#sharing-and-permissions).
 
-We suggest using the longer format if you have both internal and external issue trackers enabled. If you use the shorter format and an issue with the same ID exists in the internal issue tracker, the internal issue is linked.
+## Reference Redmine issues in GitLab
 
-Please note that `<PROJECT>` part is ignored and links always point to the
-address specified in `issues_url`.
+You can reference your Redmine issues using:
+
+- `#<ID>`, where `<ID>` is a number (example `#143`).
+- `<PROJECT>-<ID>`, for example `API_32-143`, where:
+  - `<PROJECT>` starts with a capital letter, followed by capital letters, numbers, or underscores.
+  - `<ID>` is a number.
+
+In links, the `<PROJECT>` part is ignored, and they always point to the address specified in **Issue URL**.
+
+We suggest using the longer format (`<PROJECT>-<ID>`) if you have both internal and external issue
+trackers enabled. If you use the shorter format, and an issue with the same ID exists in the
+internal issue tracker, the internal issue is linked.

locale/gitlab.pot

@@ -17746,7 +17746,10 @@ msgstr ""
 msgid "IssueTracker|EWM work items tracker"
 msgstr ""
 
-msgid "IssueTracker|Redmine issue tracker"
+msgid "IssueTracker|Use Redmine as the issue tracker."
+msgstr ""
+
+msgid "IssueTracker|Use Redmine as the issue tracker. %{docs_link}"
 msgstr ""
 
 msgid "IssueTracker|YouTrack issue tracker"