Skip to content

Commit

Permalink
Add "Konto" and "App-Einstellung" section to docs (#1333)
Browse files Browse the repository at this point in the history
New Docs for Sharezone with Nextra

---------

Co-authored-by: Nils Reichardt <[email protected]>
Co-authored-by: Jonas Sander <[email protected]>
  • Loading branch information
3 people authored Aug 24, 2024
1 parent 85b9317 commit 2fbd046
Show file tree
Hide file tree
Showing 18 changed files with 329 additions and 18 deletions.
3 changes: 2 additions & 1 deletion docs/pages/_meta.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"index": "Übersicht",
"index": "Startseite",
"account": "Konto",
"app-settings": "App-Einstellungen",
"more": "Weiteres"
}
14 changes: 14 additions & 0 deletions docs/pages/account.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import { Cards, Card } from "nextra/components";

# Kontoeinstellungen

Hier findest du Anleitungen für verschiedene Kontoänderungen und Einstellungsmöglichkeiten deines Kontos.

<Cards>
<Card title="E-Mail verknüpfen" href="/docs/pages/account/setup-email" />
<Card title="E-Mail ändern" href="/docs/pages/account/change-email" />
<Card title="Name ändern" href="/docs/pages/account/change-name" />
<Card title="Passwort ändern" href="/docs/pages/account/change-password" />
<Card title="Bundesland ändern" href="/docs/pages/account/change-province" />
<Card title="Konto löschen" href="/docs/pages/account/delete-account" />
</Cards>
5 changes: 5 additions & 0 deletions docs/pages/account/_meta.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
{
"setup-email": "E-Mail verknüpfen",
"change-email": "E-Mail ändern",
"change-name": "Namen ändern",
"change-password": "Passwort ändern",
"change-province": "Bundesland ändern",
"delete-account": "Konto löschen"
}
25 changes: 25 additions & 0 deletions docs/pages/account/change-email.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import { Callout } from "nextra/components";
import { Steps } from "nextra/components";

# Meine E-Mail-Adresse ändern

Wenn du dein Konto mit einer E-Mail verknüpft hast und diese ändern möchtest, kannst du dies über die Einstellungen machen.
Führe dazu folgende Schritte aus:

<Steps>
### Einstellungen in Sharezone öffnen

### "Mein Konto" öffnen

### Auf "E-Mail" drücken

### Neue E-Mail eingeben und Passwort eingeben

### Mit Haken die Änderungen bestätigen

</Steps>

<Callout type="info">
Falls du noch keine E-Mail verknüpft hast, kannst du dies hier machen: [Konto
mit E-Mail verknüpfen]()
</Callout>
25 changes: 25 additions & 0 deletions docs/pages/account/change-name.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
import { Callout } from "nextra/components";
import { Steps } from "nextra/components";

# Meinen Namen ändern

Wenn du deinen Namen in Sharezone ändern möchtest, kannst du dies über die Einstellungen machen.
Führe dazu folgende Schritte aus:

<Steps>
### Einstellungen in Sharezone öffnen

### "Mein Konto" öffnen

### Auf "Name" drücken

### Neuen Namen eingeben

### Mit "Speichern" bestätigen

</Steps>

<Callout type="info">
Dein Nickname ist nur für deine Gruppenmitlgieder sichtbar und sollte ein
Pseudonym oder dein Vorname sein.
</Callout>
22 changes: 22 additions & 0 deletions docs/pages/account/change-password.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import { Callout } from "nextra/components";
import { Steps } from "nextra/components";

# Mein Passwort ändern

Wenn du dein Passwort in Sharezone ändern möchtest, kannst du dies über die Einstellungen machen.
Führe dazu folgende Schritte aus:

<Steps>
### Einstellungen in Sharezone öffnen

### "Mein Konto" öffnen

### Auf "Passwort ändern" drücken

### Aktuelles Passwort eingeben

### Neues Passwortceingeben

### Mit Haken die Änderungen bestätigen

</Steps>
23 changes: 23 additions & 0 deletions docs/pages/account/change-province.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
import { Callout } from "nextra/components";
import { Steps } from "nextra/components";

# Mein Bundesland ändern

<Callout type="info">
Mithilfe des Bundeslandes können wir die restlichen Tage bis zu den nächsten
Ferien berechnen.
</Callout>

Wenn du dein Bundesland in Sharezone ändern möchtest, kannst du dies über die Einstellungen machen.
Führe dazu folgende Schritte aus:

<Steps>
### Einstellungen in Sharezone öffnen

### "Mein Konto" öffnen

### Auf "Bundesland" drücken

### Bundesland auswählen

