From a62b5a388e6feb7798f66df105706572dcf38810 Mon Sep 17 00:00:00 2001
From: Andreas Dangel <andreas.dangel@pmd-code.org>
Date: Fri, 18 Sep 2020 10:45:00 +0200
Subject: [PATCH] [doc] Use new self hosted fontawesome

Note: the css class "fa" is deprecated and "fas" should be used
instead. "fab" is for branding icons (like github).
---
 docs/_data/alerts.yml                           | 8 ++++----
 docs/_includes/custom/knowledge_base_topic.html | 7 ++++---
 docs/_includes/custom/shuffle_panel.html        | 9 +++++----
 docs/_includes/custom/xpath_fun_doc.html        | 2 +-
 docs/_includes/feedback.html                    | 2 +-
 docs/_includes/head.html                        | 2 +-
 docs/_includes/head_print.html                  | 2 +-
 docs/_includes/important.html                   | 2 +-
 docs/_includes/note.html                        | 2 +-
 docs/_includes/tip.html                         | 2 +-
 docs/_includes/topnav.html                      | 4 ++--
 docs/_includes/warning.html                     | 2 +-
 docs/_layouts/page.html                         | 2 +-
 docs/index.md                                   | 7 ++++---
 14 files changed, 28 insertions(+), 25 deletions(-)

diff --git a/docs/_data/alerts.yml b/docs/_data/alerts.yml
index 157e1622b0..c32cfd683d 100644
--- a/docs/_data/alerts.yml
+++ b/docs/_data/alerts.yml
@@ -1,7 +1,7 @@
-tip: '<div class="alert alert-success" role="alert"><i class="fa fa-check-square-o"></i> <b>Tip: </b>'
-note: '<div class="alert alert-info" role="alert"><i class="fa fa-info-circle"></i> <b>Note: </b>'
-important: '<div class="alert alert-warning" role="alert"><i class="fa fa-warning"></i> <b>Important: </b>'
-warning: '<div class="alert alert-danger" role="alert"><i class="fa fa-exclamation-circle"></i> <b>Warning: </b>'
+tip: '<div class="alert alert-success" role="alert"><i class="fas fa-check-square-o"></i> <b>Tip: </b>'
+note: '<div class="alert alert-info" role="alert"><i class="fas fa-info-circle"></i> <b>Note: </b>'
+important: '<div class="alert alert-warning" role="alert"><i class="fas fa-warning"></i> <b>Important: </b>'
+warning: '<div class="alert alert-danger" role="alert"><i class="fas fa-exclamation-circle"></i> <b>Warning: </b>'
 end: '</div>'
 
 callout_danger: '<div class="bs-callout bs-callout-danger">'
diff --git a/docs/_includes/custom/knowledge_base_topic.html b/docs/_includes/custom/knowledge_base_topic.html
index 030d14e8f3..8181a0b685 100644
--- a/docs/_includes/custom/knowledge_base_topic.html
+++ b/docs/_includes/custom/knowledge_base_topic.html
@@ -1,6 +1,7 @@
 <!-- Argument summary: -->
 <!-- datagroup -->
-<!-- image -->
+<!-- fa-style, defaults to "fas" -->
+<!-- fa-icon -->
 <!-- title -->
 <!-- description -->
 
@@ -9,8 +10,8 @@
     <div class="panel panel-default text-center">
         <div class="panel-heading">
                      <span class="fa-stack fa-5x">
-                           <i class="fa fa-circle fa-stack-2x text-primary"></i>
-                           <i class="fa {{ include.image }} fa-stack-1x fa-inverse"></i>
+                           <i class="fas fa-circle fa-stack-2x text-primary"></i>
+                           <i class="{{ include.fa-style | default: "fas" }} {{ include.fa-icon }} fa-stack-1x fa-inverse"></i>
                      </span>
         </div>
         <div class="panel-body">
diff --git a/docs/_includes/custom/shuffle_panel.html b/docs/_includes/custom/shuffle_panel.html
index ffe3b4adb0..9cdb40ac4b 100644
--- a/docs/_includes/custom/shuffle_panel.html
+++ b/docs/_includes/custom/shuffle_panel.html
@@ -10,7 +10,8 @@
 <!-- description: Description of the panel -->
 <!-- datagroups: json array containing the data groups for the shuffle logic -->
 
-<!-- image (optional) : Name of the image to use, as a css class, eg "fa-list" -->
+<!-- fa-style (optional) : Name of the fontawesome style, e.g. "fas" (for solid), or "fab" (for brands). Default is "fas" -->
+<!-- fa-icon (optional) : Name of the fontwaresome icon to use, as a css class, eg. "fa-list" -->
 <!-- titlemaker (optional) : name of a variable that's evaluated to determine the displayed title of the page. Default is page.title -->
 
 
@@ -25,11 +26,11 @@
     <div class="panel panel-default">
 
 
