Wiki - Gruppe Adler

# ❓ Wiki How-To

# Einleitung

Dieses Wiki baut auf VuePress (opens new window) auf und liegt auf GitHub (opens new window).

Die VuePress Dokumentation (hier zu finden (opens new window)) gilt also im Allgemeinen auch für dieses Wiki.

Der folgende Guide soll alles Nötige vermitteln um Seiten bearbeiten und erstellen zu können.

# GitHub Action

Da dieses Wiki auf VuePress aufbaut müssen die Wiki-Seiten nach jeder Änderung neu generiert werden. Das bedeutet Änderungen durch Commits sind nicht sofort im Wiki zu sehen.

GitHub Actions ist so eingerichtet, dass nach jedem Commit im master Branch, der Build und Deployment Prozess neu angestoßen wird. So sind Änderungen bereits nach ein bis zwei Minuten zu sehen.

Auf GitHub unter commits ist zu sehen ob der Build für den aktuellen Commit fertiggestellt ist:
github-commits

TIP

  • Gelber Punkt = Build Prozess noch in Arbeit
  • Grüner Haken = Build und Deployment Prozess erfolgreich
  • Rotes Kreuz = Fehler beim Build Prozess

travis-status

WARNING

Falls das Wiki-Seite trotzdem erfolgreichem Build nicht aktualisiert sollte der Cache deaktiviert werden.

# Aufbau der GitHub Repository

# Verzeichnisse

Alle Dateien befinden sich im docs Unterverzeichnis, welches im groben wie folgt aufgebaut ist:

docs
├── .vuepress Hier befinden sich die Wiki Konfiguration
│
├── assets Hier befinden sich alle Assets. Also Bilder, Code-Schnipsel, etc.
│     ├── [...]
│     └── gruppe-adler-modset Alle Assets für die Wiki-Seite gruppe-adler-modset.md
│           ├── [...]
│           └── create-profile.jpg
│
├── de Hier befinden sich alle deutschsprachigen Wiki-Seiten
│     ├── bastelstube
│     ├── infrastruktur
│     │     ├── [...]
│     │     ├── gruppe-adler-modset.md Wiki-Seite "Gruppe Adler Modset"
│     │     └── README.md Hauptseite für Kategorie "Infrastruktur"
│     │
│     ├── organisatorisches
│     ├── taktik
│     ├── README.md
│     └── wiki-index.md
│
└── en Hier befinden sich alle englischsprachigen Wiki-Seiten

# Assets

Alle Assets (Bilder, Code-Schnipsel, etc.) befinden sich im Verzeichnis docs/assets.
Für jede Wiki-Seite befindet sich dort ein eigenes Verzeichnis.
Zum Beispiel existiert für die Seite docs/de/infrastruktur/gruppe-adler-modset.md ein Verzeichnis docs/assets/gruppe-adler-modsets in dem sich alle Bilder für die Wiki-Seite befinden.

Innerhalb der Wiki-Seite kann auf diese Dateien mit dem Pfad ~@assets/gruppe-adler-modset/ zugegriffen werden, also wird das Bild docs/assets/gruppe-adler-modsets/create-profile.jpg folgendermaßen geladen:

![create-profile](~@assets/gruppe-adler-modset/create-profile.jpg)

# Markdown

VuePress Wiki Seiten werden in Markdown geschrieben. Markdown sollte den Meisten schon von GitHub, unserem Forum oder Discord, welches eine ähnliche Syntax hat, bekannt sein. Im Anschluss aber nochmal alles wichtige:

# Zeilenumbrüche

Um in Markdown einen Zeilenumbruch zu machen reicht eine neue Zeile allein nicht aus. Zusätzlich dazu muss am Ende der Zeile zwei Leerzeichen stehen.

Code
Vorschau

Zeile 1 ebenfalls Zeile 1 (nach dieser Klammer sind zwei Leerzeichen)
Zeile 2

Zeile 1
ebenfalls Zeile 1 (nach dieser Klammer sind zwei Leerzeichen)  
Zeile 2

# Überschriften

Code
Vorschau

# Große Überschrift

# Fast so große Überschfit

# Kleinere Überschrift

# Kleine Überschrift

# Große Überschrift
## Fast so große Überschfit
### Kleinere Überschrift
#### Kleine Überschrift

# Hervorhebung

Code
Vorschau

kursiver Text
fetter Text
ebenfalls kursiver Text
ebenfalls fetter Text
fetter und kursiver Text

*kursiver Text*  
**fetter Text**  
_ebenfalls kursiver Text_  
__ebenfalls fetter Text__  
_**fetter und kursiver Text**_

# Listen

# Unsortierte Listen:

Code
Vorschau
  • Eins
  • Zwei
  • Drei
* Eins
* Zwei
* Drei

# Sortierte Listen

Code
Vorschau
  1. Eins
  2. Zwei
  3. Drei
1. Eins
2. Zwei
3. Drei

# Verschachtelte Listen

Code
Vorschau
  1. Eins
    • Zweite
    • Ebene
  2. Zwei
1. Eins
    - Zweite
    - Ebene
2. Zwei

# Bilder

Code
Vorschau

Adlerkopp

