## 1. Project Overview & Quickstart (milvus-io/monitor) ## 1. Project Overview & Quickstart (milvus-io/monitor) # monitor Open-source repository milvus-io/monitor ### Repository Details - **Repository:** [milvus-io/monitor](https://github.com/milvus-io/monitor) - **Primary Language:** Code *Note: High-volume repository documentation is actively indexed and synchronized by YakaAI.* ## 2. Official Technical Reference & Guides (milvus-io/docs) # Milvus Website This repository contains technical documentation, blog articles, bootcamp resources and community pages in [milvus.io](https://www.milvus.io/). [Milvus](https://github.com/milvus-io/milvus) is an open-source vector database powering AI applications. Please note that, despite all documentation rendered on the website is stored in this repository, some projects have their own separate repositories to maintain their project-specific documentation. ### Contributions are welcome from everyone Please refer to our [guidelines for contributing](CONTRIBUTING.md) for more instructions. Generally, we follow the "[fork](https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github/fork-a-repo)-and-[pull](https://docs.github.com/en/free-pro-team@latest/github/collaborating-with-issues-and-pull-requests/about-pull-requests)" Git workflow. Remember to [sync your forked repository](https://docs.github.com/en/free-pro-team@latest/github/getting-started-with-github/fork-a-repo#keep-your-fork-synced) *before* submitting proposed changes upstream. ### Issues Flag issues and request improvements using the links below: - [Make change requests, report errors, or submit questions about this repository (technical documentation excluded).](https://github.com/milvus-io/web-content/issues/new/choose) - [File technical documentation issues or request new technical documentation for Milvus.](https://github.com/milvus-io/milvus-docs/issues/new/choose) ### Writing style Technical documentation for Milvus is written in [Markdown](https://commonmark.org/help/). In general, we adhere to the [Google Developer Documentation Style Guide](https://developers.google.com/style/). ### License [Milvus-io/web-content](https://github.com/milvus-io/web-content) is licensed under the Apache License, Version 2.0. View a copy of the license in this repository's [LICENSE file](LICENSE). ## 2. Official Technical Reference & Guides (milvus-io/milvus-docs) ## File: README.md # 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 [Discord](https://discord.com/invite/8uyFbECzPX) 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) --- ## File: site/zh-CN/getstarted/README.md # Milvus 用户手册 - 快速入门 - 安装 Milvus - [安装概述](get_started/install_milvus/install_milvus.md) - [安装 CPU 版 Milvus](get_started/install_milvus/cpu_milvus_docker.md) - [安装 GPU 版 Milvus](get_started/install_milvus/gpu_milvus_docker.md) - [运行示例程序](get_started/example_code.md) - [了解 Milvus 操作](milvus_operation.md) - [选择距离计算方式](metric.md) - [索引类型](index.md) - [监控与报警](monitor.md) - [故障诊断](troubleshoot.md) --- ## File: site/zh-CN/about/README.md # 向量数据库简介 - [Milvus Overview](overview.md) - [Feature Vector](vector.md) - [Traditional Database](traditional_db.md) - [Vector Indexing Methods](index_method.md) - [Feature Vector Database](vector_db.md) --- ## File: site/en/getstarted/README.md # Milvus User Guide - Get Started - Install Milvus - [Installation Overview](get_started/install_milvus/install_milvus.md) - [Install CPU-only Milvus](get_started/install_milvus/cpu_milvus_docker.md) - [Install GPU-enabled Milvus](get_started/install_milvus/gpu_milvus_docker.md) - [Try an Example Program](get_started/example_code.md) - [Learn Milvus Operations](milvus_operation.md) - [Selecting Metrics](metric.md) - [Milvus indexes](index.md) - [Monitoring and Alerting](monitor.md) - [Troubleshoot](troubleshoot.md) --- ## File: site/en/about/README.md # About Milvus - [Milvus Overview](overview.md) - [Feature Vector](vector.md) - [Traditional Database](traditional_db.md) - [Vector Search Methods](index_method.md) - [Other Feature Vector Search Tools](vector_db.md)