History

Xinwei Xiong cd7f35452e fix: fix docker file images proxy (#2071 ) * fix: fix docker file images proxy * fix: fix docker file images proxy * docs: optimize openim go code and logging docs		9 months ago
..
contrib	fix: fix docker file images proxy (#2071 )	9 months ago
contributing	feat: add architecture layers (#1860 )	10 months ago
images	feat: add architecture layers (#1860 )	10 months ago
readme	docs/README_el (#1929 )	9 months ago
.generated_docs	feat(main): 🚀 Database Name Correction and S3 Module Int32 Overflow Fix with Go Routine Integration for Automated Checks and Script Optimization (#1799 )	10 months ago
CODEOWNERS	docs: add rfyiamcool to code_owners (#1491 )	12 months ago
README.md	feat: add architecture layers (#1860 )	10 months ago

README.md

OpenIM Server Docs

Welcome to the OpenIM Documentation hub! This center provides a comprehensive range of guides and manuals designed to help you get the most out of your OpenIM experience.

Contrib - Guidance on contributing and configurations for developers
Conversions - Coding conventions, logging policies, and other transformation tools

Contrib

This section offers developers a detailed guide on how to contribute code, set up their environment, and follow the associated processes.

Code Conventions - Rules and conventions for writing code in OpenIM.
Development Guide - A guide on how to carry out development within OpenIM.
Git Cherry Pick - Guidelines on cherry-picking operations.
Git Workflow - The git workflow in OpenIM.
Initialization Configurations - Guidance on setting up and initializing OpenIM.
Docker Installation - How to install Docker on your machine.
Linux Development Environment - Guide to set up the development environment on Linux.
Local Actions - Guidelines on how to carry out certain common actions locally.
Offline Deployment - Methods of deploying OpenIM offline.
Protoc Tools - Guide on using protoc tools.
Go Tools - Tools and libraries in OpenIM for Go.
Makefile Tools - Best practices and tools for Makefile.
Script Tools - Best practices and tools for scripts.

Conversions

This section introduces various conventions and policies within OpenIM, encompassing code, logs, versions, and more.

API Conversions - Guidelines and methods for API conversions.
Logging Policy - Logging policies and conventions in OpenIM.
CI/CD Actions - Procedures and conventions for CI/CD.
Commit Conventions - Conventions for code commits in OpenIM.
Directory Conventions - Directory structure and conventions within OpenIM.
Error Codes - List and descriptions of error codes.
Go Code Conversions - Conventions and conversions for Go code.
Docker Image Strategy - Management strategies for OpenIM Docker images, spanning multiple architectures and image repositories.
Logging Conventions - Further detailed conventions on logging.
Version Conventions - Naming and management strategies for OpenIM versions.

For Developers, Contributors, and Community Maintainers

Developers & Contributors

If you're a developer or someone keen on contributing:

Familiarize yourself with our Code Conventions and Git Workflow to ensure smooth contributions.
Dive into the Development Guide to get a hang of the development practices in OpenIM.

Community Maintainers

As a community maintainer:

Ensure that contributions align with the standards outlined in our documentation.
Regularly review the Logging Policy and Error Codes to stay updated.

For Users

Users should pay particular attention to:

Docker Installation - Necessary if you're planning to use Docker images of OpenIM.
Docker Image Strategy - To understand the different images available and how to choose the right one for your architecture.