dd6a411e5e
doc: add design docs directory ( #49829 )
...
issue: #49831
## What changed
Vendor Milvus design documents into this repository under
`docs/design-docs` as regular tracked files.
- Keep only the design document content and assets under
`docs/design-docs/design_docs/` and `docs/design-docs/assets/`.
- Remove standalone repository metadata from the vendored directory,
such as `README.md`, `CONTRIBUTING.md`, `MEP-TEMPLATE.md`, `COMMITTERS`,
`MAINTAINERS`, `OWNERS`, `OWNERS_ALIASES`, and `.gitignore`.
- Document the Milvus design document process in the main
`CONTRIBUTING.md`.
- Update Mergify and `tools/mgit.py` so feature PRs must provide an
in-repo design document path under `docs/design-docs/design_docs/`.
## Why
Milvus feature work should have an associated design document. Keeping
design docs directly in this repository makes them available from a
normal Milvus checkout and lets feature implementations include or link
the related design document in the same repository.
## Verification
- `git diff --check`
- `python3 -m unittest tools/test_mgit_design_doc.py`
- `python3 -m py_compile tools/mgit.py tools/test_mgit_design_doc.py`
- Parsed `.github/mergify.yml` with Python `yaml.safe_load`
- Confirmed `docs/design-docs` only contains `assets/` and
`design_docs/` at the top level
---------
Signed-off-by: xiaofanluan <xiaofan.luan@zilliz.com >
Co-authored-by: Claude Opus 4.7 <noreply@anthropic.com >
2026-05-15 18:56:24 +08:00
Anurag Ojha and GitHub
3d17ddb71b
doc: remove outdated archive links from table ( #46062 )
...
This PR removes several archived project links from the CONTRIBUTING.md
table.
These links point to inactive repositories and no longer provide value
to contributors.
The update improves clarity and keeps the documentation current.
Signed-off-by: intojhanurag <aojharaj2004@gmail.com >
2025-12-05 10:01:11 +08:00
Jiang Chen and GitHub
0b75ea56a4
doc: clarify the "fork and pull" process in contributing guide ( #41474 )
...
Signed-off-by: codingjaguar <jiang.chen@zilliz.com >
2025-04-25 16:23:52 +08:00
congqixia and GitHub
901e98a868
Update CONTRIBUTING.md for mockery generation ( #26842 )
...
Signed-off-by: Congqi Xia <congqi.xia@zilliz.com >
2023-09-05 14:11:54 +08:00
77d06bd071
[skip ci]Fix a minor mistake ( #16966 )
...
Signed-off-by: wayblink <anyang.wang@zilliz.com >
Co-authored-by: wayblink <anyang.wang@zilliz.com >
2022-05-13 12:37:53 +08:00
XuanYang-cn and GitHub
fd405bc2d6
Add project knowhere in CONTRIBUTING.md ( #16036 )
...
Signed-off-by: yangxuan <xuan.yang@zilliz.com >
2022-03-15 10:20:01 +08:00
yanliang567 and GitHub
f156e63637
[skip e2e]Fix a grammar issue ( #14686 )
...
Signed-off-by: yanliang567 <yanliang.qiao@zilliz.com >
2022-01-04 19:33:31 +08:00
yanliang567 and GitHub
1e404d717a
[skip e2e]Update a few words in contributing md ( #13582 )
...
Signed-off-by: yanliang567 <yanliang.qiao@zilliz.com >
2021-12-17 18:52:43 +08:00
shiyu22 and GitHub
6c145ca41b
Update docs of CONTRIBUTING ( #11300 )
...
Signed-off-by: shiyu22 <shiyu.chen@zilliz.com >
2021-11-05 13:29:27 +08:00
shiyu22 and GitHub
8ae7f3adbc
[skip ci]Update contributing.md ( #10542 )
...
Signed-off-by: shiyu22 <shiyu.chen@zilliz.com >
2021-10-25 20:03:38 +08:00
ryjiang and GitHub
c457be6a51
[skip ci]Format markdown doc for CONTRIBUTING.md ( #10044 )
...
Signed-off-by: ruiyi.jiang <ruiyi.jiang@zilliz.com >
2021-10-17 16:42:35 +08:00
XuanYang-cn and GitHub
05bda0752f
[skip ci]Make title clearer in contributing ( #9430 )
...
Signed-off-by: Yang Xuan <xuan.yang@zilliz.com >
2021-10-07 23:52:43 +08:00
edward.zeng and GitHub
56c4cae470
[skip ci] Refine contributing guide ( #9330 )
...
Signed-off-by: Edward Zeng <jie.zeng@zilliz.com >
2021-10-06 17:16:16 +08:00
XuanYang-cn and GitHub
bb0b293244
[skip ci]Remove optional in contributing.md ( #9292 )
...
Signed-off-by: Yang Xuan <xuan.yang@zilliz.com >
2021-10-05 22:31:00 +08:00
groot and GitHub
42b3dc7ba1
[skip ci] Fix CONTRIBUTING.md ( #9136 )
...
Signed-off-by: yhmo <yihua.mo@zilliz.com >
2021-10-03 19:39:56 +08:00
edward.zeng and GitHub
66fa309d5a
[skip ci] Refine contributing doc ( #9073 )
...
Signed-off-by: Edward Zeng <jie.zeng@zilliz.com >
2021-10-02 16:51:56 +08:00
XuanYang-cn and GitHub
436b5d4d41
[skip ci]Change I to you in docs ( #8972 )
...
Signed-off-by: Yang Xuan <xuan.yang@zilliz.com >
2021-10-01 06:47:30 +08:00
ryjiang and GitHub
5c239cf15a
[skip ci]update doc link in Contributor.md ( #8902 )
...
Signed-off-by: ruiyi.jiang <ruiyi.jiang@zilliz.com >
2021-09-30 10:58:03 +08:00
XuanYang-cn and GitHub
fc2dab174b
[skip-ci]Update contributing.md ( #8893 )
...
Signed-off-by: yangxuan <xuan.yang@zilliz.com >
2021-09-29 23:22:18 +08:00
XuanYang-cn and GitHub
6bbae85674
[skip-ci]Fix typo ( #8334 )
...
Signed-off-by: yangxuan <xuan.yang@zilliz.com >
2021-09-22 19:52:00 +08:00
XuanYang-cn and GitHub
6c1c0d826b
[skip-ci]Update CONTRIBUTING.md ( #8315 )
...
Remove not in use MySQL
Signed-off-by: XuanYang-cn <xuan.yang@zilliz.com >
2021-09-22 19:46:01 +08:00
congqixia and GitHub
aa951e4acd
Add static-check description in CONTRIBUTING.md ( #8209 )
...
Signed-off-by: Congqi Xia <congqi.xia@zilliz.com >
2021-09-18 16:03:51 +08:00
Xiangyu Wang and GitHub
90c6df42f8
Replace GO with Go in document ( #8013 )
...
Signed-off-by: Xiangyu Wang <xiangyu.wang@zilliz.com >
2021-09-15 23:09:52 +08:00
ryjiang and GitHub
5a85c7545b
[skip ci]Update CONTRIBUTING.md, add milvus-insight ( #7961 )
...
Signed-off-by: ruiyi.jiang <ruiyi.jiang@zilliz.com >
2021-09-15 15:21:48 +08:00
XuanYang-cn and GitHub
32735ed207
[skip-ci]Update contributing code ( #7921 )
...
Signed-off-by: yangxuan <xuan.yang@zilliz.com >
2021-09-14 19:37:48 +08:00
XuanYang-cn and GitHub
ee85067f20
[skip-ci]Fix github workflow code ( #7923 )
...
Signed-off-by: yangxuan <xuan.yang@zilliz.com >
2021-09-14 19:31:48 +08:00
zwd1208 and GitHub
098886ddca
[skip ci]Fix CONTRIBUTING.md title format ( #7918 )
...
Signed-off-by: Weida Zhu <weida.zhu@zilliz.com >
2021-09-14 18:55:47 +08:00
zwd1208 and GitHub
8cf70e4b48
[skip ci]Fix CONTRIBUTING.md format ( #7917 )
...
Signed-off-by: Weida Zhu <weida.zhu@zilliz.com >
2021-09-14 18:47:48 +08:00
edward.zeng and GitHub
1e935d33ed
Merge pull request #7836 from XuanYang-cn/update-development
...
Add table of milvus community projects in contributing.md
2021-09-14 10:52:26 +08:00
XuanYang-cn and GitHub
995fc8fa74
[skip-ci]Add pictures for milvus github workflow ( #7842 )
...
Signed-off-by: Yang Xuan <xuan.yang@zilliz.com >
2021-09-13 21:32:58 +08:00
Xiaofan and GitHub
64918f80b2
[skip ci] change CONTRIBUTING.mad to add go code style ( #7817 )
...
Signed-off-by: xiaofan-luan <xiaofan.luan@zilliz.com >
2021-09-13 20:58:57 +08:00
Yang Xuan
2b4f71a6d8
[skip-ci]Add table of milvus community projects
...
Signed-off-by: Yang Xuan <xuan.yang@zilliz.com >
2021-09-13 20:50:54 +08:00
zhenshan.cao and yefu.chen
0d4daa22e0
Update README
2021-04-21 14:04:22 +08:00
yefu.chen
49058d5dfb
start 2.0
...
Signed-off-by: yefu.chen <yefu.chen@zilliz.com >
2021-04-21 11:37:21 +08:00
Jin Hai and GitHub
23e0816baa
Fix Markdown format ( #1485 )
...
* Fix #839 and improve the code quality
Signed-off-by: JinHai-CN <hai.jin@zilliz.com >
* Fix compiling error and building threads number
Signed-off-by: JinHai-CN <hai.jin@zilliz.com >
* Fix Markdown quality
Signed-off-by: JinHai-CN <hai.jin@zilliz.com >
* Fix Markdown quality
Signed-off-by: JinHai-CN <hai.jin@zilliz.com >
* Fix Markdown quality
Signed-off-by: JinHai-CN <hai.jin@zilliz.com >
* Fix Markdown format
Signed-off-by: JinHai-CN <hai.jin@zilliz.com >
* Fix Markdown format
Signed-off-by: JinHai-CN <hai.jin@zilliz.com >
* Fix Markdown format
Signed-off-by: JinHai-CN <hai.jin@zilliz.com >
2020-03-03 00:25:22 +08:00
Lutkin Wang and GitHub
80528fed99
Update CONTRIBUTING.md ( #1465 )
...
Signed-off-by: Lutkin Wang <lu.wang@zilliz.com >
2020-03-01 19:30:39 +08:00
d380c8d69b
Add DCO content to CONTRIBUTING.md ( #1460 )
...
* Update CHANGELOG.md
Signed-off-by: Lutkin Wang <lu.wang@zilliz.com >
* Update INSTALL.md
Signed-off-by: Lutkin Wang <lu.wang@zilliz.com >
* Update INSTALL.md
Signed-off-by: Lutkin Wang <lu.wang@zilliz.com >
* Update CONTRIBUTING.md
Add DCO rules.
Signed-off-by: Lutkin Wang <lu.wang@zilliz.com >
* Update CHANGELOG.md
Signed-off-by: Lutkin Wang <lu.wang@zilliz.com >
* Update CONTRIBUTING.md
Signed-off-by: Lutkin Wang <lu.wang@zilliz.com >
Co-authored-by: Jin Hai <hai.jin@zilliz.com >
2020-03-01 12:21:15 +08:00
Jin Hai and GitHub
4c2276a91c
Update CONTRIBUTING.md ( #942 )
...
* [skip ci]#668 - Update badge of README
* Fix README.md
* Fix README.md
* Merge remote-tracking branch 'upstream/master'
* #910 Change c++ standard to c++17
* Remove unused headers
* #910 Change Milvus c++ standard to c++17
* #910 Change Milvus c++ standard to c++17
* #941 Update CONTRIBUTING.md
2020-01-07 17:04:15 +08:00
jielinxu and GitHub
c219fe0c1f
[skip ci] Update Contributing code
...
Former-commit-id: a96d53012ffe755b1b3ef5cc7ac55ceec96e2df5
2019-10-31 15:02:19 +08:00
jielinxu
cb088c7778
update README and CONTRIBUTING
...
Former-commit-id: 4bf191eebdaa945ce58c5c31124f4837862960fe
2019-10-16 16:17:04 +08:00
jielinxu and GitHub
9baed0cc80
Update CONTRIBUTING.md
...
Former-commit-id: 1aa73012009b7d2460ba79395865803f92ff00f8
2019-10-15 20:00:04 +08:00
jielinxu and GitHub
b0a74adcd6
Update CONTRIBUTING.md
...
Former-commit-id: 18a9e7746b86e314d11185b41783a61fe97cc73f
2019-10-15 19:59:28 +08:00
jielinxu and GitHub
150007e92b
Update CONTRIBUTING.md
...
Former-commit-id: 376d001aa8ee0a36edce4ae734e3895a828cd480
2019-10-15 19:54:47 +08:00
JinHai-CN
c8a17855a4
Update Documents
...
Former-commit-id: 64df469fb0709e705e8235c1913b964b0b3c946b
2019-10-15 18:43:51 +08:00
starlord
41d37f9648
re-organize project
...
Former-commit-id: 898c2c8b0b2cfdc1b8664062aa0ea910a93566dd
2019-10-14 09:51:48 +08:00
jinhai
d8bb0ac9af
MS-4 Refactor the code structure
...
Former-commit-id: 369b9f28d1391765b4d4dada2140b261132a0e55
2019-05-26 14:46:38 +08:00