https://github.com/milvus-io/milvus-docs
This repository is for Milvus technical documentation update and maintenance. Visit Milvus.io for fully rendered technical documents.
https://github.com/milvus-io/milvus-docs
documentation milvus
Last synced: 3 months ago
JSON representation
This repository is for Milvus technical documentation update and maintenance. Visit Milvus.io for fully rendered technical documents.
- Host: GitHub
- URL: https://github.com/milvus-io/milvus-docs
- Owner: milvus-io
- License: apache-2.0
- Created: 2020-05-27T09:12:23.000Z (over 5 years ago)
- Default Branch: v2.6.x
- Last Pushed: 2025-07-01T07:35:50.000Z (3 months ago)
- Last Synced: 2025-07-01T08:35:57.558Z (3 months ago)
- Topics: documentation, milvus
- Language: JavaScript
- Homepage:
- Size: 154 MB
- Stars: 85
- Watchers: 8
- Forks: 337
- Open Issues: 172
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Milvus Documentation
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. Visit [Milvus.io](https://milvus.io/docs) 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.
## Index
- [Suggest changes](#suggest-changes)
- [Contribute to Milvus docs](#contribute-to-milvus-docs)
- [Active Milvus releases](#active-milvus-releases)
- [Other contributing channels](#other-contributing-channels)
- [Reference](#reference)
- [Get in touch](#get-in-touch)
## Suggest changes
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 be a contributor to the docs? See [CONTRIBUTING](CONTRIBUTING.md) for details about setting yourself up and getting started.
## Active Milvus releases
Currently, we are maintaining the following versions of Milvus documentation in different branches:
| `v2.1.x` branch | 2.1.x version (the default and latest branch) |
| --------------- | --------------------------------------------- |
| `v2.0.x` branch | 2.0.x version |
| `v1.1.1` branch | 1.1.1 version |
| `v1.1.0` branch | 1.1.0 version |
| `v1.0.0` branch | 1.0.0 version (first with long-term support) |
> **Note:**
> The latest branch is set as the default working branch.
> Milvus releases prior to v1.0.0 are no longer supported, but you can still find their documentation in the corresponding branch.
## Other contributing channels
Not all content rendered on [milvus.io](https://milvus.io/docs) is hosted in this repository.
### Contribute to API docs
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 contact community@zilliz.com. 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.
## Reference
Reference to cite when you use Milvus in a research paper:
```
@inproceedings{2021milvus,
title={Milvus: A Purpose-Built Vector Data Management System},
author={Wang, Jianguo and Yi, Xiaomeng and Guo, Rentong and Jin, Hai and Xu, Peng and Li, Shengjun and Wang, Xiangyu and Guo, Xiangzhou and Li, Chengming and Xu, Xiaohai and others},
booktitle={Proceedings of the 2021 International Conference on Management of Data},
pages={2614--2627},
year={2021}
}
```
## 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, or questions with our engineering team.
Subscribe to Milvus's mailing lists:
- [Technical Steering Committee](https://lists.lfai.foundation/g/milvus-tsc)
- [Technical Discussions](https://lists.lfai.foundation/g/milvus-technical-discuss)
- [Announcement](https://lists.lfai.foundation/g/milvus-announce)
Follow Milvus on social media:
- [Medium](https://medium.com/@milvusio)
- [Twitter](https://twitter.com/milvusio)
- [LinkedIn](https://www.linkedin.com/company/the-milvus-project)