Contributions to the technical documentation of Milvus are welcome from everyone. We strive to make the contribution process simple and straightforward. Up-to-date technical documentation can be found at milvus.io.
Generally, we follow the "fork-and-pull" Git workflow.
- Fork the repo on Github
- Commit changes to your own branch
- Submit a pull request so that we can review your changes
Remember to sync your forked repository before submitting proposed changes upstream. Quickly fork repositories and start making contributions directly from milvus.io using the Edit button located in the top right corner of most pages.
Flag issues and request improvements using the links below:
- Make change requests, report errors, or submit questions about this repository.
- File a technical documentation issue or request new technical documentation for Milvus.
Technical documentation for Milvus is written in Markdown. In general, we adhere to the Google Developer Documentation Style Guide.
Articles published on the Milvus blog Unstructured Data Service are generated from source materials located in this folder.
If you would like to write an article for the blog, please open an issue in the Milvus community repository. Feel free to submit article ideas or completed drafts. All submissions will be reviewed as quickly as possible. If an article or idea seems like a good fit for the blog we will reach out to you directly.
To make contributions to the Milvus SDK reference documentation, visit the programming language specific repositories listed below:
Next, follow the Python SDK or Java SDK guidelines for contributing.
The SDK reference documentation for Milvus is generated from the source code located in the pymilvus and milvus-sdk-java repositories.
Not all documentation on milvus.io exists in this repository. Some projects have their own separate repositories and project-specific documentation.