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.1 KiB
6.1 KiB
Documentation du serveur OpenIM
Bienvenue dans le hub de documentation OpenIM ! Ce centre propose une gamme complète de guides et de manuels conçus pour vous aider à tirer le meilleur parti de votre expérience OpenIM.
Table des matières
- Contrib - Conseils sur la contribution et les configurations pour les développeurs
- Conversions - Conventions de codage, politiques de journalisation et autres outils de transformation
Contribuer
Cette section propose aux développeurs un guide détaillé sur la façon de contribuer au code, de configurer leur environnement et de suivre les processus associés.
- Code Conventions - Règles et conventions pour écrire du code dans OpenIM.
- Development Guide - Un guide sur la façon de réaliser du développement au sein d'OpenIM.
- Git Cherry Pick - Lignes directrices sur les opérations de triage.
- Git Workflow - Le flux de travail git dans OpenIM.
- Initialization Configurations - Conseils sur la configuration et l’initialisation d’OpenIM.
- Docker Installation - Comment installer Docker sur votre machine.
- Linux Development Environment - Guide pour configurer l'environnement de développement sous Linux.
- Local Actions - Des lignes directrices pour mener localement certaines actions communes.
- Offline Deployment - Méthodes de déploiement d'OpenIM hors ligne.
- Protoc Tools - Guide sur l'utilisation des outils de protocole.
- Go Tools - Outils et bibliothèques dans OpenIM for Go.
- Makefile Tools - Meilleures pratiques et outils pour Makefile.
- Script Tools - Meilleures pratiques et outils pour les scripts.
Conversions
Cette section présente diverses conventions et politiques au sein d'OpenIM, englobant le code, les journaux, les versions, etc.
- API Conversions - Lignes directrices et méthodes pour les conversions API.
- Logging Policy - Politiques et conventions de journalisation dans OpenIM.
- CI/CD Actions - Politiques et conventions de journalisation dans OpenIM.
- Commit Conventions - Politiques et conventions de journalisation dans OpenIM.
- Directory Conventions - Structure de répertoire et conventions au sein d'OpenIM.
- Error Codes - Liste et descriptions des codes d'erreur.
- Go Code Conversions - Conventions et conversions pour le code Go.
- Docker Image Strategy - Stratégies de gestion des images OpenIM Docker, couvrant plusieurs architectures et référentiels d'images.
- Logging Conventions - Conventions plus détaillées sur la journalisation.
- Version Conventions - Stratégies de nommage et de gestion pour les versions OpenIM.
Pour les développeurs, les contributeurs et les responsables de la communauté
Développeurs et contributeurs
Si vous êtes un développeur ou quelqu'un désireux de contribuer :
- Familiarisez-vous avec nos Code Conventions et notre Git Workflow pour garantir des contributions fluides.
- Plongez dans le Development Guide pour vous familiariser avec les pratiques de développement dans OpenIM.
Responsables de la communauté
En tant que responsable de la communauté :
- EAssurez-vous que les contributions sont conformes aux normes décrites dans notre documentation.
- onsultez régulièrement la Logging Policy et les Error Codes pour rester à jour.
Pour les utilisateurs
Les utilisateurs doivent prêter une attention particulière à :
- Docker Installation - Nécessaire si vous prévoyez d'utiliser des images Docker d'OpenIM.
- Docker Image Strategy - Pour comprendre les différentes images disponibles et comment choisir celle qui convient à votre architecture.