added trademark signs in website/docs

* linked to SDKs in topnavbar * used GitHub icon * fixed broken links/tags in blogposts * moved old released notes to "archive" subfolder in navigation Signed-off-by: Thomas Jaeckle <thomas.jaeckle@bosch.io>
eclipse-ditto · Apr 8, 2021 · 1d85416 · 1d85416
1 parent 5ad09e9
commit 1d85416
Show file tree

Hide file tree

Showing 15 changed files with 91 additions and 64 deletions.
diff --git a/documentation/src/main/resources/_config.yml b/documentation/src/main/resources/_config.yml
@@ -3,14 +3,14 @@ repository: eclipse/ditto
 output: web
 # this property is useful for conditional filtering of content that is separate from the PDF.
 
-topnav_title: Eclipse Ditto
+topnav_title: Eclipse Ditto™
 # this appears on the top navigation bar next to the home button
 
-site_title: Eclipse Ditto • open source framework for digital twins in the IoT
-short_title: Eclipse Ditto • a digital twin framework
+site_title: Eclipse Ditto™ • open source framework for digital twins in the IoT
+short_title: Eclipse Ditto™ • a digital twin framework
 # this appears in the html browser tab for the site title (seen mostly by search engines, not users)
 
-company_name: Eclipse Ditto
+company_name: Eclipse Ditto™
 # this appears in the footer
 
 github_editme_path:

diff --git a/documentation/src/main/resources/_data/sidebars/ditto_sidebar.yml b/documentation/src/main/resources/_data/sidebars/ditto_sidebar.yml
@@ -2,7 +2,7 @@
 
 entries:
   - title: sidebar
-    product: Eclipse Ditto
+    product: Eclipse Ditto™
     folders:
 
       - title: Introduction
@@ -23,9 +23,9 @@ entries:
       - title: Release Notes
         output: web
         folderitems:
-          - title: 2.0.0
-            url: /release_notes_next.html
-            output: web
+#          - title: 2.0.0
+#            url: /release_notes_next.html
+#            output: web
           - title: 1.5.1
             url: /release_notes_151.html
             output: web
@@ -35,44 +35,44 @@ entries:
           - title: 1.4.0
             url: /release_notes_140.html
             output: web
-          - title: 1.3.0
-            url: /release_notes_130.html
-            output: web
-          - title: 1.2.1
-            url: /release_notes_121.html
-            output: web
-          - title: 1.2.0
-            url: /release_notes_120.html
-            output: web
-          - title: 1.1.5
-            url: /release_notes_115.html
-            output: web
-          - title: 1.1.3
-            url: /release_notes_113.html
-            output: web
-          - title: 1.1.2
-            url: /release_notes_112.html
-            output: web
-          - title: 1.1.1
-            url: /release_notes_111.html
-            output: web
-          - title: 1.1.0
-            url: /release_notes_110.html
-            output: web
-          - title: 1.0.0
-            url: /release_notes_100.html
-            output: web
-          - title: 0.9.0
-            url: /release_notes_090.html
-            output: web
-          - title: 0.8.0
-            url: /release_notes_080.html
-            output: web
 
             subfolders:
-              - title: Milestone releases
+              - title: Archive
                 output: web
                 subfolderitems:
+                  - title: 1.3.0
+                    url: /release_notes_130.html
+                    output: web
+                  - title: 1.2.1
+                    url: /release_notes_121.html
+                    output: web
+                  - title: 1.2.0
+                    url: /release_notes_120.html
+                    output: web
+                  - title: 1.1.5
+                    url: /release_notes_115.html
+                    output: web
+                  - title: 1.1.3
+                    url: /release_notes_113.html
+                    output: web
+                  - title: 1.1.2
+                    url: /release_notes_112.html
+                    output: web
+                  - title: 1.1.1
+                    url: /release_notes_111.html
+                    output: web
+                  - title: 1.1.0
+                    url: /release_notes_110.html
+                    output: web
+                  - title: 1.0.0
+                    url: /release_notes_100.html
+                    output: web
+                  - title: 0.9.0
+                    url: /release_notes_090.html
+                    output: web
+                  - title: 0.8.0
+                    url: /release_notes_080.html
+                    output: web
                   - title: 1.0.0-M2
                     url: /release_notes_100-M2.html
                     output: web

diff --git a/documentation/src/main/resources/_data/topnav.yml b/documentation/src/main/resources/_data/topnav.yml
@@ -10,9 +10,17 @@ topnav:
       url: /http-api-doc.html
     - title: Sandbox
       url: /sandbox.html
-    - title: GitHub
+    - title:
+      image: GitHub-Mark-Light-32px.png
+      alt: Sources at GitHub
       external_url: https://github.com/eclipse/ditto
