forked from milvus-io/milvus-docs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
8 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -2,9 +2,7 @@ | |
|
|
||
| Welcome to Milvus documentation! | ||
|
|
||
| This repository contains technical documentation for [Milvus](https://github.com/milvus-io/milvus), the world's most advanced open-source vector database. | ||
|
|
||
| Please note that this repository is for Milvus technical documentation update and maintenance. Visit [Milvus.io](milvus.io) or [Web content repo](https://github.com/milvus-io/web-content) for fully rendered documents. | ||
| This repository contains technical documentation for [Milvus](https://github.com/milvus-io/milvus), the world's most advanced open-source vector database. Visit [Milvus.io](milvus.io) or [Web content repo](https://github.com/milvus-io/web-content) for fully rendered documents. | ||
|
|
||
| Each branch corresponds to a Milvus release by name. We've set the branch of the latest Milvus release as the default branch. For documentation of a different Milvus release, switch to the corresponding branch. | ||
|
|
||
|
|
@@ -24,15 +22,15 @@ Each branch corresponds to a Milvus release by name. We've set the branch of the | |
|
|
||
| ## Suggest changes | ||
|
|
||
| Think of a new topic to be included in the docs? Need additional instructions or clarifications? Spot a broken link? Please [open an issue](https://github.com/milvus-io/milvus-docs/issues/new/choose). | ||
| Have a new topic that you want to include in the docs? Need additional instructions or clarifications? Spot a broken link? Please [open an issue](https://github.com/milvus-io/milvus-docs/issues/new/choose). | ||
|
|
||
| ## Contribute to Milvus docs | ||
|
|
||
| Want to write the docs yourself? See [CONTRIBUTING](CONTRIBUTING.md) for details about setting yourself up and getting started. | ||
| Want to be a contributor to the docs? See [CONTRIBUTING](CONTRIBUTING.md) for details about setting yourself up and getting started. | ||
|
|
||
| ## Active Milvus releases | ||
|
|
||
| Currently, we maintain the following versions of Milvus documentation in different branches: | ||
| Currently, we are maintaining the following versions of Milvus documentation in different branches: | ||
|
|
||
| | `v2.0.x` branch | 2.0 version (the default and latest branch) | | ||
| | --------------- | --------------------------------------------- | | ||
|
|
@@ -50,17 +48,16 @@ Not all content rendered on [milvus.io](https://milvus.io/docs) is hosted in thi | |
|
|
||
| ### Contribute to API docs | ||
|
|
||
| To make contributions to the Milvus SDK reference documentation, visit the programming language specific repositories listed below: | ||
| To contribute to the Milvus SDK documentation, visit the language-specific repositories listed below: | ||
|
|
||
| - [PyMilvus](https://github.com/milvus-io/pymilvus) | ||
| - [GO](https://github.com/milvus-io/milvus-sdk-go) | ||
| - [Java](https://github.com/milvus-io/milvus-sdk-java) | ||
| - [Node.js](https://github.com/milvus-io/milvus-sdk-node) | ||
|
|
||
|
|
||
| ### Contribute to community content | ||
|
|
||
| If you would like to write an article for our [blog](https://medium.com/unstructured-data-service), please [file an issue](https://github.com/milvus-io/community/issues/new) in the [Milvus community repository](https://github.com/milvus-io/community) or send it to [email protected]. Feel free to submit either a completed draft or article ideas. All submissions will be reviewed as quickly as possible. If your article or idea seems like a good fit for the blog, we will reach out to you directly. | ||
| If you would like to write an article for our [blog](https://medium.com/unstructured-data-service), please [file an issue](https://github.com/milvus-io/community/issues/new) in the [Milvus community repository](https://github.com/milvus-io/community) or contact [email protected]. Feel free to submit either a completed draft or article ideas. All submissions will be reviewed as quickly as possible. If your article or idea seems like a good fit for our blog, we will reach out to you directly. | ||
|
|
||
| > In your title/subject line, please put in [blog submission] to make sure your email does not get buried. | ||
|
|
@@ -88,13 +85,13 @@ Reference to cite when you use Milvus in a research paper: | |
|
|
||
| ## Get in touch | ||
|
|
||
| Join the Milvus community on [Slack](https://join.slack.com/t/milvusio/shared_invite/zt-e0u4qu3k-bI2GDNys3ZqX1YCJ9OM~GQ) to share your suggestions, advice, and questions with our engineering team. | ||
| Join the Milvus community on [Slack](https://join.slack.com/t/milvusio/shared_invite/zt-e0u4qu3k-bI2GDNys3ZqX1YCJ9OM~GQ) to share your suggestions, advice, or questions with our engineering team. | ||
|
|
||
| <a href="https://join.slack.com/t/milvusio/shared_invite/zt-e0u4qu3k-bI2GDNys3ZqX1YCJ9OM~GQ"> | ||
| <img src="https://zilliz-cms.s3.us-west-2.amazonaws.com/readme_slack_4a07c4c92f.png" alt="Miluvs Slack Channel" height="150" width="500"> | ||
| </a> | ||
|
|
||
| Subscribe to Milvus mailing lists: | ||
| Subscribe to Milvus's mailing lists: | ||
|
|
||
| - [Technical Steering Committee](https://lists.lfai.foundation/g/milvus-tsc) | ||
|
|
||
|
|
||