mirror of https://github.com/openimsdk/open-im-server.git synced 2025-04-05 05:12:45 +08:00

History

docs:Modified the language naming of files and changed some error paths (#1898 )

* Add Simplified Chinese README.md

* Add Ukrainian README.md

* Add Traditional Chinese README.md

* Add Czech README.md

* Add Hungarian README.md

* Add spanish README.md

* Add Persian README.md

* Add French README.md

* Add German README.md

* Add Japanese README.md

* Add Polish README.md

* Add Indonesian README.md

* Add Finnish README.md

* Add Malayalam README.md

* Add Dutch README.md

* Add Italian README.md

* Add Russian README.md

* Added Brazilian Portuguese README.md

* Add Esperanto README.md

* Add Korean README.md

* Add Vietnamese README.md

* Add Arabic README.md

* Add Danish README.md

* Add Greek README.md

* Add Turkish README.md

* Correct document suffix to distinguish language versions

* Improve path and file naming corrections

* Correct document suffix to distinguish language versions

* Improve path and file naming corrections

* Add Ukrainian README_uk.md

2024-02-07 13:52:38 +00:00

contrib

fix document parameter errors (#1848 )

2024-02-01 02:10:38 +00:00

contributing

feat: add architecture layers (#1860 )

2024-02-02 11:47:16 +00:00

images

feat: add architecture layers (#1860 )

2024-02-02 11:47:16 +00:00

readme

docs:Modified the language naming of files and changed some error paths (#1898 )

2024-02-07 13:52:38 +00:00

.generated_docs

feat(main): 🚀 Database Name Correction and S3 Module Int32 Overflow Fix with Go Routine Integration for Automated Checks and Script Optimization (#1799 )

2024-01-26 02:02:53 +00:00

CODEOWNERS

docs: add rfyiamcool to code_owners (#1491 )

2023-11-30 08:58:53 +00:00

README.md

feat: add architecture layers (#1860 )

2024-02-02 11:47:16 +00:00

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.

README.md

OpenIM Server Docs

Table of Contents

Contrib

Conversions

For Developers, Contributors, and Community Maintainers

Developers & Contributors

Community Maintainers

For Users