Merge branch 'release/v1.2.0'

CHANGELOG.md

@@ -5,6 +5,12 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+
+## [v1.2.0]
+### Added
+- Menu entry to docs.cloudogu.com (#25)
+- Makefile to build zip
+
 ## [v1.1.1](https://github.com/cloudogu/warp-menu/releases/tag/v1.1.1)
 ### Fixed
 - Reapplied lost changes in PR #23

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Cloudogu
+
+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 NONINFRINGEMENT. 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.

Makefile

@@ -0,0 +1,17 @@
+WARP_MENU_VERSION:=v1.2.0
+ZIPFILE_NAME:=warp-$(WARP_MENU_VERSION).zip
+
+.DEFAULT_GOAL:=package
+
+clean-build:
+	rm -rf target/warp
+
+clean-zip:
+	rm -rf target/warp-*.zip
+
+build: clean-build
+	gulp
+
+package: build clean-zip
+	cd target; zip -r $(ZIPFILE_NAME) warp
+

README.md

@@ -1,8 +1,12 @@
 ![Cloudogu logo](https://cloudogu.com/images/logo.png)
+
+[![GitHub license](https://img.shields.io/github/license/cloudogu/warp-menu.svg)](https://github.com/cloudogu/warp-menu/blob/develop/LICENSE)
+[![GitHub release](https://img.shields.io/github/release/cloudogu/warp-menu.svg)](https://github.com/cloudogu/warp-menu/releases)
+
 # Warp-menu
 https://cloudogu.com
 
-Inside this repository lies the code for the Cloudogu warp-menu used to switch between single Dōgus in the browser.
+Inside this repository lies the code for the Cloudogu warp-menu used to switch between single Dogus in the browser.
 
 ### Quick start
 * Install dependencies with [npm](https://www.npmjs.com/) `npm install`

docs/operations/custom_entries_de.md

@@ -0,0 +1,19 @@
+# Funktionen
+
+Benutzerdefinierte Einträge können über den externals-Teil von etcd eingefügt werden.
+Die Einträge müssen ein json struct der folgenden Form sein:
+
+```json
+{
+  "DisplayName": "Cloudogu",
+  "Description": "Home of Cloudogu",
+  "Category": "External Links",
+  "URL": "https://cloudogu.com/"
+}
+```
+
+Die Einträge können z.B. mit etcdctl eingefügt werden:
+
+```bash
+etcdctl set config/nginx/externals/cloudogu '{"DisplayName": "Cloudogu","Description": "Home of Cloudogu", "Category": "External Links", "URL": "https://cloudogu.com/"}'
+```

docs/operations/custom_entries_en.md

@@ -0,0 +1,19 @@
+# Operations
+
+Custom entries can be inserted by using the externals part of etcd.
+The entries must be a json struct of the following form:
+
+```json
+{
+    "DisplayName": "Cloudogu", 
+    "Description": "Home of Cloudogu", 
+    "Category": "External Links", 
+    "URL": "https://cloudogu.com/"
+}
+```
+
+The entries can be inserted with etcdctl e.g.:
+
+```bash
+etcdctl set config/nginx/externals/cloudogu '{"DisplayName": "Cloudogu","Description": "Home of Cloudogu", "Category": "External Links", "URL": "https://cloudogu.com/"}'
+```

docs/warp-menu_de.md

@@ -1,4 +1,4 @@
-# Warp Menü
+# Oberfläche
 Das Warp Menü hilft Ihnen bei der Navigation durch das Cloudogu EcoSystem. Über das Warp Menü können Sie alle  Dogus erreichen und schnell zwischen diesen wechseln.
 
 Das Warp Menü können Sie in jedem Dogu über die Schaltfläche "Menü" am rechten Bildschirmrand öffnen.

docs/warp-menu_en.md

@@ -1,4 +1,4 @@
-# Warp Menu
+# GUI
 
 Translated with www.DeepL.com/Translator
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "warp-menu",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "repository": {
     "type": "git",
     "url": "https://github.com/cloudogu/warp-menu"

src/warp.js

@@ -79,7 +79,8 @@ function getTranslations(language) {
             "onboardingHintToken": "Hinweis nicht mehr anzeigen",
             "Development Apps": "Entwicklung",
             "Administration Apps": "Administration",
-            "Documentation": "Dokumentation"
+            "Documentation": "Dokumentation",
+            "docsCloudoguComUrl": "Cloudogu EcoSystem Docs"
         };
     } else {
         return {
@@ -90,7 +91,8 @@ function getTranslations(language) {
             "onboardingHintToken": "Do not show this hint again",
             "Development Apps": "Development Apps",
             "Administration Apps": "Administration Apps",
-            "Documentation": "Documentation"
+            "Documentation": "Documentation",
+            "docsCloudoguComUrl": "Cloudogu EcoSystem Docs"
         };
     }
 }
@@ -269,11 +271,19 @@ function createMenu(categories) {
         }
     }
 
+    // fixed link to docs.cloudogu.com
+    informationEntries.push({
+        DisplayName: getLocalizedString("docsCloudoguComUrl"),
+        Href: createLink("https://docs.cloudogu.com"),
+        Target: "external"
+    });
+
     // fixed about page - entry
     informationEntries.push({
         DisplayName: getLocalizedString("aboutCloudoguToken"),
         Href: createLink("/info/index.html")
     });
+
     createMenuEntry("warpc.info", informationEntries, "Information", list);
 
     addLogoutMenuEntry(list);