-        {% if include.image != "" and include.image != nil %}
+        {% if include.fa-icon != "" and include.fa-icon != nil %}
             <div class="panel-heading text-center">
                      <span class="fa-stack fa-5x">
-                       <i class="fa fa-circle fa-stack-2x text-secondary"></i>
-                       <i class="fa {{ include.image }} fa-stack-1x fa-inverse"></i>
+                       <i class="fas fa-circle fa-stack-2x text-secondary"></i>
+                       <i class="{{ include.fa-style | default: "fas" }} {{ include.fa-icon }} fa-stack-1x fa-inverse"></i>
                      </span>
             </div>
         {% endif %}
diff --git a/docs/_includes/custom/xpath_fun_doc.html b/docs/_includes/custom/xpath_fun_doc.html
index 12a7781adf..90276cbb18 100644
--- a/docs/_includes/custom/xpath_fun_doc.html
+++ b/docs/_includes/custom/xpath_fun_doc.html
@@ -28,7 +28,7 @@
             <td>{{ fun.shortDescription }}</td>
             <td>
                 <button type="button" class="btn btn-link"><i
-                        class="fa fa-ellipsis-h"></i></button>
+                        class="fas fa-ellipsis-h"></i></button>
             </td>
         </tr>
 
diff --git a/docs/_includes/feedback.html b/docs/_includes/feedback.html
index 6031797fc8..c6d0fe28c6 100644
--- a/docs/_includes/feedback.html
+++ b/docs/_includes/feedback.html
@@ -8,6 +8,6 @@
 {% if site.feedback_link %}
   <a class="email" title="Submit feedback" href="{{site.feedback_link}}">{{feedback_text}}</a>
 {% else %}
-  <a class="email" title="Submit feedback" href="#" onclick="javascript:window.location='mailto:{{site.feedback_email}}?subject={{site.feedback_subject_line}} feedback&body=I have some feedback about the {{page.title}} page: ' + window.location.href;"><i class="fa fa-envelope-o"></i> {{feedback_text}}</a>
+  <a class="email" title="Submit feedback" href="#" onclick="javascript:window.location='mailto:{{site.feedback_email}}?subject={{site.feedback_subject_line}} feedback&body=I have some feedback about the {{page.title}} page: ' + window.location.href;"><i class="fas fa-envelope-o"></i> {{feedback_text}}</a>
 {% endif %}
 </li>
diff --git a/docs/_includes/head.html b/docs/_includes/head.html
index 8e115b3fa0..7863de9add 100644
--- a/docs/_includes/head.html
+++ b/docs/_includes/head.html
@@ -7,7 +7,7 @@
 <link rel="stylesheet" href="{{ "css/syntax.css" }}">
 
 
-<link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css">
+<link rel="stylesheet" type="text/css" href="assets/fontawesome-free-5.14.0-web/css/all.min.css">
 <!--<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css">-->
 <link rel="stylesheet" href="{{ "css/modern-business.css" }}">
 <link rel="stylesheet" href="{{ "css/lavish-bootstrap.css" }}">
diff --git a/docs/_includes/head_print.html b/docs/_includes/head_print.html
index 8f10c28f86..0eb8eb6438 100644
--- a/docs/_includes/head_print.html
+++ b/docs/_includes/head_print.html
@@ -7,7 +7,7 @@
 
 
 <link rel="stylesheet" href="{{ "/css/syntax.css" | prepend: site.baseurl | prepend: site.url }}">
-<link rel="stylesheet" href="{{ "/css/font-awesome.min.css" | prepend: site.baseurl | prepend: site.url }}">
+<link rel="stylesheet" href="{{ "/assets/fontawesome-free-5.14.0-web/css/all.min.css" | prepend: site.baseurl | prepend.site.url }}">
 <link rel="stylesheet" href="{{ "/css/bootstrap.min.css" | prepend: site.baseurl | prepend: site.url }}">
 <link rel="stylesheet" href="{{ "/css/modern-business.css" | prepend: site.baseurl | prepend: site.url }}">
 <link rel="stylesheet" href="{{ "/css/lavish-bootstrap.css" | prepend: site.baseurl | prepend: site.url }}">
