Bifolk Dokumentation¶
Willkommen zur Bifolk-Dokumentation! Bifolk ist eine umfassende Imkerei-Verwaltungsanwendung, die Imkern, Familien, Genossenschaften und Organisationen hilft, ihre Bienenstände effizient zu verwalten.
Dokumentationsabschnitte¶
📱 Benutzerdokumentation¶
Für Imker und Endbenutzer
Erfahren Sie, wie Sie die Funktionen von Bifolk zur Verwaltung Ihrer Bienenstöcke, Verfolgung von Inspektionen, Erfassung von Ernten und mehr nutzen können.
- Erste Schritte - Erste Schritte mit Bifolk
- Dashboard-Übersicht - Dashboard verstehen
- Bienenstockverwaltung - Bienenstöcke erstellen und verwalten
- Inspektionen - Inspektionen aufzeichnen
- Königinnenverwaltung - Königinnen und Abstammung verfolgen
- Operationen & Aufgaben - Fütterung, Behandlungen und Aufgaben
- Zucht - Königinnenzucht und Volksteilung
- Ernten - Ernten erfassen und verfolgen
- Lager & Inventar - Ausrüstung und Produktverwaltung
- Profil & Einstellungen - Ihre Kontoeinstellungen
👥 Admin-Dokumentation¶
Für Anwendungsadministratoren und Organisationsbesitzer
Erfahren Sie, wie Sie Bifolk verwalten, Benutzer verwalten, Organisationen konfigurieren und das System pflegen.
- Admin-Übersicht - Admin-Dokumentationshub
- Installation - Ersteinrichtung und Konfiguration
- Benutzerverwaltung - Benutzerkonten verwalten
- Organisationsverwaltung - Organisationen und Mitgliedschaften
- Berechtigungen & Rollen - Das Berechtigungssystem verstehen
- Systemkonfiguration - Konfigurierbare Optionen und Einstellungen
- Datenverwaltung - Anwendungsdaten verwalten
- Wartung - Systemwartungsaufgaben
🚀 Deployment-Dokumentation¶
Für Systemadministratoren und DevOps
Erfahren Sie, wie Sie Bifolk in Produktionsumgebungen installieren, konfigurieren und warten.
- Deployment-Übersicht - Deployment-Dokumentationshub
- Installationsanleitung - Systemanforderungen und Einrichtung
- Konfiguration - Umgebungsvariablen und Einstellungen
- Docker Secrets - Sichere Konfigurationsverwaltung
- Aktualisierung - Upgrade-Verfahren und Migrationen
- Sicherung & Wiederherstellung - Datensicherungsstrategien
- Fehlerbehebung - Häufige Probleme und Lösungen
🔧 Technische Dokumentation¶
Für Entwickler und fortgeschrittene Administratoren
Technische Architektur, Datenbankmodelle, API-Referenz und Entwicklungsinformationen.
- Technische Übersicht - Technischer Dokumentationshub
- Architektur - Systemarchitektur und Design
- Datenbankmodelle - Vollständige Modellreferenz
- Berechtigungssystem - Berechtigungsarchitektur
- Übersetzung & i18n - Mehrsprachige Unterstützung
- App-Referenzen:
- Home App
- Users App
- Organizations App
- Hives App
- Breeding App
- Warehouse App
- SystemConfig App
- Notifications App
- DataExchange App
Schnellstartanleitungen¶
Für Benutzer¶
- Neu bei Bifolk? Beginnen Sie mit Erste Schritte
- Ersten Bienenstock erstellen: Bienenstockverwaltungs-Leitfaden
- Inspektion aufzeichnen: Inspektions-Leitfaden
- Benötigen Sie Hilfe? Überprüfen Sie den entsprechenden Benutzerhandbuch oben
Für Administratoren¶
- Bifolk installieren? Siehe Installationsanleitung
- Benutzer einrichten? Lesen Sie Benutzerverwaltung
- Organisationen konfigurieren? Überprüfen Sie Organisationsverwaltung
- Sicherheitseinrichtung? Überprüfen Sie Docker Secrets
Für Entwickler¶
- Code verstehen? Beginnen Sie mit Architektur
- Mit Modellen arbeiten? Überprüfen Sie Datenbankmodelle
- Übersetzungen hinzufügen? Lesen Sie Übersetzung & i18n
Häufige Aufgaben¶
| Aufgabe | Dokumentationslink |
|---|---|
| Bifolk zum ersten Mal installieren | Installationsanleitung |
| Eine neue Beute erstellen | Beutenverwaltung |
| Eine Beuteninspektion aufzeichnen | Inspektionen |
| Königinnenlinie verfolgen | Königinnenverwaltung |
| Ein Zuchtprogramm einrichten | Zucht |
| Eine Honigernte aufzeichnen | Ernten |
| Inventar verwalten | Lager & Inventar |
| Benutzer zu einer Organisation hinzufügen | Organisationsverwaltung |
| Systemauswahlmöglichkeiten konfigurieren | Systemkonfiguration |
| Datenbank sichern | Backup & Wiederherstellung |
| Auf eine neue Version aktualisieren | Aktualisierung |
| Probleme beheben | Fehlerbehebung |
Navigation in der Dokumentation¶
- Breadcrumb-Navigation: Jedes Dokument enthält Links zu verwandten Themen
- Suche: Verwenden Sie die Suchfunktion Ihres Browsers (Strg+F / Cmd+F)
- Querverweise: Links in der gesamten Dokumentation verbinden verwandte Themen
- Codebeispiele: Technische Dokumentation enthält Codeausschnitte, wo zutreffend
- Screenshots: Benutzerdokumentation wird Screenshots enthalten (demnächst)
Sprachunterstützung¶
Bifolk unterstützt mehrere Sprachen: - Englisch (Standard) - Deutsch
Benutzer können ihre bevorzugte Sprache in ihren Profileinstellungen auswählen.
Hilfe erhalten¶
- Benutzerprobleme: Überprüfen Sie den relevanten Abschnitt der Benutzerdokumentation
- Admin-Fragen: Siehe Administrator-Dokumentation
- Technische Probleme: Lesen Sie die Fehlerbehebungsanleitung
- Fehlerberichte: Reichen Sie Probleme im Issue-Tracker des Projekts ein
- Funktionsanfragen: Kontaktieren Sie das Entwicklungsteam
Über diese Dokumentation¶
Zielgruppen: - 🐝 Imker - Nicht-technische Benutzer, die ihre Bienenstände verwalten - 👥 Administratoren - Organisationsinhaber und App-Administratoren - 🚀 Systemadministratoren - DevOps- und Bereitstellungsingenieure - 🔧 Entwickler - Mitwirkende und Integratoren
Dokumentationsstruktur: - Benutzerdokumentation verwendet einfache, klare Sprache mit Schritt-für-Schritt-Anleitungen - Admin-Dokumentation konzentriert sich auf Konfigurations- und Verwaltungsverfahren - Bereitstellungsdokumentation deckt Installation und Infrastruktur ab - Technische Dokumentation bietet detaillierte Architektur- und API-Informationen
Zur Dokumentation beitragen¶
Haben Sie einen Fehler gefunden oder möchten Sie die Dokumentation verbessern? Beiträge zur Dokumentation sind willkommen!
- Behalten Sie Übersetzungen im Auge (Englisch und Deutsch)
- Testen Sie alle Verfahren, bevor Sie sie dokumentieren
Häufig gestellte Fragen¶
Allgemeine Fragen¶
F: Welche Sprachen unterstützt Bifolk? A: Englisch und Deutsch. Siehe Übersetzung & i18n.
F: Kann ich Bifolk auf meinem Telefon verwenden? A: Ja! Bifolk funktioniert auf Tablets und Smartphones mit responsivem Design.
F: Wie funktionieren Organisationen? A: Organisationen ermöglichen es mehreren Benutzern, mit rollenbasierten Berechtigungen zusammenzuarbeiten. Siehe Organisationsverwaltung.
Installation & Bereitstellung¶
F: Was sind die Systemanforderungen? A: Docker Engine 20.10+ und Docker Compose 2.0+. Siehe Installation.
F: Wie sichere ich meine Daten? A: Siehe Backup & Wiederherstellungsanleitung.
F: Kann ich SQLite in der Produktion verwenden? A: Nicht empfohlen. Verwenden Sie PostgreSQL für die Produktion. Siehe Konfiguration.
Für Benutzer¶
F: Wie füge ich eine Beute hinzu? A: Siehe Ihre erste Beute erstellen.
F: Wie verfolge ich die Linie meiner Königin? A: Siehe Königinnenverwaltung.
F: Wo zeichne ich Ernten auf? A: Siehe Ernteaufzeichnung.
Imkerei-Glossar¶
Häufige Begriffe: - Bienenstand - Ort, an dem Bienenstöcke gehalten werden - Brut - Bienenlarven und Puppen in Zellen - Volk - Gemeinschaft von Bienen, die in einer Beute leben - Rähmchen - Entnehmbare Strukturen, die Waben halten - Umlarven - Larven umsetzen, um Weiselzellen zu erstellen - Königin - Reproduktive weibliche Biene - Honigraum - Zarge zur Honigspeicherung - Varroa - Parasitäre Milbe, die Bienen befällt
Bifolk-Begriffe: - Organisation - Imkergruppe mit mehreren Benutzern - Rolle - Berechtigungsstufe (Inhaber, Administrator, Mitglied, Betrachter) - Inspektion - Aufgezeichnete Beutenuntersuchung - Operation - Geplante Aufgabe oder Aktion - Zuchtdatensatz - Königinnenzucht-Dokumentation - Ableger - Volksteilungs-Datensatz