You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
6.0 KiB
6.0 KiB
OpenIM-Serverdokumente
Willkommen im OpenIM-Dokumentationshub! Dieses Zentrum bietet eine umfassende Auswahl an Leitfäden und Handbüchern, die Ihnen dabei helfen sollen, das Beste aus Ihrem OpenIM-Erlebnis herauszuholen.
Inhaltsverzeichnis
- Contrib - Anleitung zu Beiträgen und Konfigurationen für Entwickler
- Conversions - Codierungskonventionen, Protokollierungsrichtlinien und andere Transformationstools
Beitrag
Dieser Abschnitt bietet Entwicklern eine detaillierte Anleitung zum Beitragen von Code, zum Einrichten ihrer Umgebung und zum Befolgen der zugehörigen Prozesse.
- Code Conventions - Regeln und Konventionen zum Schreiben von Code in OpenIM.
- Development Guide - Eine Anleitung zur Durchführung der Entwicklung innerhalb von OpenIM.
- Git Cherry Pick - Richtlinien zur Rosinenpickerei.
- Git Workflow - Der Git-Workflow in OpenIM.
- Initialization Configurations - Anleitung zum Einrichten und Initialisieren von OpenIM.
- Docker Installation - So installieren Sie Docker auf Ihrem Computer.
- Linux Development Environment - Anleitung zum Einrichten der Entwicklungsumgebung unter Linux.
- Local Actions - Richtlinien zur Durchführung bestimmter allgemeiner Aktionen vor Ort.
- Offline Deployment - Methoden zur Offline-Bereitstellung von OpenIM.
- Protoc Tools - Anleitung zur Verwendung von Protokolltools.
- Go Tools - Tools und Bibliotheken in OpenIM für Go.
- Makefile Tools - Best Practices und Tools für Makefile.
- Script Tools - Best Practices und Tools für Skripte.
Konvertierungen
In diesem Abschnitt werden verschiedene Konventionen und Richtlinien innerhalb von OpenIM vorgestellt, die Code, Protokolle, Versionen und mehr umfassen.
- API Conversions - Richtlinien und Methoden für API-Konvertierungen.
- Logging Policy - Protokollierungsrichtlinien und -konventionen in OpenIM.
- CI/CD Actions - Verfahren und Konventionen für CI/CD.
- Commit Conventions - Konventionen für Code-Commits in OpenIM.
- Directory Conventions - Verzeichnisstruktur und Konventionen innerhalb von OpenIM.
- Error Codes - Liste und Beschreibungen der Fehlercodes.
- Go Code Conversions - Konventionen und Konvertierungen für Go-Code.
- Docker Image Strategy - Verwaltungsstrategien für OpenIM-Docker-Images, die mehrere Architekturen und Image-Repositorys umfassen.
- Logging Conventions - Weitere detaillierte Konventionen zur Protokollierung.
- Version Conventions - Benennungs- und Verwaltungsstrategien für OpenIM-Versionen.
Für Entwickler, Mitwirkende und Community-Betreuer
Entwickler und Mitwirkende
Wenn Sie Entwickler sind oder gerne einen Beitrag leisten möchten:
- Machen Sie sich mit unseren Code Conventions und unserem Git Workflow vertraut, um reibungslose Beiträge zu gewährleisten.
- Tauchen Sie ein in den Development Guide, um sich mit den Entwicklungspraktiken in OpenIM vertraut zu machen.
Community-Betreuer
Als Community-Betreuer:
- Stellen Sie sicher, dass die Beiträge den in unserer Dokumentation dargelegten Standards entsprechen.
- Überprüfen Sie regelmäßig die Logging Policy und die Error Codes, um auf dem Laufenden zu bleiben.
Für Benutzer
Benutzer sollten besonders auf Folgendes achten:
- Docker Installation - Erforderlich, wenn Sie Docker-Images von OpenIM verwenden möchten.
- Docker Image Strategy - Um die verschiedenen verfügbaren Bilder zu verstehen und wie Sie das richtige für Ihre Architektur auswählen.