SONAR-12872 Rename Markdown Syntax to Formatting Syntax

5 files changed, 257 insertions, 11 deletions

diff --git a/server/sonar-web/src/main/js/app/components/MarkdownHelp.tsx b/server/sonar-web/src/main/js/app/components/FormattingHelp.tsx
index 278d742295c..a6e29c00405 100644
--- a/server/sonar-web/src/main/js/app/components/MarkdownHelp.tsx
+++ b/server/sonar-web/src/main/js/app/components/FormattingHelp.tsx
@@ -19,10 +19,10 @@
  */
 import * as React from 'react';
 
-export default function MarkdownHelp() {
+export default function FormattingHelp() {
   return (
     <div className="page page-limited">
-      <h2 className="spacer-bottom">Markdown Syntax</h2>
+      <h2 className="spacer-bottom">Formatting Syntax</h2>
       <table className="width-100 data zebra">
         <thead>
           <tr>
@@ -38,17 +38,15 @@ export default function MarkdownHelp() {
             </td>
           </tr>
           <tr>
-            <td>http://sonarqube.org</td>
+            <td>https://sonarqube.org</td>
             <td className="markdown">
-              <a href="http://sonarqube.org">http://sonarqube.org</a>
+              <a href="https://sonarqube.org">https://sonarqube.org</a>
             </td>
           </tr>
           <tr>
-            <td className="text-top">[SonarQube™ Home Page](http://www.sonarqube.org)</td>
+            <td className="text-top">[SonarQube™ Home Page](https://www.sonarqube.org)</td>
             <td className="markdown text-top">
-              <a href="http://www.sonarqube.org" rel="noopener noreferrer" target="_blank">
-                SonarQube™ Home Page
-              </a>
+              <a href="https://www.sonarqube.org">SonarQube™ Home Page</a>
             </td>
           </tr>
           <tr>
diff --git a/server/sonar-web/src/main/js/app/components/__tests__/FormattingHelp-test.tsx b/server/sonar-web/src/main/js/app/components/__tests__/FormattingHelp-test.tsx
new file mode 100644
index 00000000000..e5cd6729a2c
--- /dev/null
+++ b/server/sonar-web/src/main/js/app/components/__tests__/FormattingHelp-test.tsx
@@ -0,0 +1,27 @@
+/*
+ * SonarQube
+ * Copyright (C) 2009-2020 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+
+import { shallow } from 'enzyme';
+import * as React from 'react';
+import FormattingHelp from '../FormattingHelp';
+
+it('should render correctly', () => {
+  expect(shallow(<FormattingHelp />)).toMatchSnapshot();
+});
diff --git a/server/sonar-web/src/main/js/app/components/__tests__/__snapshots__/FormattingHelp-test.tsx.snap b/server/sonar-web/src/main/js/app/components/__tests__/__snapshots__/FormattingHelp-test.tsx.snap
new file mode 100644
index 00000000000..031748e845e
--- /dev/null
+++ b/server/sonar-web/src/main/js/app/components/__tests__/__snapshots__/FormattingHelp-test.tsx.snap
@@ -0,0 +1,220 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`should render correctly 1`] = `
+<div
+  className="page page-limited"
+>
+  <h2
+    className="spacer-bottom"
+  >
+    Formatting Syntax
+  </h2>
+  <table
+    className="width-100 data zebra"
+  >
+    <thead>
+      <tr>
+        <th>
+          Write:
+        </th>
+        <th>
+          To display:
+        </th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td>
+          *this text is bold*
+        </td>
+        <td
+          className="markdown"
+        >
+          <strong>
+            this text is bold
+          </strong>
+        </td>
+      </tr>
+      <tr>
+        <td>
+          https://sonarqube.org
+        </td>
+        <td
+          className="markdown"
+        >
+          <a
+            href="https://sonarqube.org"
+          >
+            https://sonarqube.org
+          </a>
+        </td>
+      </tr>
+      <tr>
+        <td
+          className="text-top"
+        >
+          [SonarQube™ Home Page](https://www.sonarqube.org)
+        </td>
+        <td
+          className="markdown text-top"
+        >
+          <a
+            href="https://www.sonarqube.org"
+          >
+            SonarQube™ Home Page
+          </a>
+        </td>
+      </tr>
+      <tr>
+        <td
+          className="text-top"
+        >
+          * first item
+          <br />
+          * second item
+        </td>
+        <td
+          className="markdown"
+        >
+          <ul>
+            <li>
+              first item
+            </li>
+            <li>
+              second item
+            </li>
+          </ul>
+        </td>
+      </tr>
+      <tr>
+        <td
+          className="text-top"
+        >
+          1. first item
+          <br />
+          1. second item
+        </td>
+        <td
+          className="markdown text-top"
+        >
+          <ol>
+            <li>
+              first item
+            </li>
+            <li>
+              second item
+            </li>
+          </ol>
+        </td>
+      </tr>
+      <tr>
+        <td
+          className="text-top"
+        >
+          = Heading Level 1
+          <br />
+          == Heading Level 2
+          <br />
+          === Heading Level 3
+          <br />
+          ==== Heading Level 4
+          <br />
+          ===== Heading Level 5
+          <br />
+          ====== Heading Level 6
+          <br />
+        </td>
+        <td
+          className="markdown text-top"
+        >
+          <h1>
+            Heading Level 1
+          </h1>
+          <h2>
+            Heading Level 2
+          </h2>
+          <h3>
+            Heading Level 3
+          </h3>
+          <h4>
+            Heading Level 4
+          </h4>
+          <h5>
+            Heading Level 5
+          </h5>
+          <h6>
+            Heading Level 6
+          </h6>
+        </td>
+      </tr>
+      <tr>
+        <td
+          className="text-top"
+        >
+          \`\`Lists#newArrayList()\`\`
+        </td>
+        <td
+          className="markdown text-top"
+        >
+          <code>
+            Lists#newArrayList()
+          </code>
+        </td>
+      </tr>
+      <tr>
+        <td
+          className="text-top"
+        >
+          \`\`
+          <br />
+          // code on multiple lines
+          <br />
+          public void foo() {
+          <br />
+            
+          // do some logic here
+          <br />
+          }
+          <br />
+          \`\`
+        </td>
+        <td
+          className="markdown text-top"
+        >
+          <pre>
+            // code on multiple lines
+public void foo() {
+  // do some logic here
+}
+          </pre>
+        </td>
+      </tr>
+      <tr>
+        <td
+          className="text-top"
+        >
+          Standard text
+          <br />
+          &gt; Blockquoted text
+          <br />
+          &gt; that spans multiple lines
+          <br />
+        </td>
+        <td
+          className="markdown text-top"
+        >
+          <p>
+            Standard text
+          </p>
+          <blockquote>
+            Blockquoted text
+            <br />
+            that spans multiple lines
+            <br />
+          </blockquote>
+        </td>
+      </tr>
+    </tbody>
+  </table>
+</div>
+`;
diff --git a/server/sonar-web/src/main/js/app/index.ts b/server/sonar-web/src/main/js/app/index.ts
index 715df897aa9..f58c8112b97 100644
--- a/server/sonar-web/src/main/js/app/index.ts
+++ b/server/sonar-web/src/main/js/app/index.ts
@@ -112,6 +112,6 @@ function isMainApp() {
     !pathname.startsWith(`${getBaseUrl()}/sessions`) &&
     !pathname.startsWith(`${getBaseUrl()}/maintenance`) &&
     !pathname.startsWith(`${getBaseUrl()}/setup`) &&
-    !pathname.startsWith(`${getBaseUrl()}/markdown/help`)
+    !pathname.startsWith(`${getBaseUrl()}/formatting/help`)
   );
 }
diff --git a/server/sonar-web/src/main/js/app/utils/startReactApp.tsx b/server/sonar-web/src/main/js/app/utils/startReactApp.tsx
index d48e43e2a9f..b667bf0d37e 100644
--- a/server/sonar-web/src/main/js/app/utils/startReactApp.tsx
+++ b/server/sonar-web/src/main/js/app/utils/startReactApp.tsx
@@ -142,6 +142,7 @@ function renderRedirects() {
       <Redirect from="/view" to="/portfolio" />
       <Redirect from="/users" to="/admin/users" />
       <Redirect from="/onboarding" to="/projects/create" />
+      <Redirect from="markdown/help" to="formatting/help" />
     </>
   );
 }
@@ -263,8 +264,8 @@ export default function startReactApp(
               {renderRedirects()}
 
               <Route
-                path="markdown/help"
-                component={lazyLoadComponent(() => import('../components/MarkdownHelp'))}
+                path="formatting/help"
+                component={lazyLoadComponent(() => import('../components/FormattingHelp'))}
               />
 
               <Route component={lazyLoadComponent(() => import('../components/SimpleContainer'))}>