Insider features

.circleci/config.yml

@@ -72,8 +72,7 @@ jobs:
             python3 -m venv venv
             . venv/bin/activate
             pip install --upgrade pip
-            pip install -q -r CI/requirements-mkdocs-material.txt
-            pip install -q -r CI/requirements.txt
+            pip install -q -r CI/requirements-mkdocs-material.txt -r CI/requirements.txt
       - save_cache:
           paths:
             - ./venv

.gitignore

@@ -6,3 +6,5 @@ node_modules/
 .circleci/process.yml
 .DS_Store
 *.log
+.lh
+.run

.readthedocs.yaml

@@ -16,5 +16,5 @@ python:
     - requirements: CI/requirements.txt
 
 mkdocs:
-  configuration: mkdocs.yml
-  fail_on_warning: false
+  configuration: mkdocs-insider.yml
+  fail_on_warning: true

CI/requirements.txt

@@ -1,10 +1,8 @@
-Markdown==3.4.1
 markdown-fenced-code-tabs==1.0.5
-markdown-include==0.6.0
+markdown-include==0.7.0
 mkdocs-markdownextradata-plugin==0.2.5
 mkdocs-exclude==1.0.2
 mkdocs-redirects==1.0.4
 mkdocs-git-revision-date-localized-plugin==1.1.0
 mkdocs-minify-plugin==0.5.0
-plantuml-markdown==3.5.3
-
+plantuml-markdown==3.6.2

custom_theme/assets/stylesheets/custom_theme.css

