From: Philippe Perrin <philippe.perrin@sonarsource.com>
Date: Tue, 20 Apr 2021 16:46:48 +0000 (+0200)
Subject: SONAR-14728 Improve UX around scanner's download from an in-app tutorial
X-Git-Tag: 8.9.0.43852~53
X-Git-Url: https://source.dussan.org/?a=commitdiff_plain;h=c7ff9d6de3670cf3ea6cc87cbdfb1823a1c5ed6b;p=sonarqube.git

SONAR-14728 Improve UX around scanner's download from an in-app tutorial
---

diff --git a/server/sonar-web/src/main/js/components/tutorials/manual/commands/DotNetFramework.tsx b/server/sonar-web/src/main/js/components/tutorials/manual/commands/DotNetFramework.tsx
index af25c9819be..0ead421f64b 100644
--- a/server/sonar-web/src/main/js/components/tutorials/manual/commands/DotNetFramework.tsx
+++ b/server/sonar-web/src/main/js/components/tutorials/manual/commands/DotNetFramework.tsx
@@ -19,7 +19,6 @@
  */
 import * as React from 'react';
 import { FormattedMessage } from 'react-intl';
-import { Link } from 'react-router';
 import { translate } from 'sonar-ui-common/helpers/l10n';
 import { DotNetProps } from './DotNet';
 import DotNetExecute from './DotNetExecute';
