Skip to content

Commit

Permalink
docs: apply versioning (/1.x, /next) (#479)
Browse files Browse the repository at this point in the history
* docs: apply versioning (/1.x, /next)
* fix: crowdin adds html tags
* feat: permanent /2.x url path
* fix: navbar item links
  • Loading branch information
SychO9 authored Nov 4, 2024
1 parent 194ec3e commit d6db3ef
Show file tree
Hide file tree
Showing 544 changed files with 67,565 additions and 25 deletions.
2 changes: 2 additions & 0 deletions crowdin.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,5 @@ files:
translation: /i18n/%two_letters_code%/**/%original_file_name%
- source: /docs/**/*
translation: /i18n/%two_letters_code%/docusaurus-plugin-content-docs/current/**/%original_file_name%
- source: /versioned_docs/version-1.x/**/*
translation: /i18n/%two_letters_code%/docusaurus-plugin-content-docs/version-1.x/**/%original_file_name%
31 changes: 26 additions & 5 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,18 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
sidebarPath: require.resolve('./sidebars.js'),
sidebarCollapsible: false,
editUrl: 'https://github.com/flarum/docs/tree/master',
lastVersion: '1.x',
versions: {
current: {
label: '2.x',
path: '2.x',
},
'1.x': {
label: '1.x',
path: '/', // backwards compatibility, only needed for 1.x
// banner: 'unmaintained',
},
},
},
blog: false,
theme: {
Expand All @@ -75,21 +87,24 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
position: 'right',
},
{
to: '/',
type: 'doc',
docId: 'README',
label: 'Guide',
position: 'right',
// Anything that isn't `extend`, `'internal`, or contain a slash.
// Account for local 2-char code at the start.
activeBaseRegex: '^(\/[a-z][a-z])?\/(?!(extend\/?|internal\/?|)$).*',
},
{
to: 'extend',
type: 'doc',
docId: 'extend/README',
label: 'Extend',
position: 'right',
activeBasePath: `extend`,
},
{
to: 'internal',
type: 'doc',
docId: 'internal/README',
label: 'Internal',
position: 'right',
activeBasePath: `internal`,
Expand All @@ -104,7 +119,6 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
label: 'Flarum',
position: 'right',
items: [

{
href: 'https://flarum.org/',
label: 'Home'
Expand All @@ -118,7 +132,14 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
label: 'GitHub'
},
]
},{
},
{
type: 'docsVersionDropdown',
position: 'right',
dropdownItemsAfter: [],
dropdownActiveClassDisabled: true,
},
{
type: 'localeDropdown',
position: 'right',
},
Expand Down
4 changes: 2 additions & 2 deletions i18n/de/docusaurus-plugin-content-docs/current.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"version.label": {
"message": "Weiter",
"message": "2.x",
"description": "The label for version current"
},
"sidebar.guideSidebar.category.Introduction": {
Expand Down Expand Up @@ -39,4 +39,4 @@
"message": "Interne Dokumentation",
"description": "The label for category Internal Docs in sidebar internalSidebar"
}
}
}
45 changes: 45 additions & 0 deletions i18n/de/docusaurus-plugin-content-docs/version-1.x/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
- - -
slug: /
- - -

# Über Flarum

Flarum ist eine herrlich einfache Diskussionsplattform für deine Website. Es ist schnell, kostenlos und benutzerfreundlich und bietet alle Funktionen, die du für den Betrieb einer erfolgreichen Community benötigst. Zudem ist Flarum äußerst erweiterbar und lässt sich optimal anpassen.

![Flarum Startseite Screenshot](/en/img/home_screenshot.png)

## Ziele