@@ -1,79 +1,106 @@
-.feedback{
+/*Light and dark scheme dependent colour variables*/
+
+:root, [data-md-color-scheme=default] {
+  --mdx-version-notice-bg-color: #ff8721;
+  --mdx-custom-footer-bg-color: #00bda4;
+  --mdx-custom-footer-fg-color: #000;
+  --mdx-admonition-critical-border-color: rgb(220, 0, 0);
+  --mdx-admonition-critical-bg-color: rgb(250, 150, 150);
+  --mdx-admonition-critical-title-color: #FFF;
+}
+:root, [data-md-color-scheme=slate] {
+  --mdx-version-notice-bg-color: #d26000;
+  --mdx-custom-footer-bg-color: #008c7b;
+  --mdx-custom-footer-fg-color: #fff;
+  --mdx-admonition-critical-border-color: rgb(220, 0, 0);
+  --mdx-admonition-critical-bg-color: rgb(160, 0, 0);
+  --mdx-admonition-critical-title-color: #FFF;
+}
+
+/*Footer feedback banner*/
+.custom-footer{
   padding: 1em;
   text-align: center;
-  background-color: lightseagreen;
+  color: var(--mdx-custom-footer-fg-color);
+  background-color: var(--mdx-custom-footer-bg-color);
 }
-.feedback a {
-  color: white !important;
+.custom-footer a {
+  color: var(--mdx-custom-footer-fg-color) !important;
 }
+
+/*Navigation customisation*/
 .md-nav--secondary .md-nav__item .md-nav__item a.md-nav__link {
   font-weight: normal;
   font-size: inherit;
 }
 .md-nav--secondary a.md-nav__link {
     font-weight: bolder;
-    <!--font-size: larger;-->
 }
 
+/*Readthedocs version box customisation*/
 .rst-versions {
-  border-color: lightseagreen !important;
+  border-color: var(--md-accent-fg-color) !important;
   border-style: solid !important;
   font-size: large;
 }
 
 .rst-versions .rst-current-version {
-  background-color: #475c64 !important;
+  background-color: var(--md-default-bg-color) !important;
 }
 
+/*Custom font for header permalinks*/
 .headerlink {
-  font-family: "Font Awesome 5 Free";
+  font-family: "Font Awesome 5 Free", sans-serif;
   font-weight: 900;
   font-size: small;
 }
 
+
+/*Latest doc version warning banner*/
 .latest-warning {
   display: none;
   padding: 1em;
-  background-color: orange;
-  color: black;
+  background-color: var(--mdx-version-notice-bg-color);
+  color: var(--md-typeset-color);
   font-size: 1.5em;
   text-align: center;
   width: inherit;
 }
 
+/*Page footer*/
 .md-footer-copyright {
     max-width: 100% !important;
 }
 
-.md-footer a[href^="http"]:after,
+/*External links arrow symbol*/
+.md-footer a[href^="http"]:not(.md-social__link):after,
 .feedback a[href^="http"]:after,
 .md-content a[href^="http"]:not(.md-content__icon):not(.md-content__button):after {
-  font-family: "Font Awesome 5 Free";
+  font-family: "Font Awesome 5 Free", sans-serif;
   font-weight: 900;
   font-size: small;
   content: " \f360";
 }
 
+/*Logo auto sizing*/
 #header-logo{
   width: auto;
 }
 
+/*Page last change date in italic*/
 .md-source-date {
   font-style: italic;
 }
 
-.md-sidebar__scrollwrap{
-  scroll-snap-type: none !important;
-}
-
+/*Critical admonition design*/
 :root {
   --md-admonition-icon--critical: url("data:image/svg+xml;charset=utf-8,<svg xmlns='http://www.w3.org/2000/svg' viewBox='0 0 24 24'><path d='M13 14h-2V9h2m0 9h-2v-2h2M1 21h22L12 2 1 21z'/></svg>")
 }
 
 .md-typeset .admonition.critical,
 .md-typeset details.critical {
-  border-color: rgb(222, 0, 0);
-  background-color: #ffaaaa;
+  border-color: var(--mdx-admonition-critical-border-color);
+  background-color: var(--mdx-admonition-critical-bg-color);
 }
 
 .md-typeset .admonition.critical strong{
@@ -82,13 +109,23 @@
 
 .md-typeset .critical > .admonition-title,
 .md-typeset .critical > summary {
-  color: white;
-  background-color: rgb(222, 0, 0);
-  border-color: rgb(222, 0, 0);
+  color: var(--mdx-admonition-critical-title-color);
+  background-color: var(--mdx-admonition-critical-border-color);
+  border-color: var(--mdx-admonition-critical-border-color);
 }
 .md-typeset .critical > .admonition-title::before,
 .md-typeset .critical > summary::before {
-  background-color: white;
+  background-color: var(--mdx-admonition-critical-title-color);
   -webkit-mask-image: var(--md-admonition-icon--critical);
   mask-image: var(--md-admonition-icon--critical);
 }
+
+/*Cookie consent*/
+.md-consent__overlay {
+  display: none;
+}
+
+.md-consent__inner {
+  background-color: var(--md-default-fg-color);
+  color: var(--md-default-bg-color);
+}

custom_theme/partials/content.html

@@ -16,3 +16,7 @@
   <h1>{{ page.title | d(config.site_name, true)}}</h1>
 {% endif %}
 {{ page.content }}
+
+{% if config.extra.is_insider %}
+  {% include "partials/feedback.html" %}
+{% endif %}

custom_theme/partials/footer.html

@@ -1,76 +1,55 @@
-<!--
-  Copyright (c) 2016-2020 Martin Donath <martin.donath@squidfunk.com>
-  Permission is hereby granted, free of charge, to any person obtaining a copy
-  of this software and associated documentation files (the "Software"), to
-  deal in the Software without restriction, including without limitation the
-  rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
-  sell copies of the Software, and to permit persons to whom the Software is
-  furnished to do so, subject to the following conditions:
-  The above copyright notice and this permission notice shall be included in
-  all copies or substantial portions of the Software.
-  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-  FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
-  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-  FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
-  IN THE SOFTWARE.
--->
-
-{% import "partials/language.html" as lang with context %}
-
-<div class="feedback md-typeset">
-  Questions or feedback? You can discuss <a href="{{config.extra.support.issues}}">issues</a> and obtain free support on <a href="{{config.extra.support.chat}}">{{config.site_name}} chat channel</a>.
-  <br/>
-  For <a href="{{config.extra.support.website}}">Hyperledger Besu</a> community support, contact the mailing list <a href="mailto:{{config.extra.support.email}}">{{config.extra.support.email}}</a>
-</div>
-
-<!-- Application footer -->
 <footer class="md-footer">
   {% if page.previous_page or page.next_page %}
-    {% if page.meta and page.meta.hide %}
-      {% set hidden = "hidden" if "footer" in page.meta.hide %}
-    {% endif %}
-    <nav class="md-footer__inner md-grid" aria-label="{{ lang.t('footer.title') }}" {{ hidden }}>
-      {% if page.previous_page %}
-        {% set direction = lang.t("footer.previous") %}
-        <a href="{{ page.previous_page.url | url }}" class="md-footer__link md-footer__link--prev" aria-label="{{ direction }}: {{ page.previous_page.title | e }}" rel="prev">
-          <div class="md-footer__button md-icon">
-            {% include ".icons/material/arrow-left.svg" %}
-          </div>
-          <div class="md-footer__title">
-            <div class="md-ellipsis">
+  {% if page.meta and page.meta.hide %}
+  {% set hidden = "hidden" if "footer" in page.meta.hide %}
+  {% endif %}
+  <nav class="md-footer__inner md-grid" aria-label="{{ lang.t('footer.title') }}" {{ hidden }}>
+    {% if page.previous_page %}
+    {% set direction = lang.t("footer.previous") %}
+    <a href="{{ page.previous_page.url | url }}" class="md-footer__link md-footer__link--prev" aria-label="{{ direction }}: {{ page.previous_page.title | e }}" rel="prev">
+      <div class="md-footer__button md-icon">
+        {% include ".icons/material/arrow-left.svg" %}
+      </div>
+      <div class="md-footer__title">
+        <div class="md-ellipsis">
               <span class="md-footer__direction">
                 {{ direction }}
               </span>
-              {{ page.previous_page.title }}
-            </div>
-          </div>
-        </a>
-      {% endif %}
-      {% if page.next_page %}
-        {% set direction = lang.t("footer.next") %}
-        <a href="{{ page.next_page.url | url }}" class="md-footer__link md-footer__link--next" aria-label="{{ direction }}: {{ page.next_page.title | e }}" rel="next">
-          <div class="md-footer__title">
-            <div class="md-ellipsis">
+          {{ page.previous_page.title }}
+        </div>
+      </div>
+    </a>
+    {% endif %}
+    {% if page.next_page %}
+    {% set direction = lang.t("footer.next") %}
+    <a href="{{ page.next_page.url | url }}" class="md-footer__link md-footer__link--next" aria-label="{{ direction }}: {{ page.next_page.title | e }}" rel="next">
+      <div class="md-footer__title">
+        <div class="md-ellipsis">
               <span class="md-footer__direction">
                 {{ direction }}
               </span>
-              {{ page.next_page.title }}
-            </div>
-          </div>
-          <div class="md-footer__button md-icon">
-            {% include ".icons/material/arrow-right.svg" %}
-          </div>
-        </a>
-      {% endif %}
-    </nav>
+          {{ page.next_page.title }}
+        </div>
+      </div>
+      <div class="md-footer__button md-icon">
+        {% include ".icons/material/arrow-right.svg" %}
+      </div>
+    </a>
+    {% endif %}
+  </nav>
   {% endif %}
+
+  <div class="custom-footer md-typeset">
+    Questions or feedback? You can discuss <a href="{{config.extra.support.issues}}">issues</a> and obtain free support on <a href="{{config.extra.support.chat}}">{{config.site_name}} chat channel</a>.
+    <br/>
+    For <a href="{{config.extra.support.website}}">Hyperledger Besu</a> community support, contact the mailing list <a href="mailto:{{config.extra.support.email}}">{{config.extra.support.email}}</a>
+  </div>
+
   <div class="md-footer-meta md-typeset">
     <div class="md-footer-meta__inner md-grid">
       {% include "partials/copyright.html" %}
       {% if config.extra.social %}
-        {% include "partials/social.html" %}
+      {% include "partials/social.html" %}
       {% endif %}
     </div>
   </div>

docs/index.md

@@ -7,6 +7,26 @@ description: Besu is an open-source Ethereum client developed under the Apache 2
 
 # Besu Ethereum client
 
+<div class="grid cards" markdown>
+
+* :material-book-open-variant: __Public networks__
+
+    ---
+
+    You can run Besu as an execution client on Ethereum Mainnet and Ethereum public testnets, such as Goerli and Sepolia.
+
+    [:octicons-arrow-right-24: Getting started](HowTo/Get-Started/System-Requirements/System-Requirements-Public.md)
+
+* :material-book-lock-outline: __Private networks__
+
+    ---
+
+    You can create or join a network not connected to Mainnet or a public testnet. Use private networks to develop enterprise applications requiring secure, high-performance transaction processing.
+
+    [:octicons-arrow-right-24: Getting started](HowTo/Get-Started/System-Requirements/System-Requirements-Private.md)
+
+</div>
+
 ## What is Hyperledger Besu?
 
 Hyperledger Besu is an open-source Ethereum client developed under the Apache 2.0 license and written in Java.

mkdocs-insider.yml

@@ -0,0 +1,27 @@
+---
+# Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+# an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations under the License.
+INHERIT: mkdocs.yml # DO NOT MODIFY THIS LINE
+
+plugins:
+  meta:
+    meta_file: '**/.meta.yml'
+
+extra:
+  # indicates to the templating system that the current build uses insider
+  # used to display insider only features in templates and prevent build fail on the normal version.
+  is_insider: true
+
+# The following has to be in this file and mkdocs.yml file because
+# readthedocs.org is overriding it wrong if not in the initial config file but in a child file.
+# The side effect is that it also allows us to have different scripts and CSS for insider theme
+extra_css:
+  - assets/stylesheets/custom_theme.css
+extra_javascript:
+  - assets/javascripts/custom_theme.js