@@ -39,21 +38,23 @@ export default function DotNetFramework(props: DotNetProps) {
         <h4 className="spacer-bottom huge-spacer-top">
           {translate('onboarding.analysis.msbuild.header')}
         </h4>
-        <p className="spacer-bottom markdown">
+        <p className="markdown">
           <FormattedMessage
             defaultMessage={translate('onboarding.analysis.msbuild.text')}
             id="onboarding.analysis.msbuild.text"
-            values={{ code: <code>%PATH%</code> }}
+            values={{
+              code: <code>%PATH%</code>,
+              link: (
+                <a
+                  href="https://redirect.sonarsource.com/doc/download-scanner-msbuild.html"
+                  rel="noopener noreferrer"
+                  target="_blank">
+                  {translate('onboarding.analysis.msbuild.docs_link')}
+                </a>
+              )
+            }}
           />
         </p>
-        <p>
-          <Link
-            className="button"
-            to="/documentation/analysis/scan/sonarscanner-for-msbuild/"
-            target="_blank">
-            {translate('download_verb')}
-          </Link>
-        </p>
       </div>
 
       <DotNetExecute commands={commands} />
diff --git a/server/sonar-web/src/main/js/components/tutorials/manual/commands/DownloadScanner.tsx b/server/sonar-web/src/main/js/components/tutorials/manual/commands/DownloadScanner.tsx
index 06bce10a168..81ef04c99b7 100644
--- a/server/sonar-web/src/main/js/components/tutorials/manual/commands/DownloadScanner.tsx
+++ b/server/sonar-web/src/main/js/components/tutorials/manual/commands/DownloadScanner.tsx
@@ -19,7 +19,6 @@
  */
 import * as React from 'react';
 import { FormattedMessage } from 'react-intl';
-import { Link } from 'react-router';
 import { translate } from 'sonar-ui-common/helpers/l10n';
 import { OSs } from '../../types';
 
@@ -27,7 +26,7 @@ interface Props {
   os: OSs;
 }
 
-export default function SQScanner(props: Props) {
+export default function DownloadScanner(props: Props) {
   const { os } = props;
   return (
     <div>
@@ -38,15 +37,18 @@ export default function SQScanner(props: Props) {
           id="onboarding.analysis.sq_scanner.text"
           values={{
             dir: <code>bin</code>,
-            env_var: <code>{os === OSs.Windows ? '%PATH%' : 'PATH'}</code>
+            env_var: <code>{os === OSs.Windows ? '%PATH%' : 'PATH'}</code>,
+            link: (
+              <a
+                href="https://redirect.sonarsource.com/doc/download-scanner.html"
+                rel="noopener noreferrer"
+                target="_blank">
+                {translate('onboarding.analysis.sq_scanner.docs_link')}
+              </a>
+            )
           }}
         />
       </p>
-      <p>
-        <Link className="button" to="/documentation/analysis/scan/sonarscanner/" target="_blank">
-          {translate('download_verb')}
-        </Link>
-      </p>
     </div>
   );
 }
diff --git a/server/sonar-web/src/main/js/components/tutorials/manual/commands/__tests__/__snapshots__/CLangGCCCommand-test.tsx.snap b/server/sonar-web/src/main/js/components/tutorials/manual/commands/__tests__/__snapshots__/CLangGCCCommand-test.tsx.snap
index a1bc4455cf1..7539b8cf22d 100644
--- a/server/sonar-web/src/main/js/components/tutorials/manual/commands/__tests__/__snapshots__/CLangGCCCommand-test.tsx.snap
+++ b/server/sonar-web/src/main/js/components/tutorials/manual/commands/__tests__/__snapshots__/CLangGCCCommand-test.tsx.snap
@@ -5,7 +5,7 @@ exports[`Shoud renders correctly 1`] = `
   <DownloadBuildWrapper
     os="linux"
   />
-  <SQScanner
+  <DownloadScanner
     os="linux"
   />
   <ExecBuildWrapper
diff --git a/server/sonar-web/src/main/js/components/tutorials/manual/commands/__tests__/__snapshots__/DotNetFramework-test.tsx.snap b/server/sonar-web/src/main/js/components/tutorials/manual/commands/__tests__/__snapshots__/DotNetFramework-test.tsx.snap
index d52952a093e..986272b490d 100644
--- a/server/sonar-web/src/main/js/components/tutorials/manual/commands/__tests__/__snapshots__/DotNetFramework-test.tsx.snap
+++ b/server/sonar-web/src/main/js/components/tutorials/manual/commands/__tests__/__snapshots__/DotNetFramework-test.tsx.snap
@@ -9,7 +9,7 @@ exports[`Should renders correctly 1`] = `
       onboarding.analysis.msbuild.header
     </h4>
     <p
-      className="spacer-bottom markdown"
+      className="markdown"
     >
       <FormattedMessage
         defaultMessage="onboarding.analysis.msbuild.text"
@@ -19,21 +19,17 @@ exports[`Should renders correctly 1`] = `
             "code": <code>
               %PATH%
             </code>,
+            "link": <a
+              href="https://redirect.sonarsource.com/doc/download-scanner-msbuild.html"
+              rel="noopener noreferrer"
+              target="_blank"
+            >
+              onboarding.analysis.msbuild.docs_link
+            </a>,
           }
         }
       />
     </p>
-    <p>
-      <Link
-        className="button"
-        onlyActiveOnIndex={false}
-        style={Object {}}
-        target="_blank"
-        to="/documentation/analysis/scan/sonarscanner-for-msbuild/"
-      >
-        download_verb
-      </Link>
-    </p>
   </div>
   <DotNetExecute
     commands={
diff --git a/server/sonar-web/src/main/js/components/tutorials/manual/commands/__tests__/__snapshots__/DownloadScanner-test.tsx.snap b/server/sonar-web/src/main/js/components/tutorials/manual/commands/__tests__/__snapshots__/DownloadScanner-test.tsx.snap
index 5437c936d72..6b24f51e05c 100644
--- a/server/sonar-web/src/main/js/components/tutorials/manual/commands/__tests__/__snapshots__/DownloadScanner-test.tsx.snap
+++ b/server/sonar-web/src/main/js/components/tutorials/manual/commands/__tests__/__snapshots__/DownloadScanner-test.tsx.snap
@@ -21,21 +21,17 @@ exports[`Shoud renders for "linux" correctly 1`] = `
           "env_var": <code>
             PATH
           </code>,
+          "link": <a
+            href="https://redirect.sonarsource.com/doc/download-scanner.html"
+            rel="noopener noreferrer"
+            target="_blank"
+          >
+            onboarding.analysis.sq_scanner.docs_link
+          </a>,
         }
       }
     />
   </p>
-  <p>
-    <Link
-      className="button"
-      onlyActiveOnIndex={false}
-      style={Object {}}
-      target="_blank"
-      to="/documentation/analysis/scan/sonarscanner/"
-    >
-      download_verb
-    </Link>
-  </p>
 </div>
 `;
 
@@ -60,21 +56,17 @@ exports[`Shoud renders for "mac" correctly 1`] = `
           "env_var": <code>
             PATH
           </code>,
+          "link": <a
+            href="https://redirect.sonarsource.com/doc/download-scanner.html"
+            rel="noopener noreferrer"
+            target="_blank"
+          >
+            onboarding.analysis.sq_scanner.docs_link
+          </a>,
         }
       }
     />
   </p>
-  <p>
-    <Link
-      className="button"
-      onlyActiveOnIndex={false}
-      style={Object {}}
-      target="_blank"
-      to="/documentation/analysis/scan/sonarscanner/"
-    >
-      download_verb
-    </Link>
-  </p>
 </div>
 `;
 
@@ -99,20 +91,16 @@ exports[`Shoud renders for "win" correctly 1`] = `
           "env_var": <code>
             %PATH%
           </code>,
