Skip to content

Commit 2b6e2e8

Browse files
Milvus-doc-botMilvus-doc-bot
Milvus-doc-bot
authored and
Milvus-doc-bot
committed
Release new docs to preview
1 parent 98e7abf commit 2b6e2e8

487 files changed

Lines changed: 135268 additions & 1 deletion

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎v3.0.x/CONTRIBUTING.md‎

Lines changed: 202 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,202 @@
1+
# Contributing to Milvus Documentation
2+
3+
The Milvus docs are open-source just like the database itself and welcome contributions from everyone in the Milvus community.
4+
5+
> This repository is for Milvus technical documentation update and maintenance. Visit [Milvus.io](https://milvus.io/docs) or [Web content repo](https://github.com/milvus-io/web-content) for fully rendered documents.
6+
7+
## What contributions can I make?
8+
9+
Basically anything you can think of to improve our documentation and make it more user friendly! For example:
10+
11+
- Fix a typo or a grammatical error.
12+
13+
- Update or extend existing documentation.
14+
15+
- Add new pages to Milvus documentation.
16+
17+
## Before you start
18+
19+
Before you contribute please take a minute to familiarize yourself with basic [Markdown](https://www.markdownguide.org/basic-syntax/) syntax and have a look at our [Code of Conduct](https://github.com/milvus-io/milvus/blob/master/CODE_OF_CONDUCT.md).
20+
21+
We **strongly recommended** that you stand by the [Google Developer Documentation Style Guide](https://developers.google.com/style/) before you want to make any substantial contributions. This guide gives useful advice on how to write accessible, consistent and inclusive documentation.
22+
23+
## Get started
24+
25+
If you want to correct a typo or grammatical error, feel free to edit the page and [create a pull request](https://github.com/milvus-io/milvus-docs/pulls).
26+
27+
For more substantial changes, please follow the following steps:
28+
29+
1. [File an issue](https://github.com/milvus-io/milvus-docs/issues/new/choose) and assign it to yourself.
30+
31+
Or if you want to fix an existing issue, go to [Issues](https://github.com/milvus-io/milvus-docs/issues), choose one issue and assign it to yourself.
32+
33+
2. Fork the [milvus-docs repository](https://github.com/milvus-io/milvus-docs) to your own GitHub account.
34+
35+
3. Fetch to make sure your local branch is up-to-date.
36+
 
37+
4. Once you complete your changes, create a pull request. Your changes will be reviewed by a technical writer as soon as possible.
38+
39+
For detailed information on this workflow, see [Make Your First Contribution](https://milvus.io/community/making_your_first_contributions.md).
40+
41+
## Docs structure
42+
43+
![Folders](assets/folder-structure.png)
44+
45+
- [Languages](#language)
46+
- [Pages](#pages)
47+
- [Sidebar](#sidebar)
48+
49+
### Language
50+
51+
All documentation is written in English, which is the official language supported by the Milvus website. Nevertheless, you are more than welcome to make a huge contribution to the community by translating the documentation into other languages you know!
52+
53+
> We are grateful that efforts to maintain a Chinese version of the docs have been continued by a community [project](https://github.com/milvus-cn) ([#1449](https://github.com/milvus-io/milvus-docs/issues/1449)). Milvus has stopped official support for Chinese documentation since August 2021.
54+
55+
### Pages
56+
57+
We provide documentation for each major version of Milvus. The pages for each version can be found in a directory named for the version. For example, docs for Milvus v2.0 are in the `v2.0.x` directory, whereas docs for Milvus v1.1.0 are in the `v1.1.0` directory.
58+
59+
Within each version's directory, every page must be an **.md** file written in Markdown. File names should be lowercase with an underscore between words and should be brief but descriptive.
60+
61+
Example:
62+
63+
- `install_offline.md`
64+
65+
Markdown pages start with the following front-matter with `id` as the mandatory field:
66+
67+
```
68+
---
69+
70+
id: page_id.md
71+
72+
title: Title of Page
73+
74+
summary: Short description of the page for SEO purposes
75+
76+
related_key: keyword
77+
78+
group: major_page.md
79+
80+
---
81+
```
82+
83+
| Field                | Description                                              |
84+
| ------------------------ | ------------------------------------------------------------ |
85+
| `id`                     | The unique ID assigned to each page.                         |
86+
| `title` (optional)       | Used as the h1 header and written in title-case.             |
87+
| `summary` (optional)     | Used as the page's `meta description` for SEO. Keep this under 143 characters. Consider using the first sentence of the page, or something similar. |
88+
| `related_key` (optional) | Used as the keyword to pull related questions from the FAQ database to show at the bottom of the page. |
89+
| `group` (optional) | Add the leading page appeared on the sidenav if this page is a part of a page group. |
90+
91+
#### Templates
92+
93+
In general, there are four types of documentation:
94+
95+
- [How-to docs](site/template/how-to-doc-template.md)
96+
- [Conceptual docs](site/template/conceptual-doc-template.md)
97+
- [Reference docs](site/template/reference-doc-template.md)
98+
- [Tutorials](site/template/tutorial-doc-template.md)
99+
100+
Follow any of these templates when you draft a document, but remember to be flexible as these types are not difinitively distinct from each other.
101+
102+
#### Images
103+
104+
*Images* are housed under the **/assets** folder and can be referenced with `![ImageName]({{images.assets/ImageName.jpg/png "This is a caption"}})`.
105+
106+
#### Fragments
107+
108+
*Fragments* let you split the markdown into independent, reusable pieces and are defined in the **site/en/fragments** folder. Use the **{{fragments/xxx.md}}** syntax to reference a specific fragment.
109+
110+
#### Variables
111+
112+
*Variables* are used to store version information that are referenced in code or paths. They are defined in **Variables.json** and can be used in Markdown (**.md**) files, fragments, and templates.
113+
114+
> The defined variables are implemented within the current folder and its subfolders.
115+
116+
### Sidebar
117+
118+
For each documented version of Milvus, the JSON file in the **menuStructure** directory defines what pages appear in the Docs sidebar.
119+
120+
If you're adding a page that you think should appear in the sidebar, please mention this in your pull request and follow the established practice when changing the **en.json** file.
121+
122+
In the JSON file for a version's sidebar, there are six possible fields:
123+
124+
| Field | Type | Description |
125+
| ------|------|------------ |
126+
| `id` | String | The unique ID (within the **en** folder) that is given to a section or a page (defined in the front-matter of the corresponding Markdown file). |
127+
| `title` | String | The title for an entry in the sidenav, e.g., "Get Started" (section), "Install Milvus" (subsection), or "Milvus Standalone" (page). See the [JSON Example](#json-example) below for more clarity. |
128+
| `label<n>` (e.g., label1, label2, label3) | String | The hierarchical structure of pages and sections.  |
129+
| `order` | Integar | The sorting order of pages and sections under the current label, starting from 0. |
130+
| `isMenu` | Boolean | Set as `true` if the entry is a section/subsection of the sidenav. |
131+
| `outlink` | Array of strings | The URL of a page that is not rendered by any Markdown file in the **milvus-docs** repository. |
132+
133+
#### JSON Example
134+
135+
This example shows some of the "Get Started" section of the sidenav:
136+
137+
```json
138+
{
139+
    "menuList": [
140+
    ...,
141+
    {
142+
     "id": "getstarted",
143+
     "title": "Get Started",
144+
     "label1": "",
145+
     "label2": null,
146+
     "label3": null,
147+
     "order": 1,
148+
     "isMenu": true
149+
},
150+
    {
151+
      "id": "prerequisite-docker.md",
152+
      "title": "Before you Begin",
153+
      "label1": "getstarted",
154+
      "label2": null,
155+
      "label3": null,
156+
      "order": 0
157+
    },  
158+
    {
159+
     "id": "installmilvus",
160+
     "title": "Install Milvus",
161+
     "label1": "getstarted",
162+
     "label2": null,
163+
     "label3": null,
164+
     "order": 1,
165+
     "isMenu": true
166+
   },
167+
   {
168+
     "id": "install_standalone-docker.md",
169+
     "title": "Milvus Standalone",
170+
     "label1": "getstarted",
171+
     "label2": "installmilvus",
172+
     "label3": null,
173+
     "order": 0
174+
   },
175+
   {
176+
     "id": "install_cluster-docker.md",
177+
     "title": "Milvus Cluster",
178+
     "label1": "getstarted",
179+
     "label2": "installmilvus",
180+
     "label3": null,
181+
     "order": 1
182+
   },
183+
   {
184+
     "id": "install_offline-docker.md",
185+
     "title": "Install Offline",
186+
     "label1": "getstarted",
187+
     "label2": "installmilvus",
188+
     "label3": null,
189+
     "order": 2
190+
   },
191+
   {
192+
     "id": "example_code.md",
193+
     "title": "Hello Milvus",
194+
     "label1": "getstarted",
195+
     "label2": "",
196+
     "label3": "",
197+
     "order": 2
198+
   },
199+
    ...
200+
    ]
201+
}
202+
```

‎v3.0.x/LICENSE‎

Lines changed: 190 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
Copyright 2019 ZILLIZ
179+
180+
Licensed under the Apache License, Version 2.0 (the "License");
181+
you may not use this file except in compliance with the License.
182+
You may obtain a copy of the License at
183+
184+
http://www.apache.org/licenses/LICENSE-2.0
185+
186+
Unless required by applicable law or agreed to in writing, software
187+
distributed under the License is distributed on an "AS IS" BASIS,
188+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189+
See the License for the specific language governing permissions and
190+
limitations under the License.

0 commit comments

Comments
 (0)