</Steps>
31 changes: 14 additions & 17 deletions docs/pages/account/delete-account.mdx
Original file line number Diff line number Diff line change
@@ -1,29 +1,26 @@
# Mein Konto löschen

import { Callout } from "nextra/components";
import { Steps } from "nextra/components";

# Mein Konto löschen

<Callout type="warning" emoji="⚠️">
<Callout type="warning">
Dieser Schritt wird sofort ausgeführt und kann nicht rückgängig gemacht
werden!
</Callout>

Falls du dein Konto und somit alle deine Daten löschen möchtest, kannst du dies
über die Einstellungen machen. Führe dazu folgende Schritte aus:

1. Einstellungen in Sharezone öffnen
2. "Mein Konto" öffnen
3. "Konto löschen" auswählen (unten auf der Seite)
<Steps>
### Einstellungen in Sharezone öffnen

### "Mein Konto" öffnen

Solltest du dich anonym angemeldet haben, wird dein Konto ebenfalls gelöscht,
wenn du dich abmeldest.
### "Konto löschen" auswählen (unten auf der Seite)

import { Bleed } from "nextra-theme-docs";
</Steps>

<Bleed>
<iframe
src="https://firebasestorage.googleapis.com/v0/b/sharezone-c2bd8.appspot.com/o/docs%2Faccount%2Fdelete-account-desktop.mp4?alt=media&token=7e124214-5ca6-4927-a0c7-717344053850"
width="100%"
height="500px"
title="Konto löschen"
/>
</Bleed>
<Callout type="info">
Solltest du dich anonym angemeldet haben, wird dein Konto ebenfalls gelöscht,
wenn du dich abmeldest.
</Callout>
33 changes: 33 additions & 0 deletions docs/pages/account/setup-email.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
import { Callout } from "nextra/components";
import { Steps } from "nextra/components";

# Mein Konto mit einer E-Mail verknüpfen

<Callout type="warning">
Die Anmeldung ist aus datenschutzrechtlichen Gründen erst ab 16 Jahren
erlaubt!
</Callout>

Damit deine Daten immer und überall erreichbar sind, kannst du dein Konto mit einer E-Mail verknüpfen.
Du profitierst dann von folgenden Dingen:

- Automatisches Backup: Weiterhin Zugriff auf die Daten bei Verlust deines Gerätes
- Nutzung auf mehreren Geräten: Daten werden zwischen mehreren Geräten synchronisiert

Wenn du eine E-Mail mit deinem Konto verknüpfen möchtest, kannst du dies über die Einstellungen machen.
Führe dazu folgende Schritte aus:

<Steps>
### Einstellungen in Sharezone öffnen

### "Mein Konto" öffnen

### Auf "Anmeldemethode" drücken

### Zwischen E-Mail/Apple/Google wählen

- E-Mail: Daten eingeben und mit "Verknüpfen" bestätigen
- Apple ID: Apple ID eingeben und weitere Schritte befolgen
- Google: Weitere Schritte befolgen

</Steps>
5 changes: 5 additions & 0 deletions docs/pages/app-settings/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"notifications": "Benachrichtigungen",
"theme": "Erscheinungsbild",
"timetable": "Stundenplan"
}
20 changes: 20 additions & 0 deletions docs/pages/app-settings/notifications.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
import { Cards, Card } from "nextra/components";

# Benachrichtigungen aktivieren

Sharezone kann dich über bestimmte Sachen benachrichtigen, wie:

<Cards>
<Card
title="Offene Hausaufgaben"
href="/docs/pages/app-settings/notifications/open-homework"
/>
<Card
title="Kommentare"
href="/docs/pages/app-settings/notifications/comments"
/>
<Card
title="Infozettel"
href="/docs/pages/app-settings/notifications/infopages"
/>
</Cards>
5 changes: 5 additions & 0 deletions docs/pages/app-settings/notifications/_meta.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"comments": "Kommentare",
"infopages": "Infozettel",
"open-homework": "Offene Hausaufgaben"
}
16 changes: 16 additions & 0 deletions docs/pages/app-settings/notifications/comments.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import { Steps } from "nextra/components";
import { Callout } from "nextra/components";

## Kommentare

Du kannst Push-Nachrichten erhalten, wenn ein Nutzer einen neuen Kommentar unter einer Hausaufgabe oder einem Infozettel veröffentlicht hat.
Um dies zu aktivieren, folge diesen Schritten:

<Steps>
### Einstellungen in Sharezone öffnen

### "Benachrichtigungen" öffnen

### Haken bei "Benachrichtigungen für Kommentare" setzen

</Steps>
18 changes: 18 additions & 0 deletions docs/pages/app-settings/notifications/infopages.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import { Callout } from "nextra/components";
import { Steps } from "nextra/components";

