"docs update"

pull/916/head
DreamerXXT 2 years ago
parent ffa3b53065
commit a076efc23b

@ -0,0 +1 @@
# BUILDING

@ -234,11 +234,11 @@ config/config.yaml中针对存储组件有详细的配置说明
OpenIM 是开源的即时通讯组件它并不是一个独立的产品此图展示了AppServer、AppClient、Open-IM-Server以及Open-IM-SDK之间的关系 OpenIM 是开源的即时通讯组件它并不是一个独立的产品此图展示了AppServer、AppClient、Open-IM-Server以及Open-IM-SDK之间的关系
![https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/open-im-server.png](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/open-im-server.png) ![https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/open-im-server.png](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/open-im-server.png)
## 整体架构 ## 整体架构
![https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/Architecture.jpg](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/Architecture.jpg) ![https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/Architecture.jpg](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/Architecture.jpg)
## 开始开发 OpenIM ## 开始开发 OpenIM

@ -227,11 +227,11 @@ Stop services
OpenIM is an open source instant messaging component, it is not an independent product. This image shows the relationship between AppServer, AppClient, Open-IM-Server and Open-IM-SDK. OpenIM is an open source instant messaging component, it is not an independent product. This image shows the relationship between AppServer, AppClient, Open-IM-Server and Open-IM-SDK.
![https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/open-im-server.png](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/open-im-server.png) ![https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/open-im-server.png](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/open-im-server.png)
## Overall Architecture ## Overall Architecture
![https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/Architecture.jpg](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/Architecture.jpg) ![https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/Architecture.jpg](https://github.com/OpenIMSDK/Open-IM-Server/blob/main/docs/images/Architecture.jpg)
## To start developing OpenIM ## To start developing OpenIM
The [community repository](https://github.com/OpenIMSDK/community) hosts all information about building Kubernetes from source, how to contribute code and documentation, who to contact about what, etc. The [community repository](https://github.com/OpenIMSDK/community) hosts all information about building Kubernetes from source, how to contribute code and documentation, who to contact about what, etc.

1
Vagrantfile vendored

@ -0,0 +1 @@
# VAGRANTFILE

@ -25,7 +25,7 @@ assets/
## Copyright Notice: ## Copyright Notice:
The OpenIM logo, including its variations and animated versions, displayed in this repository [OpenIM](https://github.com/OpenIMSDK/openim) under the `/assets/logo` and `/assets/logo-gif` directories, are protected by copyright laws. The OpenIM logo, including its variations and animated versions, displayed in this repository [OpenIM](https://github.com/OpenIMSDK) under the `/assets/logo` and `/assets/logo-gif` directories, are protected by copyright laws.
The logo design is credited to @Xx(席欣). The logo design is credited to @Xx(席欣).

@ -35,4 +35,4 @@
## Testing conventions ## Testing conventions
Please refer to [TESTING.md](../../tests/TESTING.md) document. Please refer to [TESTING.md](../../README.md) document.

@ -62,7 +62,7 @@ OpenIM build and test processes development require Docker to run certain steps.
### Vagrant ### Vagrant
As described in the [Testing documentation](../../tests/TESTING.md), all the smoke tests are run in virtual machines managed by Vagrant. To install Vagrant in the development environment, [follow the instructions from the Hashicorp website](https://www.vagrantup.com/downloads), alongside any of the following hypervisors: As described in the [Testing documentation](../../README.md), all the smoke tests are run in virtual machines managed by Vagrant. To install Vagrant in the development environment, [follow the instructions from the Hashicorp website](https://www.vagrantup.com/downloads), alongside any of the following hypervisors:
- [VirtualBox](https://www.virtualbox.org/) - [VirtualBox](https://www.virtualbox.org/)
- [libvirt](https://libvirt.org/) and the [vagrant-libvirt plugin](https://github.com/vagrant-libvirt/vagrant-libvirt#installation) - [libvirt](https://libvirt.org/) and the [vagrant-libvirt plugin](https://github.com/vagrant-libvirt/vagrant-libvirt#installation)
@ -73,7 +73,7 @@ These topics already have been addressed on their respective documents:
- [Git Workflow](./git-workflow.md) - [Git Workflow](./git-workflow.md)
- [Building](../../BUILDING.md) - [Building](../../BUILDING.md)
- [Testing](../../tests/TESTING.md) - [Testing](../../README.md)
## Dependency management ## Dependency management

Loading…
Cancel
Save