-    - title: GitHub examples
+    - title: SDKs
+      image: GitHub-Mark-Light-32px.png
+      alt: SDK sources at GitHub
+      external_url: https://github.com/eclipse/ditto-clients
+    - title: examples
+      image: GitHub-Mark-Light-32px.png
+      alt: Example sources at GitHub
       external_url: https://github.com/eclipse/ditto-examples
 
 #Topnav dropdowns

diff --git a/documentation/src/main/resources/_includes/sidebar.html b/documentation/src/main/resources/_includes/sidebar.html
@@ -2,7 +2,7 @@
 
 <ul id="mysidebar" class="nav">
   <li class="sidebarTitle">
-    <label for="docVersion">{{sidebar[0].product}} {{sidebar[0].version}} version:</label>
+    <label for="docVersion">{{sidebar[0].product}} version:</label>
     <div class="select-wrapper">
       <select id="docVersion" name="docVersion">
         {% for docV in site.docVersions %}

diff --git a/documentation/src/main/resources/_includes/topnav.html b/documentation/src/main/resources/_includes/topnav.html
@@ -8,7 +8,7 @@
                 <span class="icon-bar"></span>
                 <span class="icon-bar"></span>
             </button>
-            <a class="navbar-ditto-home" href="index.html">&nbsp;<img src="images/ditto_allwhite_symbolonly.svg" class="ditto-navbar-symbol" alt="Home"> <img src="images/ditto_allwhite_textonly.svg" class="ditto-navbar-symbol-text" alt="Ditto"></a>
+            <a class="navbar-ditto-home" href="index.html">&nbsp;<img src="images/ditto_allwhite_symbolonly.svg" class="ditto-navbar-symbol" alt="Home"> <img src="images/ditto_allwhite_textonly.svg" class="ditto-navbar-symbol-text" alt="Eclipse Ditto™"></a>
         </div>
         <div class="collapse navbar-collapse" id="bs-example-navbar-collapse-1">
             <ul class="nav navbar-nav navbar-right">
@@ -22,9 +22,21 @@
                 {% for entry in topnav.topnav %}
                 {% for item in entry.items %}
                 {% if item.external_url %}
-                <li><a href="{{item.external_url}}" target="_blank">{{item.title}}</a></li>
+                  {% if item.image %}
+                  <li><a href="{{item.external_url}}" target="_blank">
+                    <img src="images/{{item.image}}" alt="{{item.alt}}">{{item.title}}
+                  </a></li>
+                  {% else %}
+                  <li><a href="{{item.external_url}}" target="_blank">{{item.title}}</a></li>
+                  {% endif %}
                 {% elsif page.url contains item.url %}
-                <li class="active"><a href="{{item.url | remove: "/"}}">{{item.title}}</a></li>
+                  {% if item.image %}
+                  <li class="active"><a href="{{item.url | remove: "/"}}">
+                    <img src="images/{{item.image}}" alt="{{item.alt}}"/>{{item.title}}
+                  </a></li>
+                  {% else %}
+                  <li class="active"><a href="{{item.url | remove: "/"}}">{{item.title}}</a></li>
+                  {% endif %}
                 {% else %}
                 <li><a href="{{item.url | remove: "/"}}">{{item.title}}</a></li>
                 {% endif %}

diff --git a/documentation/src/main/resources/_posts/2021-03-22-azure-iot-hub-integration.md b/documentation/src/main/resources/_posts/2021-03-22-azure-iot-hub-integration.md
@@ -4,7 +4,7 @@ published: true
 permalink: 2021-03-22-azure-iot-hub-integration.html
 layout: post
 author: david_schwilk
-tags: [blog, architecture, connection]
+tags: [blog, architecture, connectivity]
 hide_sidebar: true
 sidebar: false
 toc: true

diff --git a/...n/src/main/resources/_posts/2021-03-31-ssh-tunneling-for-managed-connections.md b/...n/src/main/resources/_posts/2021-03-31-ssh-tunneling-for-managed-connections.md
@@ -4,7 +4,7 @@ published: true
 permalink: 2021-03-31-ssh-tunneling-for-managed-connections.html
 layout: post
 author: vadim_guenther
-tags: [blog, architecture, connection]
+tags: [blog, architecture, connectivity]
 hide_sidebar: true
 sidebar: false
 toc: true
@@ -20,8 +20,7 @@ Kafka 2.x.
 
 ![Connection Overview](images/blog/2021-04-06-ssh-tunnel-for-managed-connections-shema.png)
 
