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.
Open-IM-Server/docs
Xinwei Xiong 8aac6c6f81
Fix(main): fix openim config from mongo password env upgrade openim build CICD (#1689)
12 months ago
..
contrib Fix(main): fix openim config from mongo password env upgrade openim build CICD (#1689) 12 months ago
images Add files via upload 1 year ago
.generated_docs Large refactoring projects: OpenIM automation, scripting, and openimctl refactoring (#825) 1 year ago
CODEOWNERS docs: add rfyiamcool to code_owners (#1491) 1 year ago
README.md ☀️ feat: Enhancing OpenIM with Integrated E2E Testing and CI/CD Enhancements (#1359) 1 year 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.

Table of Contents

  1. Contrib - Guidance on contributing and configurations for developers
  2. 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.

Conversions

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

For Developers, Contributors, and Community Maintainers

Developers & Contributors

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

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.