## Infozettel

Der Ersteller eines Infozettels kann regulieren, ob die Kursmitlgieder darüber benachrichtigt werden sollen, dass ein neuer Infozettel erstellt wurde,
bzw. es Änderungen gab.
Mit dieser Option, kannst du diese an- und ausschalten.
Um dies einzustellen, folge diesen Schritten:

<Steps>
### Einstellungen in Sharezone öffnen

### "Benachrichtigungen" öffnen

### Haken bei "Benachrichtigungen für Infozettel" setzen

</Steps>
24 changes: 24 additions & 0 deletions docs/pages/app-settings/notifications/open-homework.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
import { Steps } from "nextra/components";
import { Callout } from "nextra/components";

# Offene Hausaufgabe

<Callout type="warning">
Die Funktion, die Uhrzeit für die Benachrichtigungen festgelegen zu können,
ist nur mit Sharezone Plus verfügbar! Ohne Sharezone Plus kannst du die
Benachrichtigungen nur aktivieren oder deaktivieren.
</Callout>

Du kannst dich zu einer festgelegten Uhrzeit über offene Hausaufgaben benachrichtigen lassen.
Um dies zu aktivieren, folge diesen Schritten:

<Steps>
### Einstellungen in Sharezone öffnen

### "Benachrichtigungen" öffnen

### Haken bei "Erinnerung für offene Hausaufgaben" setzen

### Uhrzeit für die Benachrichtigungen einstellen

</Steps>
18 changes: 18 additions & 0 deletions docs/pages/app-settings/theme.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
import { Steps } from "nextra/components";

# Systemerscheinungsbild ändern

Wenn du dein Sharezone-Erscheinungsbild ändern möchtest, kannst du dies über die Einstellungen tun. Führe dazu folgende Schritte aus:

<Steps>
### Einstellungen in Sharezone öffnen

### "Erscheinungsbild" öffnen

### Gewünschtes Erscheinungsbild auswählen:

- Heller Modus
- Dunkler Modus
- System

</Steps>
56 changes: 56 additions & 0 deletions docs/pages/app-settings/timetable.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
import { Steps } from "nextra/components";

# Stundenplaneinstellungen

Es gibt verschiedene Möglichkeiten den Stundenplan und sein Erscheinungsbild zu verändern.
Gehe dazu in deine Einstellungen und drücke auf "Stundenplan"

Du kannst nun verschiedene Sachen einstellen:

## Länge einer Stunde

Du kannst die normale Länge einer Stunde einstellen, damit Sharezone dir automatisch die Endzeit der Stunde errechnet.
Die kannst du wie folgt einstellen:

<Steps>
### Auf "Länge einer Stunde einstellen" drücken

### Gewünschte Stundenlänge auswählen

### Mit "Bestätigen" die gewünschte Stundenzeit einstellen

</Steps>

## A/B Wochen

Du kannst 2 verschiedene Wochen-Stundenpläne erstellen. Diese werden abwechselnd benutzt und angezeigt.
Führe dafür folgende Schritte aus:

<Steps>
### Haken bei "A/B Wochen" setzen

### Mit Haken bei "A-Wochen sind gerade Kalenderwochen" festlegen, ob A-Wochen gerade oder ungerade Kalenderwochen sind.

### Unter dem "Stundenplan" A und B-Wochen einrichten.

</Steps>

## Stundenplanbeginn

Du kannst einstellen, ab wann dein Stundenplan anfängt.
Drücke dazu auf "Stundenplanbeginn" und stelle die gewünschte Uhrzeit ein.
Bestätige deine Auswahl mit "OK".

## Kürzel im Stundenplan anzeigen

Um die Kurs-Kürzle im Stundenplan anzeigen zu lassen, setze den Haken bei "Kürzle im Stundenplan anzeigen"

## Aktivierte Wochentage

Du kannst festlegen, welche Wochentage in deinem Stundenplan angezeigt werden.
Drücke dafür auf "Schultage"
Du kannst nun bei den gewünschten Wochentagen einen Haken setzen.

## Stundenzeiten einstellen

Du kannst die Zeiten für die 1., 2., 3. etc. Stunde festlegen.
4 changes: 4 additions & 0 deletions docs/pages/more/_meta.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
{
"alpha-program": "Alpha-Program",
"beta-program": "Beta-Program",
"github_link": {
"title": "Contributing",
"href": "https://github.com/SharezoneApp/sharezone-app/blob/main/CONTRIBUTING.md",
"firewall": "Firewall",
"newWindow": true},
"content-creator-program": "Content Creator Programm"
}

0 comments on commit 2fbd046

Please sign in to comment.