![Adlerkopp](https://forum.gruppe-adler.de/assets/uploads/system/site-logo.png)
Code
Vorschau

Link zu externen Seiten Gruppe Adler Forum (opens new window)

Link zu interner Seiten Modset

Link zu Abschnitt auf gleicher Seite: Aufbau der GitHub Repository

Link zu externen Seiten
[Gruppe Adler Forum](http://forum.gruppe-adler.de)  

Link zu interner Seiten
[Modset](gruppe-adler-modset.html)

Link zu Abschnitt auf gleicher Seite:
[Aufbau der GitHub Repository](#aufbau-der-github-repository)

# Zitate

Code
Vorschau

DerZade sagte:

Oida ... Ganz Ehrlich

DerZade sagte:
> Oida ... Ganz Ehrlich

# Code

# Im Fließtext eingebetteter Code

Code
Vorschau

Hast du es schon einmal mit setUnitLoadout probiert?

Hast du es schon einmal mit `setUnitLoadout` probiert?

# Code Block

Code
Vorschau

Das hier ist ein Paragraph.

console.log("Gruppe Adler Rulez!"):

module.exports = "test123";

console.log("Hello");

Das hier ist auch ein Paragraph.

Das hier ist ein Paragraph.
```javascript 
console.log("Gruppe Adler Rulez!"):

module.exports = "test123";

console.log("Hello");
```
Das hier ist auch ein Paragraph.

# Custom Container

Code
Vorschau

TIP

Dies ist ein Tipp

WARNING

Dies ist eine Warnung

WARNING

Jetzt wirds aber gefährlich

::: tip
Dies ist ein Tipp
:::

::: warning
Dies ist eine Warnung
:::

::: danger
Jetzt wirds aber gefährlich
:::

Es lässt sich ebenfalls eine eigene Überschrift festlegen:

Code
Vorschau

Gruppe Adler rulez

Aufgepasst! Wir sind die besten 😛

::: warning Gruppe Adler rulez
Aufgepasst! Wir sind die besten :P
:::

# Tabellen

Tabellen funktioniert ähnlich wie auf GitHub. Ein genauen Guide dazu gibt es hier (opens new window).

Code
Vorschau
Tabellen Sind Cool
Spalte 3 ist rechtsbündig GRAD
Spalte 2 ist zentriert rulez
zebra stripes are neat 
| Tabellen      | Sind          | Cool  |
| ------------- |:-------------:| -----:|
| Spalte 3 ist  | rechtsbündig  |  GRAD |
| Spalte 2 ist  | zentriert     | rulez |
| zebra stripes | are neat      |       |

# Emojis

Code
Vorschau

🎉 💯

:tada: :100:

# Hervorhebung von Zeilen in Code Blöcken

Code
Vorschau
 


 


// Hervorgehoben // Durch Zeilenzahlen in geschweiften Klammern // am Anfang der Code-Blocks // Diese Zeile ist auch hervorgehoben console.log("Yo"); 
```javascript{1,4}
// Hervorgehoben
// Durch Zeilenzahlen in geschweiften Klammern
// am Anfang der Code-Blocks
// Diese Zeile ist auch hervorgehoben
console.log("Yo");
```

# HTML in Markdown

HTML lässt sich ebenfalls direkt in die Markdown Datei schreiben. Dies gilt auch für <style> und <script> Tags.

# Markdown Sandbox

Es ist eine Markdown Sandbox in Arbeit, in der man Markdown mit allen Erweiterungen ausprobieren kann. Nerv einfach solange Zade bis sie endlich fertig ist.

# Eine Seite bearbeiten

Dieses Wiki liegt auf GitHub, dementsprechend kann man die einzelnen Seiten direkt auf GitHub bearbeiten. Dazu befindet sich am Ende jeder Seite ein Link um die dementsprechende Seite auf GitHub zu editieren: edit-link

Falls du keinen Zugriff auf das Repository habt, wende dich an einen Admin der Gruppe Adler Organisation auf GitHub (opens new window).

# Eine Seite erstellen

Neue Wiki Seiten lassen sich ebenfalls GitHub erstellen.

HALT STOP!

Aber nicht so schnell!
Bitte erst den Punkt Eine Seite erstellen zu Ende lesen bevor du mit Erstellen anfängst.

create-file

Hier sind Links um eine Seite direkt in der jeweiligen Kategorie zu erstellen:

# Nomenklatur

Einen kurzen aussagekräftigen Titel verweden, da unsere Suchfunktion primär die Titel durchsucht!

Neue Seiten sind bitte wie folgt zu benennen:

  • Alles in Kleinbuchstaben
  • Leerzeichen durch - ersetzten

Beispiele:
Gruppe Adler Modset → gruppe-adler-modset
Wiki How-To → wiki-how-to

TIP

Da es sich um eine markdown Datei handelt sollte die neue Datei natürlich mit der Dateierweiterung .md enden.

# Titel

Die erste Zeile einer neuen Seite sollte immer eine große Überschrift sein und den Titel der Seite enthalten.
z.B.: # Wiki How-To
Dieser Titel wird zum Beispiel für die Sidebar gebraucht. Alle übrigen Überschriften sollten maximal die Größe 2 (##) haben.

# Tabellen / MD Editor

Ein guter Editor, der das Arbeiten insbesondere mit Tabellen deutlich erleichtert findet sich hier: Typora (opens new window)

←