Skip to content

Commit

Permalink
BITS 6.0.0 release
Browse files Browse the repository at this point in the history
  • Loading branch information
Andreas H committed Jul 20, 2021
0 parents commit 36fe7e8
Show file tree
Hide file tree
Showing 134 changed files with 14,018 additions and 0 deletions.
40 changes: 40 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# Hugo default output directory
/public

# Hugo generated resources
/resources/_gen/

# Hugo Binary inside path
hugo.exe

## OS Files
# Windows
Thumbs.db
ehthumbs.db
Desktop.ini
$RECYCLE.BIN/

# MacOS
.DS_Store

# VIM specific
# Swap
[._]*.s[a-v][a-z]
!*.svg # comment out if you don't need vector files
[._]*.sw[a-p]
[._]s[a-rt-v][a-z]
[._]ss[a-gi-z]
[._]sw[a-p]

# Session
Session.vim
Sessionx.vim

# Temporary
.netrwhist
*~
# Auto-generated tag files
tags
# Persistent undo
[._]*.un~
.DS_Store
7 changes: 7 additions & 0 deletions .gitmodules
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
[submodule "themes/hugo-theme-learn"]
path = themes/hugo-theme-learn
url = https://github.com/BITS-Training/hugo-theme-learn.git
branch = master
[submodule "hugo-theme-learn"]
path = hugo-theme-learn
url = https://github.com/BITS-Training/hugo-theme-learn.git
429 changes: 429 additions & 0 deletions LICENSE.md

Large diffs are not rendered by default.

78 changes: 78 additions & 0 deletions LearnTheme-HowTo.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# Learn-Theme - HowTo

## O. Einleitung

Dieses Dokument beschreibt, welche Anpassungsmöglichkeiten es gibt, wenn BITS über hugo und das Learn-Theme angepasst werden kann.

## 1. Variablen und Parameter (hinterlegt in config.toml)

### Textvariablen

- Behörden und Einrichtungen
``{{< param Einrichtungen >}}``

- Behörde oder Einrichtung
``{{< param Einrichtung >}}``

- 6.0beta1 (Versionsnummer)
``{{< param Ver >}}``

## 2. Notizen

- Anmerkung (orange) = das was in BITS v5 links steht
```
{{% notice note %}}
Nach diesem Training werden Sie wissen, wie Sie sich richtig am Computer, am Smartphone und im Internet verhalten. Nutzen Sie Ihr Wissen auch für den privaten Bereich, es drohen überall die gleichen Gefahren!
{{% /notice %}}
```
- Tipp (grün) = das was in BITS v5 rechts steht
```
{{% notice tip %}}
Schutzziele der Informationssicherheit:
* Vertraulichkeit
* Integrität
* Verfügbarkeit
{{% /notice %}}
```

## 3. Interne Links

- zu Lektionen
``[Viren]({{< ref "/040 lektion viren" >}})``

- zu Unterseiten
``[Viren]({{< ref "/040 lektion viren/05.Risiko-und-Schaeden.de.md" >}})``
``[Informationen]({{< ref "02.Dokumente-und-Informationen.de.md" >}})``

- zu Ansprechperson
``[Ansprechperson]({{< ref "/200 ansprechpersonen/" >}})``
## 4. Quiz

### Fragen und Antworten sortieren

Als Voreinstellung sind die Fragen in ihrer Reihenfolge fest ("Shuffle Questions: True"), die vorgeschlagenen Antworten zufällig sortiert ("Shuffle Answers: False"). Dies kann über die jeweilige Lektions-Seite der Quizzes beliebig geändert werden.

### Multiple-Choice-Antworten

