Rename docs to site (#1550)

Signed-off-by: Marinov Avgustin <Avgustin.Marinov@bosch.com>
2024-01-18 15:31:20 +02:00
parent d15bcce8d2
commit f2a4f6f591
106 changed files with 5 additions and 25 deletions
--- a/site/layouts/partials/copyright.html
+++ b/site/layouts/partials/copyright.html
@@ -0,0 +1,33 @@
+<aside class="copyright" role="note">
+  <div class="logo">
+    <a href="https://www.eclipse.org" target="_blank">
+      <img src="/hawkbit/images/eclipse_foundation_logo.png" />
+    </a>
+  </div>
+  <p class="notice">
+    {{ with .Site.Params.copyright }}
+    &copy; {{ now.Year }} {{ . }} &ndash;
+    {{ end }}
+    Documentation built with
+    <a href="https://www.gohugo.io" target="_blank">Hugo</a>
+    using the
+    <a href="http://github.com/digitalcraftsman/hugo-material-docs" target="_blank">Material</a> theme.
+  </p>
+  <p class="quickLinks">
+    <a href="http://www.eclipse.org/legal/privacy.php" target="_blank">
+      &gt; Privacy Policy
+    </a>
+    <a href="http://www.eclipse.org/legal/termsofuse.php" target="_blank">
+      &gt; Terms of Use
+    </a>
+    <a href="http://www.eclipse.org/legal/copyright.php" target="_blank">
+      &gt; Copyright Agent
+    </a>
+    <a href="http://www.eclipse.org/legal" target="_blank">
+      &gt; Legal
+    </a>
+    <a href="https://www.eclipse.org/org/documents/epl-2.0/EPL-2.0.txt" target="_blank">
+      &gt; License
+    </a>
+  </p>
+</aside>
--- a/site/layouts/partials/drawer.html
+++ b/site/layouts/partials/drawer.html
@@ -0,0 +1,74 @@
+<nav aria-label="Navigation">
+  <a href="{{ with .Site.BaseURL }}{{ . }}{{ else }}{{ .Site.BaseURL }}{{ end }}" class="project">
+    <div class="banner">
+      {{ with .Site.Params.logo }}
+        <div class="logo">
+          <img src="{{ $.Site.BaseURL }}{{ . }}">
+        </div>
+      {{ end }}
+      <div class="name">
+        <strong>{{ .Site.Title }}&trade; {{ with .Site.Params.version }}<span class="version">{{ . }}</span>{{ end }}</strong>
+        {{ with .Scratch.Get "repo_id" }}
+          <br>
+          {{ . }}
+        {{ end }}
+      </div>
+    </div>
+  </a>
+
+  <div class="scrollable">
+    <div class="wrapper">
+      {{ if (eq (trim .Site.Params.provider " " | lower) "github") | and (isset .Site.Params "repo_url") }}
+        <ul class="repo">
+          <li class="repo-download">
+            <a href="https://hawkbit.eclipseprojects.io" target="_blank" title="hawkBit Sandbox" data-action="sandbox">
+              <i class="fas fa-desktop"></i> &nbsp; Sandbox
+            </a>
+          </li>
+          <li class="repo-stars">
+            <a href="{{ .Site.Params.repo_url }}/stargazers" target="_blank" title="Stargazers" data-action="star">
+              <i class="icon icon-star"></i> Stars
+              <span class="count">&ndash;</span>
+            </a>
+          </li>
+        </ul>
+        <hr>
+      {{ end }}
+
+      <div class="toc">
+        {{ if gt (len .Site.Menus.main) 0 }}
+        <ul>
+          {{ partial "nav" . }}
+        </ul>
+        {{ end }}
+
+        {{ if isset .Site.Params "author" }}
+        <hr>
+
+        <ul>
+          <li>
+            <a href="https://circleci.com/gh/eclipse/hawkbit" title="Circle CI Status" target="_blank">
+              <img src="https://circleci.com/gh/eclipse/hawkbit.svg?style=shield" />
+            </a>
+          </li>
+          <li>
+            <a href="https://sonarcloud.io/organizations/bosch-iot-rollouts/projects?sort=name" title="Sonarcloud Status" target="_blank">
+              <img src="https://sonarcloud.io/api/project_badges/measure?project=org.eclipse.hawkbit%3Ahawkbit-parent&metric=alert_status" />
+            </a>
+          </li>
+          <li>
+            <a href="https://maven-badges.herokuapp.com/maven-central/org.eclipse.hawkbit/hawkbit-parent" title="Maven Central Status" target="_blank">
+              <img src="https://maven-badges.herokuapp.com/maven-central/org.eclipse.hawkbit/hawkbit-parent/badge.svg" />
+            </a>
+          </li>
+          <li>
+            <a href="https://gitter.im/eclipse/hawkbit?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge" title="Chat on Gitter" target="_blank">
+              <img src="https://badges.gitter.im/eclipse/hawkbit.svg" />
+            </a>
+          </li>
+        </ul>
+        {{ end }}
+      </div>
+    </div>
+  </div>
+</nav>
--- a/site/layouts/partials/footer_js.html
+++ b/site/layouts/partials/footer_js.html
@@ -0,0 +1,60 @@
+    <script>
+    {{ with .Scratch.Get "repo_id" }}
+      var base_url = '{{ (printf "%s" $.Site.BaseURL) | safeJS }}';
+      var repo_id  = '{{ . | safeJS }}';
+    {{ else }}
+      var base_url = '';
+      var repo_id  = '';
+    {{ end }}
+    </script>
+
+    <script src="{{ "javascripts/application.js" | absURL }}"></script>
+    {{ range .Site.Params.custom_js }}
+    <script src="{{ . | absURL }}"></script>
+    {{ end }}
+
+    <script>
+      {{ "/* Add headers to scrollspy */" | safeJS }}
+      var headers   = document.getElementsByTagName("h2");
+      var scrollspy = document.getElementById('scrollspy');
+
+      if(scrollspy) {
+          if(headers.length > 0) {
+              for(var i = 0; i < headers.length; i++) {
+                  var li = document.createElement("li");
+                  li.setAttribute("class", "anchor");
+
+                  var a  = document.createElement("a");
+                  if(!headers[i].id)
+                      a.setAttribute("href", headers[i].parentNode.href);
+                  else
+                      a.setAttribute("href", "#" + headers[i].id);
+                  a.setAttribute("title", headers[i].innerHTML);
+                  a.innerHTML = headers[i].innerHTML;
+
+                  li.appendChild(a);
+                  scrollspy.appendChild(li);
+              }
+          } else {
+              scrollspy.parentElement.removeChild(scrollspy)
+          }
+
+
+        {{ "/* Add permanent link next to the headers */" | safeJS }}
+          var headers = document.querySelectorAll("h1, h2, h3, h4, h5, h6");
+
+        for(var i = 0; i < headers.length; i++) {
+            var a = document.createElement("a");
+            a.setAttribute("class", "headerlink");
+            a.setAttribute("href", "#" + headers[i].id);
+            a.setAttribute("title", "Permanent link");
+            a.innerHTML = {{ or .Site.Params.permalink "¶" }};
+            headers[i].appendChild(a);
+        }
+      }
+    </script>
+
+    <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.8.0/highlight.min.js"></script>
+    <script>hljs.initHighlightingOnLoad();</script>
+  </body>
+</html>
--- a/site/layouts/partials/head.html
+++ b/site/layouts/partials/head.html
@@ -0,0 +1,83 @@
+<!DOCTYPE html>
+  <!--[if lt IE 7 ]><html class="no-js ie6"><![endif]-->
+  <!--[if IE 7 ]><html class="no-js ie7"><![endif]-->
+  <!--[if IE 8 ]><html class="no-js ie8"><![endif]-->
+  <!--[if IE 9 ]><html class="no-js ie9"><![endif]-->
+  <!--[if (gt IE 9)|!(IE)]><!--> <html class="no-js"> <!--<![endif]-->
+
+  <head {{ with .Site.LanguageCode }}lang="{{ . }}"{{ end }}>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,user-scalable=no,initial-scale=1,maximum-scale=1">
+    <meta http-equiv="X-UA-Compatible" content="IE=10" />
+    <title>{{ .Title }}{{ if not .IsHome }} - {{ .Site.Title }}{{ end }}</title>
+    {{ hugo.Generator }}
+
+    {{ with .Site.Params.description }}
+    <meta name="description" content="{{ . }}">
+    {{ end }}
+    <link rel="canonical" href="{{ .Permalink }}">
+    {{ with .Site.Params.author }}
+    <meta name="author" content="{{ . }}">
+    {{ end }}
+
+    <meta property="og:url" content="{{ .Permalink }}">
+    {{ with .Site.Title }}<meta property="og:title" content="{{ . }}">{{ end }}
+    {{ with .Site.Params.logo }}<meta property="og:image" content="{{ . | absURL }}">{{ end }}
+    {{ with .Site.Title }}<meta name="apple-mobile-web-app-title" content="{{ . }}">{{ end }}
+    <meta name="apple-mobile-web-app-capable" content="yes">
+    <meta name="apple-mobile-web-app-status-bar-style" content="black-translucent">
+
+    {{ if .Params.redirectURL }}<meta http-equiv="refresh" content="1; url={{ .Params.redirectURL }}"/>{{ end }}
+
+    <link rel="shortcut icon" type="image/x-icon" href="{{ with .Site.Params.favicon }}{{ . | absURL }}{{ else }}{{ "images/favicon.ico" | absURL }}{{ end }}">
+    <link rel="icon" type="image/x-icon" href="{{ with .Site.Params.favicon }}{{ . | absURL }}{{ else }}{{ "images/favicon.ico" | absURL }}{{ end }}">
+
+    <style>
+      @font-face {
+        font-family: 'Icon';
+        src: url('{{ "fonts/icon.eot?52m981" | absURL }}');
+        src: url('{{ "fonts/icon.eot?#iefix52m981" | absURL }}')
+               format('embedded-opentype'),
+             url('{{ "fonts/icon.woff?52m981" | absURL }}')
+               format('woff'),
+             url('{{ "fonts/icon.ttf?52m981" | absURL }}')
+               format('truetype'),
+             url('{{ "fonts/icon.svg?52m981#icon" | absURL }}')
+               format('svg');
+        font-weight: normal;
+        font-style: normal;
+      }
+    </style>
+
+    <link rel="stylesheet" href="{{ "stylesheets/application.css" | absURL }}">
+    <link rel="stylesheet" href="{{ "stylesheets/temporary.css" | absURL }}">
+    <link rel="stylesheet" href="{{ "stylesheets/palettes.css" | absURL }}">
+    <link rel="stylesheet" href="{{ with .Site.Params.highlight_css }}{{ . | absURL }}{{ else }}{{ "stylesheets/highlight/highlight.css" | absURL }}{{ end }}">
+
+    {{/* set default values if no custom ones are defined */}}
+    {{ $text := or .Site.Params.font.text "Roboto" }}
+    {{ $code := or .Site.Params.font.code "Roboto Mono" }}
+    <link rel="stylesheet" href="//fonts.googleapis.com/css?family={{ $text }}:400,700|{{ replace  $code " " "+" | safeURL }}">
+    <style>
+      body, input {
+        font-family: '{{ $text }}', Helvetica, Arial, sans-serif;
+      }
+      pre, code {
+        font-family: '{{ $code }}', 'Courier New', 'Courier', monospace;
+      }
+    </style>
+
+    {{ range .Site.Params.custom_css }}
+    <link rel="stylesheet" href="{{ . | absURL }}">
+    {{ end }}
+    <script src="{{ "javascripts/modernizr.js" | absURL }}"></script>
+    <script src="//www.eclipse.org/eclipse.org-common/themes/solstice/public/javascript/vendor/cookieconsent/default.min.js"></script>
+
+    {{ with .OutputFormats.Get "RSS" }}
+    <link href="{{ . }}" rel="alternate" type="application/rss+xml" title="{{ $.Site.Title }}" />
+    <link href="{{ . }}" rel="feed" type="application/rss+xml" title="{{ $.Site.Title }}" />
+    {{ end }}
+
+    <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.1.0/css/all.css" integrity="sha384-lKuwvrZot6UHsBSfcMvOkWwlCMgc0TaWr+30HWe3a4ltaBwTZhyTEggF5tJv8tbt" crossorigin="anonymous">
+  </head>
+  <body class="{{ with .Site.Params.palette.primary }}palette-primary-{{ . }}{{end }} {{ with .Site.Params.palette.accent }}palette-accent-{{ .  }}{{ end }}">
--- a/site/layouts/partials/header.html
+++ b/site/layouts/partials/header.html
@@ -0,0 +1,57 @@
+<nav aria-label="Header">
+  <div class="bar default">
+    <div class="button button-menu" role="button" aria-label="Menu">
+      <label class="toggle-button icon icon-menu" for="toggle-drawer">
+        <span></span>
+      </label>
+    </div>
+    <div class="stretch">
+      <div class="title">
+        {{ .Title | safeHTML }}
+      </div>
+    </div>
+
+    {{ with .Site.Social.twitter }}
+    <div class="button button-twitter" role="button" aria-label="Twitter">
+       <a href="https://twitter.com/{{ . }}" title="@{{ . }} on Twitter" target="_blank" class="toggle-button icon icon-twitter"></a>
+    </div>
+    {{ end }}
+
+    {{ with .Site.Social.github }}
+    <div class="button button-github" role="button" aria-label="GitHub">
+      <a href="https://github.com/{{ . }}" title="@{{ . }} on GitHub" target="_blank" class="toggle-button icon icon-github"></a>
+    </div>
+    {{ end }}
+
+    {{ with .Site.Social.gitter }}
+    <div class="button button-github" role="button" aria-label="Gitter">
+      <a href="https://gitter.im/{{ . }}" title="@{{ . }} on Gitter" target="_blank" class="toggle-button icon fab fa-gitter"></a>
+    </div>
+    {{ end }}
+
+    {{ with .Site.Social.docker }}
+    <div class="button button-github" role="button" aria-label="Docker">
+      <a href="https://hub.docker.com/u/{{ . }}" title="{{ . }} on Docker Hub" target="_blank" class="toggle-button icon fab fa-docker"></a>
+    </div>
+    {{ end }}
+    
+    <!-- TODO: disabled until Hugo supports the generation of a content index natively 
+    <div class="button button-search" role="button" aria-label="Search">
+      <label class="toggle-button icon icon-search" title="Search" for="toggle-search"></label>
+    </div>
+    -->    
+  </div>
+  <div class="bar search">
+    <div class="button button-close" role="button" aria-label="Close">
+      <label class="toggle-button icon icon-back" for="toggle-search"></label>
+    </div>
+    <div class="stretch">
+      <div class="field">
+        <input class="query" type="text" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck>
+      </div>
+    </div>
+    <div class="button button-reset" role="button" aria-label="Search">
+      <button class="toggle-button icon icon-close" id="reset-search"></button>
+    </div>
+  </div>
+</nav>
--- a/site/layouts/partials/nav_link.html
+++ b/site/layouts/partials/nav_link.html
@@ -0,0 +1,13 @@
+{{ $currentMenuEntry := .Scratch.Get "currentMenuEntry" }}
+{{ $isCurrent := eq .Permalink ($currentMenuEntry.URL | absURL | printf "%s") }}
+
+
+<a {{ if $isCurrent }}class="current"{{ end }} title="{{ $currentMenuEntry.Name }}" href="{{ $currentMenuEntry.URL }}">
+	{{ $currentMenuEntry.Pre }}
+	{{ $currentMenuEntry.Name }}
+</a>
+
+{{ if $isCurrent }}
+<ul id="scrollspy">
+</ul>
+{{ end }}