diff --git a/docs/_includes/important.html b/docs/_includes/important.html
index af8824b9f4..02b194627e 100644
--- a/docs/_includes/important.html
+++ b/docs/_includes/important.html
@@ -1 +1 @@
-<div markdown="span" class="alert alert-warning" role="alert"><i class="fa fa-warning"></i> <b>Important:</b> {{include.content}}</div>
\ No newline at end of file
+<div markdown="span" class="alert alert-warning" role="alert"><i class="fas fa-warning"></i> <b>Important:</b> {{include.content}}</div>
\ No newline at end of file
diff --git a/docs/_includes/note.html b/docs/_includes/note.html
index 2c1cfe967c..e8ed7ab24a 100644
--- a/docs/_includes/note.html
+++ b/docs/_includes/note.html
@@ -1 +1 @@
-<div markdown="span" class="alert alert-info" role="alert"><i class="fa fa-info-circle"></i> <b>Note:</b> {{include.content}}</div>
+<div markdown="span" class="alert alert-info" role="alert"><i class="fas fa-info-circle"></i> <b>Note:</b> {{include.content}}</div>
diff --git a/docs/_includes/tip.html b/docs/_includes/tip.html
index faf48afd86..dd2b08449e 100644
--- a/docs/_includes/tip.html
+++ b/docs/_includes/tip.html
@@ -1 +1 @@
-<div markdown="span" class="alert alert-success" role="alert"><i class="fa fa-check-square-o"></i> <b>Tip:</b> {{include.content}}</div>
\ No newline at end of file
+<div markdown="span" class="alert alert-success" role="alert"><i class="fas fa-check-square-o"></i> <b>Tip:</b> {{include.content}}</div>
\ No newline at end of file
diff --git a/docs/_includes/topnav.html b/docs/_includes/topnav.html
index 39a172ad5a..7e4e9b846a 100644
--- a/docs/_includes/topnav.html
+++ b/docs/_includes/topnav.html
@@ -8,12 +8,12 @@
                 <span class="icon-bar"></span>
                 <span class="icon-bar"></span>
             </button>
-            <a class="fa fa-home fa-lg navbar-brand" href="index.html">&nbsp;<span class="projectTitle"> {{site.topnav_title}}</span></a>
+            <a class="fas fa-home fa-lg navbar-brand" href="index.html">&nbsp;<span class="projectTitle"> {{site.topnav_title}}</span></a>
         </div>
         <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
             <ul class="nav navbar-nav navbar-right">
                 <!-- toggle sidebar button -->
-                <li><a id="tg-sb-link" href="#"><i id="tg-sb-icon" class="fa fa-toggle-on"></i> Nav</a></li>
+                <li><a id="tg-sb-link" href="#"><i id="tg-sb-icon" class="fas fa-toggle-on"></i> Nav</a></li>
                 <!-- entries without drop-downs appear here -->
                 {% for entry in site.data.topnav.topnav %}
                 {% for item in entry.items %}
diff --git a/docs/_includes/warning.html b/docs/_includes/warning.html
index e08268c933..54ffb395f8 100644
--- a/docs/_includes/warning.html
+++ b/docs/_includes/warning.html
@@ -1 +1 @@
-<div markdown="span" class="alert alert-danger" role="alert"><i class="fa fa-exclamation-circle"></i> <b>Warning:</b> {{include.content}}</div>
\ No newline at end of file
+<div markdown="span" class="alert alert-danger" role="alert"><i class="fas fa-exclamation-circle"></i> <b>Warning:</b> {{include.content}}</div>
\ No newline at end of file
diff --git a/docs/_layouts/page.html b/docs/_layouts/page.html
index 8e65184b0e..fcda6e36a0 100644
--- a/docs/_layouts/page.html
+++ b/docs/_layouts/page.html
@@ -46,7 +46,7 @@ layout: default
             {% assign editmepath = page.editmepath %}
         {% endif %}
 
-    <a target="_blank" href="https://github.com/{{site.github_editme_path}}{{editmepath}}" class="btn btn-default githubEditButton" role="button"><i class="fa fa-github fa-lg"></i> Edit me</a>
+    <a target="_blank" href="https://github.com/{{site.github_editme_path}}{{editmepath}}" class="btn btn-default githubEditButton" role="button"><i class="fab fa-github fa-lg"></i> Edit me</a>
 
     {% endif %}
 
diff --git a/docs/index.md b/docs/index.md
index aa76696556..80c814c4b7 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -92,7 +92,7 @@ you may also use the search bar in the top right, or the sidebar on the left.
        tags="rule_references"
        datagroups='["userdocs"]'
        description="Pick your language to find out about the rule it supports."
-       image="fa-database"
+       fa-icon="fa-database"
        titlemaker="page.language_name" %}
 
     {% include custom/shuffle_panel.html
@@ -107,7 +107,7 @@ you may also use the search bar in the top right, or the sidebar on the left.
        tags="userdocs"
        except_tags="extending,tools"
        datagroups='["userdocs"]'
-       image="fa-cog"
+       fa-icon="fa-cog"
        description="Learn how to build effective and versatile rulesets."
     %}
 
@@ -117,7 +117,8 @@ you may also use the search bar in the top right, or the sidebar on the left.
        tags="devdocs"
        except_tags="extending"
        datagroups='["contributing"]'
-       image="fa-github"
+       fa-style="fab"
+       fa-icon="fa-github"
        description="If you'd like to help us build PMD, these topics may interest you. See you around!"
     %}