Fix Markdown format (milvus-io#1485)

* Fix milvus-io#839 and improve the code quality Signed-off-by: JinHai-CN <[email protected]> * Fix compiling error and building threads number Signed-off-by: JinHai-CN <[email protected]> * Fix Markdown quality Signed-off-by: JinHai-CN <[email protected]> * Fix Markdown quality Signed-off-by: JinHai-CN <[email protected]> * Fix Markdown quality Signed-off-by: JinHai-CN <[email protected]> * Fix Markdown format Signed-off-by: JinHai-CN <[email protected]> * Fix Markdown format Signed-off-by: JinHai-CN <[email protected]> * Fix Markdown format Signed-off-by: JinHai-CN <[email protected]>
Lancifolium · Mar 2, 2020 · 23e0816 · 23e0816
1 parent 5b93865
commit 23e0816
Show file tree

Hide file tree

Showing 10 changed files with 142 additions and 124 deletions.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -6,19 +6,19 @@ In the interest of fostering an open and welcoming environment, we as contributo
 
 Examples of behavior that contributes to creating a positive environment include:
 
-- Using welcoming and inclusive language.
-- Being respectful of differing viewpoints and experiences.
-- Gracefully accepting constructive criticism.
-- Focusing on what is best for the community.
-- Showing empathy towards other community members.
+-   Using welcoming and inclusive language.
+-   Being respectful of differing viewpoints and experiences.
+-   Gracefully accepting constructive criticism.
+-   Focusing on what is best for the community.
+-   Showing empathy towards other community members.
 
 Examples of unacceptable behavior by participants include:
 
-- The use of sexualized language or imagery and unwelcome sexual attention or advances.
-- Trolling, insulting/derogatory comments, and personal or political attacks.
-- Public or private harassment.
-- Publishing others' private information, such as a physical or electronic address, without explicit permission.
-- Conduct which could reasonably be considered inappropriate for the forum in which it occurs.
+-   The use of sexualized language or imagery and unwelcome sexual attention or advances.
+-   Trolling, insulting/derogatory comments, and personal or political attacks.
+-   Public or private harassment.
+-   Publishing others' private information, such as a physical or electronic address, without explicit permission.
+-   Conduct which could reasonably be considered inappropriate for the forum in which it occurs.
 
 All Milvus forums and spaces are meant for professional interactions, and any behavior which could reasonably be considered inappropriate in a professional setting is unacceptable.
 

diff --git a/COMMUNITY.md b/COMMUNITY.md
@@ -2,10 +2,10 @@
 
 <!-- TOC -->
 
-- [TSC Members](#tsc-members)
-- [Committers](#committers)
-- [Reviewers](#reviewers)
-- [Contributors](#contributors)
+-   [TSC Members](#tsc-members)
+-   [Committers](#committers)
+-   [Reviewers](#reviewers)
+-   [Contributors](#contributors)
 
 <!-- /TOC -->
 
@@ -15,11 +15,11 @@ The Technical Steering Committee (TSC) functions as the core management team tha
 
 TSC members have the following responsibilities:
 
-- Coordinate the technical direction of the project.
-- Approve project or system proposals.
-- Decide on formal releases of the project's software.
-- Organize and remove sub-projects.
-- Coordinate any marketing, events, or communications regarding the project.
+-   Coordinate the technical direction of the project.
+-   Approve project or system proposals.
+-   Decide on formal releases of the project's software.
+-   Organize and remove sub-projects.
+-   Coordinate any marketing, events, or communications regarding the project.
 
 To become a TSC member, a committer must be sponsored by a TSC member and the sponsorship must be approved by 2/3 of all TSC members.
 
@@ -29,11 +29,11 @@ Committers lead project feature discussions and oversee the overall project qual
 
 Committers have the following responsibilities:
 
-- Lead feature design discussions and implementation.
-- Ensure the overall project quality and approve PRs.
-- Participate in product release, feature planning, and roadmap design.
-- Have a constructive and friendly attitude in all community interactions.
-- Mentor reviewers and contributors.
+-   Lead feature design discussions and implementation.
+-   Ensure the overall project quality and approve PRs.
+-   Participate in product release, feature planning, and roadmap design.
+-   Have a constructive and friendly attitude in all community interactions.
+-   Mentor reviewers and contributors.
 
 To become a committer, a reviewer must have contributed broadly throughout the Milvus project. A reviewer must also be sponsored by a committer and the sponsorship must be approved by the TSC.
 
@@ -43,10 +43,10 @@ Reviewers review new code contributions and ensure the quality of existing code.
 
 Reviewers have the following responsibilities:
 
-- Participate in feature design discussion and implementation.
-- Ensure the quality of owned code modules.
-- Ensure the technical accuracy of documentation.
-- Quickly respond to issues and PRs and conduct code reviews.
+-   Participate in feature design discussion and implementation.
+-   Ensure the quality of owned code modules.
+-   Ensure the technical accuracy of documentation.
+-   Quickly respond to issues and PRs and conduct code reviews.
 
 To become a reviewer, a contributor must have provided continued and quality contribution to the Milvus project for at least 6 months and have contributed at least one major component where the contributor has taken an ownership role.
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -10,17 +10,17 @@ As for everything else in the project, the contributions to Milvus are governed
 
 Before you make any contributions, make sure you follow this list.
 
-- Read [Contributing to Milvus](CONTRIBUTING.md).
-- Check if the changes are consistent with the [coding style](CONTRIBUTING.md#coding-style), and format your code accordingly.
-- Run [unit tests](CONTRIBUTING.md#run-unit-test-with-code-coverage) and check your code coverage rate.
+-   Read [Contributing to Milvus](CONTRIBUTING.md).
+-   Check if the changes are consistent with the [coding style](CONTRIBUTING.md#coding-style), and format your code accordingly.
+-   Run [unit tests](CONTRIBUTING.md#run-unit-test-with-code-coverage) and check your code coverage rate.
 
 ## What contributions can I make?
 
 Contributions to Milvus fall into the following categories.
 
-1. To report a bug or a problem with documentation, please file an [issue](https://github.com/milvus-io/milvus/issues/new/choose) providing the details of the problem. If you believe the issue needs priority attention, please comment on the issue to notify the team.
-2. To propose a new feature, please file a new feature request [issue](https://github.com/milvus-io/milvus/issues/new/choose). Describe the intended feature and discuss the design and implementation with the team and community. Once the team agrees that the plan looks good, go ahead and implement it, following the [Contributing code](CONTRIBUTING.md#contributing-code).
-3. To implement a feature or bug-fix for an existing outstanding issue, follow the [Contributing code](CONTRIBUTING.md#contributing-code). If you need more context on a particular issue, comment on the issue to let people know.
+1.  To report a bug or a problem with documentation, please file an [issue](https://github.com/milvus-io/milvus/issues/new/choose) providing the details of the problem. If you believe the issue needs priority attention, please comment on the issue to notify the team.
+2.  To propose a new feature, please file a new feature request [issue](https://github.com/milvus-io/milvus/issues/new/choose). Describe the intended feature and discuss the design and implementation with the team and community. Once the team agrees that the plan looks good, go ahead and implement it, following the [Contributing code](CONTRIBUTING.md#contributing-code).
+3.  To implement a feature or bug-fix for an existing outstanding issue, follow the [Contributing code](CONTRIBUTING.md#contributing-code). If you need more context on a particular issue, comment on the issue to let people know.
 
 ## How can I contribute?
 
@@ -34,11 +34,11 @@ The Milvus team members will review your pull requests, and once it is accepted,
 
 Please create a new branch from an up-to-date master on your fork.
 
-1. Fork the repository on GitHub.
-2. Clone your fork to your local machine with `git clone [email protected]:<yourname>/milvus-io/milvus.git`.
-3. Create a branch with `git checkout -b my-topic-branch`.
-4. Make your changes, commit, then push to to GitHub with `git push --set-upstream origin my-topic-branch`. You must record your changes in [CHANGELOG.md](CHANGELOG.md) with issue numbers and descriptions.
-5. Visit GitHub and make your pull request.
+1.  Fork the repository on GitHub.
+2.  Clone your fork to your local machine with `git clone [email protected]:<yourname>/milvus-io/milvus.git`.
+3.  Create a branch with `git checkout -b my-topic-branch`.
+4.  Make your changes, commit, then push to to GitHub with `git push --set-upstream origin my-topic-branch`. You must record your changes in [CHANGELOG.md](CHANGELOG.md) with issue numbers and descriptions.
+5.  Visit GitHub and make your pull request.
 
 If you have an existing local repository, please update it before you start, to minimize the chance of merge conflicts.
 
@@ -53,10 +53,10 @@ git checkout -b my-topic-branch
 
 Before sending your pull requests for review, make sure your changes are consistent with the guidelines and follow the Milvus coding style.
 
-- Include unit tests when you contribute new features, as they help to prove that your code works correctly, and also guard against future breaking changes to lower the maintenance cost.
-- Bug fixes also require unit tests, because the presence of bugs usually indicates insufficient test coverage.
-- Keep API compatibility in mind when you change code in Milvus. Reviewers of your pull request will comment on any API compatibility issues.
-- When you contribute a new feature to Milvus, the maintenance burden is (by default) transferred to the Milvus team. This means that the benefit of the contribution must be compared against the cost of maintaining the feature.
+-   Include unit tests when you contribute new features, as they help to prove that your code works correctly, and also guard against future breaking changes to lower the maintenance cost.
+-   Bug fixes also require unit tests, because the presence of bugs usually indicates insufficient test coverage.
+-   Keep API compatibility in mind when you change code in Milvus. Reviewers of your pull request will comment on any API compatibility issues.
+-   When you contribute a new feature to Milvus, the maintenance burden is (by default) transferred to the Milvus team. This means that the benefit of the contribution must be compared against the cost of maintaining the feature.
 
 ### Developer Certificate of Origin (DCO)
 
@@ -80,10 +80,10 @@ $ git commit -s -m 'This is my commit message'
 The coding style used in Milvus generally follow [Google C++ Style Guide](https://google.github.io/styleguide/cppguide.html).
 And we made the following changes based on the guide:
 
-- 4 spaces for indentation
-- Adopt .cpp file extension instead of .cc extension
-- 120-character line length
-- Camel-Cased file names
+-   4 spaces for indentation
+-   Adopt .cpp file extension instead of .cc extension
+-   120-character line length
+-   Camel-Cased file names
 
 ### Format code
 

diff --git a/INSTALL.md b/INSTALL.md
@@ -2,19 +2,32 @@
 
 <!-- TOC -->
 
-- [Build from source](#build-from-source)
+-   [Build from source](#build-from-source)
+
   - [Requirements](#requirements)
+
   - [Compilation](#compilation)
+
   - [Launch Milvus server](#launch-milvus-server)
-- [Compile Milvus on Docker](#compile-milvus-on-docker)
+
+-   [Compile Milvus on Docker](#compile-milvus-on-docker)
+
   - [Step 1 Pull Milvus Docker images](#step-1-pull-milvus-docker-images)
+
   - [Step 2 Start the Docker container](#step-2-start-the-docker-container)
+
   - [Step 3 Download Milvus source code](#step-3-download-milvus-source-code)
+
   - [Step 4 Compile Milvus in the container](#step-4-compile-milvus-in-the-container)
-- [Troubleshooting](#troubleshooting)
+
+-   [Troubleshooting](#troubleshooting)
+
   - [Error message: `protocol https not supported or disabled in libcurl`](#error-message-protocol-https-not-supported-or-disabled-in-libcurl)
+
   - [Error message: `internal compiler error`](#error-message-internal-compiler-error)
+
   - [Error message: `error while loading shared libraries: libmysqlpp.so.3`](#error-message-error-while-loading-shared-libraries-libmysqlppso3)
+
   - [CMake version is not supported](#cmake-version-is-not-supported)
 
 <!-- /TOC -->
@@ -23,20 +36,25 @@
 
 ### Requirements
 
-- Operating system
+-   Operating system
+
   - Ubuntu 18.04 or higher
+
   - CentOS 7
 
   > Note: If your Linux operating system does not meet the requirements, we recommend that you pull a Docker image of [Ubuntu 18.04](https://docs.docker.com/install/linux/docker-ce/ubuntu/) or [CentOS 7](https://docs.docker.com/install/linux/docker-ce/centos/) as your compilation environment.
   
-- GCC 7.0 or higher to support C++ 17
-- CMake 3.12 or higher
-- Git
+-   GCC 7.0 or higher to support C++ 17
+
+-   CMake 3.12 or higher
+
+-   Git
 
 For GPU-enabled version, you will also need:
 
-- CUDA 10.0 or higher
-- NVIDIA driver 418 or higher
+-   CUDA 10.0 or higher
+
+-   NVIDIA driver 418 or higher
 
 ### Compilation
 
@@ -185,8 +203,8 @@ $ ./start_server.sh
 
 Follow the steps below to solve this problem:
 
-1. Make sure you have `libcurl4-openssl-dev` installed in your system.
-2. Try reinstalling the latest CMake from source with `--system-curl` option:
+1.  Make sure you have `libcurl4-openssl-dev` installed in your system.
+2.  Try reinstalling the latest CMake from source with `--system-curl` option:
 
    ```shell
    $ ./bootstrap --system-curl
@@ -210,21 +228,21 @@ Note: You might also need to configure CMake build for faiss in `[Milvus root pa
 
 Follow the steps below to solve this problem:
 
-1. Check whether `libmysqlpp.so.3` is correctly installed.
-2. If `libmysqlpp.so.3` is installed, check whether it is added to `LD_LIBRARY_PATH`.
+1.  Check whether `libmysqlpp.so.3` is correctly installed.
+2.  If `libmysqlpp.so.3` is installed, check whether it is added to `LD_LIBRARY_PATH`.
 
 ### CMake version is not supported
 
 Follow the steps below to install a supported version of CMake:
 
-1. Remove the unsupported version of CMake.
-2. Get CMake 3.12 or higher. Here we get CMake 3.12.
+1.  Remove the unsupported version of CMake.
+2.  Get CMake 3.12 or higher. Here we get CMake 3.12.
 
     ```shell
     $ wget https://cmake.org/files/v3.12/cmake-3.12.2-Linux-x86_64.tar.gz
     ```
 
-3. Extract the file and install CMake.
+3.  Extract the file and install CMake.
 
     ```shell
     $ tar zxvf cmake-3.12.2-Linux-x86_64.tar.gz

diff --git a/README.md b/README.md
@@ -53,12 +53,12 @@ See our [test reports](https://github.com/milvus-io/milvus/tree/master/docs) for
 
 ## Supported clients
 
-- [Go](https://github.com/milvus-io/milvus-sdk-go)
-- [Python](https://github.com/milvus-io/pymilvus)
-- [Java](https://github.com/milvus-io/milvus-sdk-java)
-- [C++](https://github.com/milvus-io/milvus/tree/master/sdk)
-- [RESTful API](https://github.com/milvus-io/milvus/tree/master/core/src/server/web_impl)
-- [Node.js](https://www.npmjs.com/package/@arkie-ai/milvus-client) (Provided by [arkie](https://www.arkie.cn/))
+-   [Go](https://github.com/milvus-io/milvus-sdk-go)
+-   [Python](https://github.com/milvus-io/pymilvus)
+-   [Java](https://github.com/milvus-io/milvus-sdk-java)
+-   [C++](https://github.com/milvus-io/milvus/tree/master/sdk)
+-   [RESTful API](https://github.com/milvus-io/milvus/tree/master/core/src/server/web_impl)
+-   [Node.js](https://www.npmjs.com/package/@arkie-ai/milvus-client) (Provided by [arkie](https://www.arkie.cn/))
 
 ## Get started
 
@@ -85,9 +85,9 @@ See our [community](https://github.com/milvus-io/community) repository to learn
 
 ## Mailing lists
 
-- [Milvus TSC](https://lists.lfai.foundation/g/milvus-tsc)
-- [Milvus Technical Discuss](https://lists.lfai.foundation/g/milvus-technical-discuss)
-- [Milvus Announce](https://lists.lfai.foundation/g/milvus-announce)
+-   [Milvus TSC](https://lists.lfai.foundation/g/milvus-tsc)
+-   [Milvus Technical Discuss](https://lists.lfai.foundation/g/milvus-technical-discuss)
+-   [Milvus Announce](https://lists.lfai.foundation/g/milvus-announce)
 
 ## Contributors
 
@@ -114,19 +114,19 @@ Below is a list of Milvus contributors. We greatly appreciate your contributions
 
 ## Resources
 
-- [Milvus.io](https://www.milvus.io)
+-   [Milvus.io](https://www.milvus.io)
 
-- [Milvus FAQ](https://www.milvus.io/docs/faq/operational_faq.md)
+-   [Milvus FAQ](https://www.milvus.io/docs/faq/operational_faq.md)
 
-- [Milvus Medium](https://medium.com/@milvusio)
+-   [Milvus Medium](https://medium.com/@milvusio)
 
-- [Milvus CSDN](https://zilliz.blog.csdn.net/)
+-   [Milvus CSDN](https://zilliz.blog.csdn.net/)
 
-- [Milvus Twitter](https://twitter.com/milvusio)
+-   [Milvus Twitter](https://twitter.com/milvusio)
 
-- [Milvus Facebook](https://www.facebook.com/io.milvus.5)
+-   [Milvus Facebook](https://www.facebook.com/io.milvus.5)
 
-- [Milvus design docs](DESIGN.md)
+-   [Milvus design docs](DESIGN.md)
 
 ## License
 

diff --git a/README_CN.md b/README_CN.md
@@ -53,12 +53,12 @@ Milvus 可以广泛应用于各类场景。下图展示了基于 Milvus 和 VGG
 
 ## 支持的客户端
 
-- [Go](https://github.com/milvus-io/milvus-sdk-go)
-- [Python](https://github.com/milvus-io/pymilvus)
-- [Java](https://github.com/milvus-io/milvus-sdk-java)
-- [C++](https://github.com/milvus-io/milvus/tree/master/sdk)
-- [RESTful API](https://github.com/milvus-io/milvus/tree/master/core/src/server/web_impl)
-- [Node.js](https://www.npmjs.com/package/@arkie-ai/milvus-client) (由 [arkie](https://www.arkie.cn/) 提供)
+-   [Go](https://github.com/milvus-io/milvus-sdk-go)
+-   [Python](https://github.com/milvus-io/pymilvus)
+-   [Java](https://github.com/milvus-io/milvus-sdk-java)
+-   [C++](https://github.com/milvus-io/milvus/tree/master/sdk)
+-   [RESTful API](https://github.com/milvus-io/milvus/tree/master/core/src/server/web_impl)
+-   [Node.js](https://www.npmjs.com/package/@arkie-ai/milvus-client) (由 [arkie](https://www.arkie.cn/) 提供)
 
 ## 开始使用 Milvus
 
@@ -84,23 +84,23 @@ Milvus 可以广泛应用于各类场景。下图展示了基于 Milvus 和 VGG
 
 ## 相关链接
 
-- [Milvus.io](https://www.milvus.io)
+-   [Milvus.io](https://www.milvus.io)
 
-- [Milvus 在线训练营](https://github.com/milvus-io/bootcamp)
+-   [Milvus 在线训练营](https://github.com/milvus-io/bootcamp)
 
-- [Milvus 测试报告](https://github.com/milvus-io/milvus/tree/master/docs)
+-   [Milvus 测试报告](https://github.com/milvus-io/milvus/tree/master/docs)
 
-- [Milvus 常见问题](https://www.milvus.io/cn/docs/faq/operational_faq.md)
+-   [Milvus 常见问题](https://www.milvus.io/cn/docs/faq/operational_faq.md)
 
-- [Milvus Medium](https://medium.com/@milvusio)
+-   [Milvus Medium](https://medium.com/@milvusio)
 
-- [Milvus CSDN](https://zilliz.blog.csdn.net/)
+-   [Milvus CSDN](https://zilliz.blog.csdn.net/)
 
-- [Milvus Twitter](https://twitter.com/milvusio)
+-   [Milvus Twitter](https://twitter.com/milvusio)
 
-- [Milvus Facebook](https://www.facebook.com/io.milvus.5)
+-   [Milvus Facebook](https://www.facebook.com/io.milvus.5)
 
-- [Milvus 设计文档](design.md)
+-   [Milvus 设计文档](design.md)
 
 ## 许可协议