+          "link": <a
+            href="https://redirect.sonarsource.com/doc/download-scanner.html"
+            rel="noopener noreferrer"
+            target="_blank"
+          >
+            onboarding.analysis.sq_scanner.docs_link
+          </a>,
         }
       }
     />
   </p>
-  <p>
-    <Link
-      className="button"
-      onlyActiveOnIndex={false}
-      style={Object {}}
-      target="_blank"
-      to="/documentation/analysis/scan/sonarscanner/"
-    >
-      download_verb
-    </Link>
-  </p>
 </div>
 `;
diff --git a/server/sonar-web/src/main/js/components/tutorials/manual/commands/__tests__/__snapshots__/Other-test.tsx.snap b/server/sonar-web/src/main/js/components/tutorials/manual/commands/__tests__/__snapshots__/Other-test.tsx.snap
index f031c8c142c..2d3b3086434 100644
--- a/server/sonar-web/src/main/js/components/tutorials/manual/commands/__tests__/__snapshots__/Other-test.tsx.snap
+++ b/server/sonar-web/src/main/js/components/tutorials/manual/commands/__tests__/__snapshots__/Other-test.tsx.snap
@@ -2,7 +2,7 @@
 
 exports[`renders correctly 1`] = `
 <div>
-  <SQScanner
+  <DownloadScanner
     os="linux"
   />
   <ExecScanner
diff --git a/sonar-core/src/main/resources/org/sonar/l10n/core.properties b/sonar-core/src/main/resources/org/sonar/l10n/core.properties
index c724f9f7161..9dd484cc546 100644
--- a/sonar-core/src/main/resources/org/sonar/l10n/core.properties
+++ b/sonar-core/src/main/resources/org/sonar/l10n/core.properties
@@ -3375,25 +3375,16 @@ onboarding.analysis.java.gradle.header.sonarcloud=Execute the Scanner for Gradle
 onboarding.analysis.java.gradle.text.1.sonarcloud=Declare the {plugin} plugin in your {file} file:
 onboarding.analysis.java.gradle.text.2.sonarcloud=and add the following lines to your {file} file:
 
-onboarding.analysis.msbuild.header=Download and unzip the Scanner for MSBuild
-onboarding.analysis.msbuild.text=And add the executable's directory to the {code} environment variable
+onboarding.analysis.msbuild.header=Download and unzip the Scanner for .NET
+onboarding.analysis.msbuild.text=Visit the {link} to download the latest version, and add the executable's directory to the {code} environment variable
 onboarding.analysis.msbuild.execute=Execute the Scanner for .NET from your computer
 onboarding.analysis.msbuild.execute.text=Running a {instance} analysis is straighforward. You just need to execute the following commands at the root of your solution.
 onboarding.analysis.msbuild.docs_link=official documentation of the Scanner for .NET
-onboarding.analysis.msbuild.header.sonarcloud=Download and unzip the Scanner for MSBuild
-onboarding.analysis.msbuild.text.sonarcloud=And add the executable's directory to the <code>%PATH%</code> environment variable
-onboarding.analysis.msbuild.execute.sonarcloud=Execute the Scanner for MSBuild from your computer
-onboarding.analysis.msbuild.execute.text.sonarcloud=Execute the following commands at the root of your solution.
 
 onboarding.analysis.sq_scanner.header.linux=Download and unzip the Scanner for Linux
 onboarding.analysis.sq_scanner.header.win=Download and unzip the Scanner for Windows
 onboarding.analysis.sq_scanner.header.mac=Download and unzip the Scanner for macOS
-onboarding.analysis.sq_scanner.text=And add the {dir} directory to the {env_var} environment variable
-onboarding.analysis.sq_scanner.text.linux=And add the <code>bin</code> directory to the <code>PATH</code> environment variable
-onboarding.analysis.sq_scanner.text.win=And add the <code>bin</code> directory to the <code>%PATH%</code> environment variable
-onboarding.analysis.sq_scanner.text.mac=And add the <code>bin</code> directory to the <code>PATH</code> environment variable
-onboarding.analysis.sq_scanner.text.ci=And add the <code>bin</code> directory to the <code>PATH</code> environment variable
-onboarding.analysis.sq_scanner.text.sonarcloud=Add the following lines to your {file} file:
+onboarding.analysis.sq_scanner.text=Visit the {link} to download the latest version, and add the {dir} directory to the {env_var} environment variable
 onboarding.analysis.sq_scanner.execute=Execute the Scanner from your computer
 onboarding.analysis.sq_scanner.execute.text=Running a {instance} analysis is straighforward. You just need to execute the following commands in your project's folder.
 onboarding.analysis.sq_scanner.execute.text.custom=Run the following commands in your project's folder.