- Will man mehrere Antworten zulassen, dann sind die Antworten als ungeordnete Liste zu formatieren (die Formatierung als "Aufgabenliste" (über die eckigen Klammern mit Leerzeichen muss erhalten bleiben, daher ggf. in den Quellcode-Modus des Editors wechseln)

```
- [x] Kleine Programmteile, die sich unbemerkt an ein anderes Programm anhängen und so auf fremden Rechnern ausgeführt werden können.
- [ ] Mikroskopisch kleine elektronische Teile, die Computer ausspionieren oder andere zerstörerische Aktionen ausführen.
- [ ] Schädliche Programme, die jedoch in Ihrer Einrichtung keine Gefahr darstellen, weil sie durch Verschlüsselungssoftware und Virenscanner sofort unschädlich gemacht werden.
```

- Will man nur eine Antwort zulassen, dann sind die Antworten als geordnete Liste zu formatieren:

```
1. [x] Ein netter Anruf einer Ihnen nicht bekannten Mitarbeiterin der IT-Abteilung, mit der Bitte, ihr Ihre Zugangsdaten zu geben.
2. [ ] Anfrage eines Kollegen / einer Kollegin zu einem empfangenen Kettenbrief per E-Mail.
3. [ ] Eine Information Ihrer Abteilungsleitung, Sie hätten einen Virus erhalten.
```

## 5. Aufklappen von Texten
```
{{%expand "Datei-Viren" %}}
Dies ist ein Beispiel
{{% /expand %}}
```
75 changes: 75 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# BITS - Behörden-IT-Sicherheitstraining

## Einleitung
Diese Datei beschreibt, wie BITS über das Werkzeug Hugo bearbeitet werden kann.

Alternativ kann die HTML-Version von BITS heruntergeladen und direkt über einen Text-Editor in den statischen HTML-Seiten gearbeitet werden. Dies entspricht BITS, wie es bis Version 5.5 entwickelt wurde. Außerdem gibt es neben dieser HTML-Version ein weiteres Archiv mit dem gleichen Stand, das die Installation auf einem Web-Server ermöglicht - damit funktionieren u.a. die eingebaute Suche und die Verlaufsdarstellung der bereits besuchten Seiten. In diesen Download-Archiven ist eine weitere Readme.md enthalten, die konkrete Hinweise zur Anpassung, aber auch zur Aktivierung des Gewinnspiels etc. beinhaltet.

Das BITS-Repository mit den beiden Download-Archiven ("Releases") liegt auf github hier: [BITS-hugo](https://github.com/BITS-Editor/BITS-hugo)

Hier wird erläutert, wie BITS mithlfe von [Hugo](https://gohugo.io), einem Open Sourece-Programm zu Erstellung statischer HTML-Seiten mittels der Markdown-Sprache, angepasst werden kann. Damit kann wie mit einem What-you-see-is-what-you-get-Editor gearbeitet werden, um BITS auf die lokalen Gegebenheiten anzupassen. Dies kann aber, wie oben dargestellt, auch über die statischen HTML-Seiten aus dem Repository-Archiv und einen Text-Editor erfolgen.

## Bezug von Hugo und Abhängigkeiten

Zunächst muss Hugo in der extended Version heruntergeladen werden. Hugo steht u.a. für Windows, Linux, MacOS, BSD zur Verfügung. Hier wird die Installation der Windows-Variante vorgestellt.

[Download hugo from GitHub releases](https://github.com/gohugoio/hugo/releases)

Anschließend muss Hugo installiert werden, siehe die [Installationsanweisungen](https://gohugo.io/getting-started/installing/).

Die EXE-Datei sollte, für einfache Verwendung, in einem Pfad gespeichert sein, der in der PATH-Variable des Betriebssystems enthalten ist. Alternativ kann sie auch in das Projektverzeichnis kopiert werden.

## BITS-hugo herunterladen

Nach der Installation von Hugo ist das BITS-hugo-Repository von Github herunter zu laden.

1. Lokales Klonen des Repositorys (rekursiv!)

```bash
git clone --recursive https://github.com/BITS-Editor/BITS-hugo
```

2. Lokal in das heruntergeladene Repository-Verzeichnis wechseln

```bash
cd BITS-hugo
```

3. Hugo-Server starten

```bash
hugo server
```

4. Browser öffnen und auf http://localhost:1313 navigieren

5. Anpassungen an den Markdown-Dateien, insbesondere im Ordner /content vornehmen.

- Änderungen werden direkt von Hugo erkannt und im Browser angezeigt.
- Tipps und weitere Infos findet man in der Datei [LearnTheme-howto.md](https://github.com/BITS-Training/BITS-hugo/blob/main/LearnTheme-HowTo.md)

## BITS Release generieren

Mit folgenden Befehlen werden im Unterverzeichnis "public" die HTML-Dateien von Hugo für die Veröffentlichung für die Beschäftigten generiert:

1. für die Verwendung mit einem Webserver und voller Funktionalität:

```bash
hugo --cleanDestinationDir
```

2. für die Verwendung ohne Webserver als direkte HTML-Dateien (Suche und Verlauf-Haken gehen nicht!):

```bash
hugo --environment html --cleanDestinationDir
```

## Weitere Infos

Hugo arbeitet mit sog. Themes, die für das Layout zuständig sind. BITS-hugo verwendet das Learn-Theme:
https://themes.gohugo.io/themes/hugo-theme-learn/

Welche Anpassungen über Parameter in BITS für das Learn-Theme hinterlegt sind, steht in der Datei https://github.com/BITS-Training/BITS-hugo/blob/main/LearnTheme-HowTo.md

Weitere Hinweise und Hilfe zu Hugo findet sich hier:
https://gohugo.io/documentation/
6 changes: 6 additions & 0 deletions archetypes/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "{{ replace .Name "-" " " | title }}"
date: {{ .Date }}
draft: true
---

1 change: 1 addition & 0 deletions assets/quizdown/extensions/quizdownHighlight.js

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions assets/quizdown/extensions/quizdownKatex.js

Large diffs are not rendered by default.

24 changes: 24 additions & 0 deletions assets/quizdown/quizdown.js

Large diffs are not rendered by default.

91 changes: 91 additions & 0 deletions config/_default/config.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,91 @@
### Default Konfig-Datei mit allen Einstellungen um das BITS-Training mit einem Webserver zu betreiben
baseURL = "/"
relativeURLs = false
uglyurls = false
disableSearch = false

languageCode = "de-DE"
defaultContentLanguage = "de"
defaultContentLanguageInSubdir= false

metaDataFormat = "yaml"

title = "BITS | Behörden-IT-Sicherheitstraining"
theme = "hugo-theme-learn"

[params]
description = "BITS, das kostenlose Behörden-IT-Sicherheitstraining, wurde vom Arbeitskreis Informationstechnologie des Städte- und Gemeindebundes NRW als webbasierter Lernkurs für die Beschäftigten in Behörden und anderen Einrichtungen erstellt. Es dient der Information und Sensibilisierung der Kolleginnen und Kollegen an IT-Arbeitsplätzen hinsichtlich der relevanten Sicherheitsthemen."
author = "Dr. Lutz Gollan"
showVisitedLinks = true
disableBreadcrumb = false
disableNextPrev = false
disableAssetsBusting = true
disableLanguageSwitchingButton = true
disableLandingPageButton = true
# Change default color scheme with a variant one. Can be "red", "blue", "green".
# Hier wird die für BITS angepasste blaue Variante eingestellt
themeVariant = "bits"

BITS = "BITS"
Ver = "6.0.0"

[outputs]
home = [ "HTML", "RSS", "JSON"]

[Languages]

[Languages.de]
title = "BITS | Behörden-IT-Sicherheitstraining"
weight = 1
languageName = "Deutsch"
landingPageURL = "/010-start/"
landingPageName = "<i class='fas fa-home'></i> Start"
Einrichtung = "Behörde oder Einrichtung"
Einrichtungen = "Behörden und Einrichtungen"

[[Languages.de.menu.shortcuts]]
name = "<i class='fas fa-fw fa-info-circle'></i> Weitere Informationen"
identifier = "wi"
url = "/300 infos/weitere-informationen/"
weight = 10

[[Languages.de.menu.shortcuts]]
name = "<i class='fas fa-fw fa-id-card'></i> Herausgeber und Lizenz"
url = "/300 infos/herausgeber-und-lizenz/"
weight = 20

[[Languages.de.menu.shortcuts]]
name = "<i class='fas fa-fw fa-wheelchair'></i> Barrierefreiheit"
identifier = "usability"
url = "/300 infos/barrierefreiheit/"
weight = 30

[Languages.en]
title = "BITS | IT security training for public authorities"
weight = 2
languageName = "English"
landingPageURL = "/010-start/"
landingPageName = "<i class='fas fa-home'></i> Start"
Einrichtung = "Authority or institution"
Einrichtungen = "Authorities or institutions"

[[Languages.en.menu.shortcuts]]
name = "<i class='fas fa-fw fa-info-circle'></i> more information"
identifier = "wi"
url = "/300 infos/weitere-informationen/"
weight = 10

[[Languages.en.menu.shortcuts]]
name = "<i class='fas fa-fw fa-id-card'></i> Publisher and License"
url = "/300 infos/herausgeber-und-lizenz/"
weight = 20

[[Languages.en.menu.shortcuts]]
name = "<i class='fas fa-fw fa-wheelchair'></i> Accessibility"
identifier = "usability"
url = "/300 infos/barrierefreiheit/"
weight = 30

[minify]
# disabled because of issues with quiz module
disableHTML = true
51 changes: 51 additions & 0 deletions config/html/config.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
### Diese Datei enhält alle abweichenden Einstellungen um das Tranining ohne einen Web-Server zu betreiben
###
### Generiert wird die Version mit dem Befehl:
### hugo --environment html --cleanDestinationDir
relativeURLs = true
uglyurls = true
disableSearch = true

### Die Suche und die Anzeige besuchter Seiten funktioniert nur beim Betrieb über einen Web-Server!!

[Languages]

[Languages.de]
landingPageURL = "/010-start.html"

[[Languages.de.menu.shortcuts]]
name = "<i class='fas fa-fw fa-info-circle'></i> Weitere Informationen"
identifier = "wi"
url = "/300 infos/weitere-informationen.html"
weight = 10

[[Languages.de.menu.shortcuts]]
name = "<i class='fas fa-fw fa-id-card'></i> Herausgeber und Lizenz"
url = "/300 infos/herausgeber-und-lizenz.html"
weight = 20

[[Languages.de.menu.shortcuts]]
name = "<i class='fas fa-fw fa-wheelchair'></i> Barrierefreiheit"
identifier = "usability"
url = "/300 infos/barrierefreiheit.html"
weight = 30

[Languages.en]
landingPageURL = "/010-start.html"

[[Languages.en.menu.shortcuts]]
name = "<i class='fas fa-fw fa-info-circle'></i> more information"
identifier = "wi"
url = "/300 infos/weitere-informationen.html"
weight = 10

[[Languages.en.menu.shortcuts]]
name = "<i class='fas fa-fw fa-id-card'></i> Publisher and License"
url = "/300 infos/herausgeber-und-lizenz.html"
weight = 20

[[Languages.en.menu.shortcuts]]
name = "<i class='fas fa-fw fa-wheelchair'></i> Accessibility"
identifier = "usability"
url = "/300 infos/barrierefreiheit.html"
weight = 30
19 changes: 19 additions & 0 deletions content/010 start/_index.de.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
---
title: "Start"
date: 2021-03-06T09:11:59
weight: 10
disableToc: true
---

#### {{< param BITS >}} {{< param Ver >}}

### Sicherheit entsteht – wenn alle mitmachen!

#### Das Sicherheitstraining {{< param BITS >}} ist konzipiert für

* {{< param Einrichtungen >}}, die ihre Beschäftigten im sicheren Umgang mit dem Computer und dem Internet sensibilisieren wollen
* die Beschäftigten von {{< param Einrichtungen >}}, die sich auch über die private sichere Nutzung von Computer und Internet informieren wollen



Die Leitung Ihrer {{< param Einrichtung >}} trägt die Verantwortung für die Informationssicherheit. Dieser Verantwortung kann sie jedoch nur gerecht werden, wenn alle Beschäftigten aufmerksam arbeiten und wissen, welche Gefahren die IT-Nutzung mit sich bringt und wie man diesen angemessen begegnet. Dies soll {{< param BITS >}} vermitteln.
Loading

0 comments on commit 36fe7e8

Please sign in to comment.