diff --git a/BUILDING.md b/BUILDING.md new file mode 100644 index 000000000..945d71eee --- /dev/null +++ b/BUILDING.md @@ -0,0 +1 @@ +# BUILDING \ No newline at end of file diff --git a/README-zh_CN.md b/README-zh_CN.md index b9b58deec..a63537321 100644 --- a/README-zh_CN.md +++ b/README-zh_CN.md @@ -234,11 +234,11 @@ config/config.yaml中针对存储组件有详细的配置说明 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 diff --git a/README.md b/README.md index 5ed6664db..0b2d9fe43 100644 --- a/README.md +++ b/README.md @@ -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. -![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 -![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 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. diff --git a/Vagrantfile b/Vagrantfile new file mode 100644 index 000000000..53ca648a3 --- /dev/null +++ b/Vagrantfile @@ -0,0 +1 @@ +# VAGRANTFILE \ No newline at end of file diff --git a/assets/README.md b/assets/README.md index d3e735dc0..c6ddc3c1e 100644 --- a/assets/README.md +++ b/assets/README.md @@ -25,7 +25,7 @@ assets/ ## 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(席欣). diff --git a/docs/contrib/code_conventions.md b/docs/contrib/code_conventions.md index 1387da2f7..1a5e043f9 100644 --- a/docs/contrib/code_conventions.md +++ b/docs/contrib/code_conventions.md @@ -35,4 +35,4 @@ ## Testing conventions -Please refer to [TESTING.md](../../tests/TESTING.md) document. +Please refer to [TESTING.md](../../README.md) document. diff --git a/docs/contrib/development.md b/docs/contrib/development.md index 64aa08cda..91424ab51 100644 --- a/docs/contrib/development.md +++ b/docs/contrib/development.md @@ -62,7 +62,7 @@ OpenIM build and test processes development require Docker to run certain steps. ### 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/) - [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) - [Building](../../BUILDING.md) -- [Testing](../../tests/TESTING.md) +- [Testing](../../README.md) ## Dependency management diff --git a/docs/contrib/git-workflow.md b/docs/contrib/git-workflow.md new file mode 100644 index 000000000..a9ebd97f0 --- /dev/null +++ b/docs/contrib/git-workflow.md @@ -0,0 +1 @@ +# GIT-WORKFLOW \ No newline at end of file diff --git a/docs/conversions/log.md b/docs/conversions/log.md new file mode 100644 index 000000000..de866f226 --- /dev/null +++ b/docs/conversions/log.md @@ -0,0 +1 @@ +# LOG \ No newline at end of file