Flarum ist der kombinierte Nachfolger von [esoTalk](https://github.com/esotalk/esoTalk) und [FluxBB](https://fluxbb.org). Flarum ist:

* **Schnell und einfach.** Kein Durcheinander, kein Ballast, keine komplexen Abhängigkeiten. Flarum wurde mit PHP erstellt, sodass es schnell und einfach bereitgestellt werden kann. Die Oberfläche wird mit [Mithril](https://mithril.js.org) betrieben, einem leistungsstarken JavaScript-Framework mit geringem Platzbedarf.

* **Schön und responsiv.** Dies ist eine Forensoftware für Menschen. Flarum wurde sorgfältig entwickelt, um plattformübergreifend konsistent und intuitiv zu sein, und zwar sofort nach der Installation.

* **Leistungsstark und erweiterbar.** Passe Flarum an, erweitere es und integriere es in deine Community. Die Architektur von Flarum ist erstaunlich flexibel, mit einer [leistungsfähigen Erweiterungs-API](/extend/README.md).

* **Kostenlos und Open Source.** Flarum wird unter der [MIT-Lizenz](https://github.com/flarum/flarum/blob/master/LICENSE) veröffentlicht.

Mehr über unsere [Philosophie und Werte für Flarum kannst du hier lesen](https://discuss.flarum.org/d/28869-flarum-philosophy-and-values).

## Unterstütze das Flarum-Projekt

Flarum ist eine [kostenlose, quelloffene](https://github.com/flarum/core) Software, die von Freiwilligen gepflegt und verwaltet wird. Wir sind auf die Beiträge der Community angewiesen, damit wir Flarum verbessern und erweitern können.

🧑💻 Wenn du ein Entwickler bist, solltest du in Erwägung ziehen, [zum Kern oder den gebündelten Erweiterungen von Flarum beizutragen](contributing.md). Dies ist **die** effizienteste Art, Flarum zu helfen, und Ihre Arbeit kann viel bewirken: Es gibt Tausende von Flarum-Seiten mit insgesamt Millionen von Endnutzern.

🧩 Wenn du eine Funktion vermisst oder eine Idee für ein Thema hast, [schreibe eine individuelle Erweiterung](extend/README.md), um Flarum für dich und andere zu verbessern.

✒️ Wenn du Erfahrung im technischen Schreiben hast, könnten deine Beiträge zu [unserer Dokumentation](https://github.com/flarum/docs/issues) zukünftigen Benutzern, Administratoren und Entwicklern helfen, das Beste aus Flarum zu machen.

🌐 Wenn du mehrere Sprachen sprichst, könntest du [Übersetzungen](extend/language-packs.md) beisteuern, um Flarum für unzählige Nutzer auf der ganzen Welt zugänglich zu machen.

💸 Die Flarum Foundation verdient kein Geld mit Flarum, hat aber Rechnungen zu bezahlen. Spenden über [GitHub Sponsors](https://github.com/sponsors/flarum) oder [OpenCollective](https://opencollective.com/flarum) werden immer dankbar angenommen. In der Vergangenheit konnten wir auch einige unserer Hauptentwickler finanziell unterstützen, damit sie in Teilzeit an Flarum arbeiten konnten. Dies wäre ohne eure finanzielle Unterstützung nicht möglich gewesen.

🧑🤝🧑 Tritt [unserer Community](https://discuss.flarum.org) bei, um über die Entwicklung von Flarum zu sprechen, Hilfe für deine Instanz zu bekommen oder einfach coole Leute zu treffen! Wenn du Erfahrung mit Flarum hast, kannst du auch gerne Anfängern helfen!

🐛 Wenn ein Fehler existiert, der dich stört, oder eine Idee für eine neue Funktion, die dir durch den Kopf geht, können wir es nicht wissen, wenn du es uns nicht sagst! Wir verfolgen Bugs, Vorschläge und zukünftige Entwicklungspläne [über GitHub](https://github.com/flarum/core/issues). Wenn bereits ein offenes Problem existiert, können Likes und (konstruktive) Zusatzinformationen sehr hilfreich sein!

📣 Und wenn dir Flarum gefällt, dann erwäge doch darüber zu bloggen/twittern/reden! Mehr Aufmerksamkeit für Flarum führt zu mehr Nutzern, die sich mit Flarum beschäftigen, und damit zu mehr Aktivität, besseren Erweiterungen und einer schnelleren Entwicklung.

Flarum wäre ohne unsere phänomenale Community nicht möglich. Wenn du daran interessiert bist, einen Beitrag zu leisten, findest du weitere Informationen in den Dokumenten für [Entwicklerbeiträge](contributing.md) und andere [Beiträge](contributing-docs-translations.md).
13 changes: 13 additions & 0 deletions i18n/de/docusaurus-plugin-content-docs/version-1.x/admin.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Admin-Dashboard

Das Flarum Admin Dashboard ist eine benutzerfreundliche Oberfläche zur Verwaltung deines Forums. Es ist nur für Benutzer in der Gruppe „Admin“ verfügbar. Um auf das Admin-Dashboard zuzugreifen, klicke oben rechts auf dem Bildschirm auf deinen **Namen** und wähle **Administration** aus.

Das Admin-Dashboard hat die folgenden Abschnitte:
- **Dashboard** – Zeigt das Haupt-Admin-Dashboard an, das Statistiken und andere relevante Informationen enthält.
- **Basics** - Zeigt die Optionen zum Festlegen grundlegender Forumsdetails wie Name, Beschreibung und Willkommensbanner.
- **E-Mail** - Ermöglicht die Konfiguration von E-Mail-Einstellungen. Siehe [hier](https://docs.flarum.org/mail) für weitere Informationen.
- **Berechtigungen** - Zeigt die Berechtigungen für jede Benutzergruppe an und ermöglicht dir, globale und spezifische Bereiche zu konfigurieren.
- **Erscheinungsbild** - Ermöglicht es, die Farben und das Branding des Forums anzupassen und zusätzliches CSS zur Anpassung hinzuzufügen.
- **Benutzer** – Stellt dir eine paginierte Liste aller Benutzer im Forum zur Verfügung und gibt die Möglichkeit, den Benutzer zu bearbeiten oder administrative Aktionen durchzuführen.

Abgesehen von den oben genannten Abschnitten ermöglicht das Admin-Dashboard auch die Verwaltung deiner Erweiterungen (einschließlich der Flarum-Core-Erweiterungen wie Tags) im Abschnitt _Features_. Erweiterungen, die das Forum-Thema ändern oder Ihnen erlauben, mehrere Sprachen zu verwenden, werden unter den Abschnitten _Themes_ bzw. _Sprachen_ kategorisiert.
28 changes: 28 additions & 0 deletions i18n/de/docusaurus-plugin-content-docs/version-1.x/bugs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Fehler melden

:::danger Sicherheitslücken

Wenn Du eine Sicherheitslücke in Flarum entdeckst, befolge bitte unsere [Sicherheitsrichtlinie](https://github.com/flarum/core/security/policy), damit wir sie umgehend beheben können.

:::

Vielen Dank, dass Du uns beim Testen von Flarum geholfen hast. Wir freuen uns, dich im Team zu haben! Wir brauchen Leute, die *Probleme geduldig lösen* und *sie klar kommunizieren* können. Wie Du wahrscheinlich weißt, erfordert eine gute Fehlerberichterstattung einige Zeit und Mühe. Wenn Du damit einverstanden bist, dann fangen wir an!

## Duplikate

Schon einen Fehler gefunden? Wundervoll! Wir würden gerne davon hören — doch zuerst solltest Du dich umsehen, um sicherzustellen, dass Du deine Zeit nicht mit einem bekannten Problem verschwendest:

- Durchsuche unser [Support-Forum](https://discuss.flarum.org/t/support), um zu sehen, ob es bereits gemeldet wurde.
- Wir könnten an einer Lösung arbeiten, also durchsuche auch unseren [Probleme-Tracker](https://github.com/flarum/core/issues).

Wenn Du *gründlich* gesucht hast und leer ausgegangen bist, freuen wir uns über deinen Bericht. Wenn es sich nur um ein einfaches Problem handelt (z. B. ein falsch geschriebenes Wort oder ein Grafikfehler), fahre mit dem nächsten Absatz fort. Wenn Du jedoch Fehler siehst oder etwas eindeutig defekt ist, musst Du zuerst einige Informationen sammeln. Bitte gehe zu unserem Leitfaden [Fehlerbehebung](troubleshoot.md) und befolge die dortigen Anweisungen. Sammel so viele Informationen wie möglich!

## Melden

Wir verfolgen Probleme auf GitHub. Stelle sicher, dass Du dein Problem im [richtigen Repository](https://github.com/flarum) öffnest und alle Informationen in der Fehlerberichtsvorlage ausfüllst.

Überprüfe nach Möglichkeit, ob das Problem mit der neuesten Version von Flarum reproduzierbar ist. Wenn Du eine Vorabversion oder eine Entwicklungsversion verwendest, gebe bitte die spezifische Version an, die Du verwendest.

Bedenke: Das Ziel eines Fehlerberichts ist es, es uns leicht zu machen, den Fehler zu replizieren und zu beheben. Vielleicht möchtest Du [diesen Artikel](https://www.chiark.greenend.org.uk/~sgtatham/bugs.html) lesen, um einige nützliche Tipps zum Schreiben eines effektiven Fehlerberichts zu erhalten. Es ist **erforderlich**, dass Du die notwendigen Schritte zum Reproduzieren des aufgetretenen Problems klar beschreibst. Probleme ohne eindeutige Reproduktionsschritte werden nicht gesichtet. Wenn ein Problem mit der Bezeichnung "Bestätigung erforderlich" länger als 5 Tage keine weiteren Eingaben vom Autor des Problems erhält, wird es geschlossen.

Sobald Du deinen Bericht gepostet hast, bitten wir dich, *der Diskussion zu folgen* und geduldig zu warten. Möglicherweise müssen wir um weitere Einzelheiten oder Klarstellungen bitten; Doch wir haben immer viel zu tun, und es kann eine Weile dauern, bis wir deinem Bericht die Zeit geben können, die er verdient.
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Verhaltenskodex

### _Willkommen in der Flarum-Community!_

... Und danke, dass du dabei bist! Wir sind begeistert von Flarum und freuen uns immer, Menschen zu treffen, denen es genauso geht. Wir möchten, dass *jeder* das Beste aus Flarum und der Flarum-Community herausholt, daher bitten wir Dich, diese Richtlinien zu lesen und zu befolgen. Diese gelten unabhängig davon, ob Du unser Forum, den Discord-Chat, die Kommunikation auf GitHub oder eine andere Form der Kommunikation ohne die Flarum-Community verwendest.

### Sei vor allem cool!

Wir sind alle hier, um über Flarum zu sprechen und gemeinsam daran zu arbeiten, es zu einer noch besseren Anwendung zu machen. Ideen zu kritisieren (natürlich durch begründete Argumente) ist ein wichtiger Teil davon. Aber lassen wir uns nicht hinreißen und verfallen in persönliche Angriffe, denn Negativität steht nur im Weg. Wir bitten Dich, Folgendes zu vermeiden:

- Beleidigende oder beleidigende Sprache sowie jede Art von Hassrede
- Beiträge, die darauf abzielen, andere zu belästigen, sich auszugeben oder zu diffamieren
- Unnötiges Löschen von geposteten Inhalten
- Versuche, die privaten Informationen anderer zu missbrauchen oder offenzulegen
- Obszöne oder sexuell explizite Inhalte
- Spam, Phishing-Posts und alle Aktionen, die darauf abzielen, diese Website zu verunstalten
- Diskussion über Softwarepiraterie und ähnliche Themen

*Alles oben Genannte sind Gründe für Moderatormaßnahmen.* Wenn Duein Problem mit einem anderen Mitglied habst, bitten wir Dich, dieses nicht selbst zu konfrontieren. Wenn es sich um das Forum handelt, verwende bitte den Befehl *Melden* für den betreffenden Beitrag und überlasse es dann den Mitarbeitern, sich mit der Situation zu befassen. Otherwise, report the violation using our [contact page](https://flarum.org/foundation/contact), option Legal.

Unsere Moderatoren können Inhalte bearbeiten oder löschen, die anstößig sind oder den Kommunikationsfluss stören. Unsere Moderatoren können Inhalte bearbeiten oder löschen, die anstößig sind oder den Kommunikationsfluss stören. Also, weißt du, *sei cool*. 😎

### Verschaffe Dir Gehör

Möchtest Du eine neue Diskussion beginnen? Lese zuerst unsere [FAQ](faq.md) und folge den Links, um sicherzustellen, dass Du vollständig über das Projekt informiert bist. Dann verbringe einige Zeit damit, das Forum zu durchsuchen, mache Dich mit [dem Tag-System](https://discuss.flarum.org/tags) vertraut und führe ein paar Suchen nach Schlüsselwörtern durch, die mit Deinem Thema zu tun haben: *Es könnte sein, dass jemand bereits eine Diskussion darüber begonnen hat!*

Wenn Du sicher bist, dass Du bereit bist, eine Diskussion zu beginnen, beachte bitte die folgenden Punkte:

- Gib ihm einen guten Titel! Die besten Ergebnisse erzielst Du, wenn Dein Titel deutlich macht, worüber Du sprechen möchtest.
- Richtige Tags auswählen. Dies erhöht die Wahrscheinlichkeit, dass dein Beitrag gelesen und zeitnah beantwortet wird.
- *Poste nicht* wiederholt über dasselbe Thema, da dies eher den gegenteiligen Effekt hat.
- If not using a tag set aside for multilingual use, *post in English only.* We can't help you if we don't understand your posts.
- Denken daran, dass du deine Beiträge nicht unterschreiben musst. Wir haben dein Profil, damit wir wissen, wer du bist.

Bitte bemühen dich, uns bei der Organisation zu helfen. Die Zeit, die wir mit Aufräumen verbringen, ist Zeit, die wir nicht damit verbringen können, dich kennenzulernen, deine Probleme zu besprechen und über Flarum zu sprechen. Und dafür sind wir schließlich alle hier!

### Lasse deine Antwort zählen

Du nimmst dir die Zeit, an einer Diskussion teilzunehmen, in der Hoffnung, dass andere deine Ideen lesen und berücksichtigen. Warum sich also nicht die Mühe machen, deine Antwort lesenswert zu machen?

- Antworte nicht auf einen Titel. Nehmen dir etwas Zeit, um das OP zu *lesen*, und mindestens den Rest des Gesprächs zuerst zu *scannen*.
- Fragen dich, ob deine Antwort zur Diskussion beiträgt. Wenn dies nicht der Fall ist, denke vor dem Posten noch einmal darüber nach.
- Vermeide Ein-Wort-Beiträge, nur um jemandem zuzustimmen; Du kannst dafür den 'Gefällt mir'-Button verwenden.
- Vermeide mehrere Posts hintereinander, wenn einer ausreichen würde. Dies ist ein Forum, kein Chatroom.
- Wenn deine Antwort wahrscheinlich den Verlauf der Diskussion ablenken wird, solltest du stattdessen eine neue Diskussion beginnen.
- Wenn du nur testweise ein bisschen Unsinn posten möchtest, tu dies bitte stattdessen im [Test-Posting](https://discuss.flarum.org/t/sandbox)-Tag.
- Stelle sicher, dass deine Antworten konstruktives Feedback und Unterstützung bieten, um eine integrative Community zu ermöglichen.

Niemand wird sich über den gelegentlichen Witz oder die kluge Bemerkung beschweren. Wir mögen es, die Stimmung leicht zu halten! Aber auch um die Dinge produktiv zu halten, bitten wir dich, zu vermeiden, dass eine Diskussion insgesamt entgleist.

> Vielen Dank an Dominion für seine Hilfe bei der Zusammenstellung dieser Richtlinien.
Loading

0 comments on commit d6db3ef

Please sign in to comment.