-For further information, see [Secure Shell (SSH) Connection Protocol, RFC4254](https://tools.ietf.
-org/html/rfc4254#section-7)
+For further information, see [Secure Shell (SSH) Connection Protocol, RFC4254](https://tools.ietf.org/html/rfc4254#section-7)
 
 ## Setting up connections with SSH tunneling in Ditto
 When setting up a tunneled connection, the configuration must specify the `sshTunnel` section, which contains 

diff --git a/documentation/src/main/resources/css/customstyles.css b/documentation/src/main/resources/css/customstyles.css
@@ -286,8 +286,8 @@ ul#results-container a:hover {
 }
 #search-input {
     padding: .5em;
-    margin-left:20px;
-    width:20em;
+    margin-left:15px;
+    width:15em;
     font-size: 0.8em;
     -webkit-box-sizing: border-box;
     -moz-box-sizing: border-box;

diff --git a/documentation/src/main/resources/css/theme-ditto.css b/documentation/src/main/resources/css/theme-ditto.css
@@ -109,11 +109,14 @@ div.sidebarTitle {
 
 li.sidebarTitle {
   margin-top:20px;
-    font-weight:normal;
-    font-size:130%;
-    margin-bottom:10px;
-    margin-left: 5px;
+  font-weight:normal;
+  font-size:130%;
+  margin-bottom:10px;
+  margin-left: 5px;
+}
 
+li.sidebarTitle label {
+  font-weight:normal;
 }
 
 li.sidebarTitle .select-wrapper {
@@ -165,6 +168,11 @@ li.sidebarTitle .select-wrapper select option {
     border-color: #ffffff;
 }
 
+ul.nav.navbar-nav.navbar-right img {
+    height: 20px;
+    padding-right: 5px;
+}
+
 /* info , tip box with icon -  warning stays red*/
 .alert-info {
     color: #3a8c9a;

diff --git a/documentation/src/main/resources/images/GitHub-Mark-Light-32px.png b/documentation/src/main/resources/images/GitHub-Mark-Light-32px.png
diff --git a/documentation/src/main/resources/openapi/ditto-api-1.yml b/documentation/src/main/resources/openapi/ditto-api-1.yml
@@ -1,6 +1,6 @@
 openapi: 3.0.0
 info:
-  title: Eclipse Ditto HTTP API - Deprecated
+  title: Eclipse Ditto™ HTTP API - Deprecated
   version: '1'
   description: |-
     JSON-based, REST-like API for Eclipse Ditto

diff --git a/documentation/src/main/resources/openapi/ditto-api-2.yml b/documentation/src/main/resources/openapi/ditto-api-2.yml
@@ -1,6 +1,6 @@
 openapi: 3.0.0
 info:
-  title: Eclipse Ditto HTTP API
+  title: Eclipse Ditto™ HTTP API
   version: '2'
   description: |-
     JSON-based, REST-like API for Eclipse Ditto

diff --git a/documentation/src/main/resources/openapi/sources/api-1-index.yml b/documentation/src/main/resources/openapi/sources/api-1-index.yml
@@ -10,7 +10,7 @@
 # SPDX-License-Identifier: EPL-2.0
 openapi: 3.0.0
 info:
-  title: Eclipse Ditto HTTP API - Deprecated
+  title: Eclipse Ditto™ HTTP API - Deprecated
   version: "1"
   description: |-
     JSON-based, REST-like API for Eclipse Ditto

diff --git a/documentation/src/main/resources/openapi/sources/api-2-index.yml b/documentation/src/main/resources/openapi/sources/api-2-index.yml
@@ -10,7 +10,7 @@
 # SPDX-License-Identifier: EPL-2.0
 openapi: 3.0.0
 info:
-  title: Eclipse Ditto HTTP API
+  title: Eclipse Ditto™ HTTP API
   version: "2"
   description: |-
     JSON-based, REST-like API for Eclipse Ditto

diff --git a/documentation/src/main/resources/pages/ditto/intro-overview.md b/documentation/src/main/resources/pages/ditto/intro-overview.md
@@ -1,5 +1,5 @@
 ---
-title: Ditto documentation overview
+title: Eclipse Ditto™ documentation overview
 keywords: purpose, about, motivation, digital twin, digitaltwin, twin
 tags: [getting_started]
 permalink: intro-overview.html
@@ -8,7 +8,7 @@ permalink: intro-overview.html
 
 ## What is it?
 
-Eclipse Ditto is a technology in the <a href="#" data-toggle="tooltip" data-original-title="{{site.data.glossary.iot}}">IoT</a> 
+Eclipse Ditto™ is a technology in the <a href="#" data-toggle="tooltip" data-original-title="{{site.data.glossary.iot}}">IoT</a> 
 implementing a software pattern called “**[digital twins](intro-digitaltwins.html)**”.<br/>
 A digital twin is a virtual, cloud based, representation of his real world counterpart 
 (real world “Things”, e.g. devices like sensors, smart heating, connected cars, smart grids, EV charging stations, …).