Skip to content

Commit

Permalink
Release new docs
Browse files Browse the repository at this point in the history
  • Loading branch information
Milvus-doc-bot authored and Milvus-doc-bot committed Nov 26, 2024
1 parent 9b14603 commit 689e41a
Show file tree
Hide file tree
Showing 645 changed files with 89,542 additions and 1 deletion.
202 changes: 202 additions & 0 deletions v2.5.x/CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,202 @@
# Contributing to Milvus Documentation

The Milvus docs are open-source just like the database itself and welcome contributions from everyone in the Milvus community.

> 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.
## What contributions can I make?

Basically anything you can think of to improve our documentation and make it more user friendly! For example:

- Fix a typo or a grammatical error.

- Update or extend existing documentation.

- Add new pages to Milvus documentation.

## Before you start

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).

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.

## Get started

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).

For more substantial changes, please follow the following steps:

1. [File an issue](https://github.com/milvus-io/milvus-docs/issues/new/choose) and assign it to yourself.

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.

2. Fork the [milvus-docs repository](https://github.com/milvus-io/milvus-docs) to your own GitHub account.

3. Fetch to make sure your local branch is up-to-date.

4. Once you complete your changes, create a pull request. Your changes will be reviewed by a technical writer as soon as possible.

For detailed information on this workflow, see [Make Your First Contribution](https://milvus.io/community/making_your_first_contributions.md).

## Docs structure

![Folders](assets/folder-structure.png)

- [Languages](#language)
- [Pages](#pages)
- [Sidebar](#sidebar)

### Language

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!

> 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.
### Pages

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.

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.

Example:

- `install_offline.md`

Markdown pages start with the following front-matter with `id` as the mandatory field:

```
---
id: page_id.md
title: Title of Page
summary: Short description of the page for SEO purposes
related_key: keyword
group: major_page.md
---
```

| Field                | Description                                              |
| ------------------------ | ------------------------------------------------------------ |
| `id`                     | The unique ID assigned to each page.                         |
| `title` (optional)       | Used as the h1 header and written in title-case.             |
| `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. |
| `related_key` (optional) | Used as the keyword to pull related questions from the FAQ database to show at the bottom of the page. |
| `group` (optional) | Add the leading page appeared on the sidenav if this page is a part of a page group. |

#### Templates

In general, there are four types of documentation:

- [How-to docs](site/template/how-to-doc-template.md)
- [Conceptual docs](site/template/conceptual-doc-template.md)
- [Reference docs](site/template/reference-doc-template.md)
- [Tutorials](site/template/tutorial-doc-template.md)

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.

#### Images

*Images* are housed under the **/assets** folder and can be referenced with `![ImageName]({{images.assets/ImageName.jpg/png "This is a caption"}})`.

#### Fragments

*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.

#### Variables

*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.

> The defined variables are implemented within the current folder and its subfolders.
### Sidebar

For each documented version of Milvus, the JSON file in the **menuStructure** directory defines what pages appear in the Docs sidebar.

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.

In the JSON file for a version's sidebar, there are six possible fields:

| Field | Type | Description |
| ------|------|------------ |
| `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). |
| `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. |
| `label<n>` (e.g., label1, label2, label3) | String | The hierarchical structure of pages and sections.  |
| `order` | Integar | The sorting order of pages and sections under the current label, starting from 0. |
| `isMenu` | Boolean | Set as `true` if the entry is a section/subsection of the sidenav. |
| `outlink` | Array of strings | The URL of a page that is not rendered by any Markdown file in the **milvus-docs** repository. |

#### JSON Example

This example shows some of the "Get Started" section of the sidenav:

```json
{
    "menuList": [
    ...,
    {
     "id": "getstarted",
     "title": "Get Started",
     "label1": "",
     "label2": null,
     "label3": null,
     "order": 1,
     "isMenu": true
},
    {
      "id": "prerequisite-docker.md",
      "title": "Before you Begin",
      "label1": "getstarted",
      "label2": null,
      "label3": null,
      "order": 0
    },  
    {
     "id": "installmilvus",
     "title": "Install Milvus",
     "label1": "getstarted",
     "label2": null,
     "label3": null,
     "order": 1,
     "isMenu": true
   },
   {
     "id": "install_standalone-docker.md",
     "title": "Milvus Standalone",
     "label1": "getstarted",
     "label2": "installmilvus",
     "label3": null,
     "order": 0
   },
   {
     "id": "install_cluster-docker.md",
     "title": "Milvus Cluster",
     "label1": "getstarted",
     "label2": "installmilvus",
     "label3": null,
     "order": 1
   },
   {
     "id": "install_offline-docker.md",
     "title": "Install Offline",
     "label1": "getstarted",
     "label2": "installmilvus",
     "label3": null,
     "order": 2
   },
   {
     "id": "example_code.md",
     "title": "Hello Milvus",
     "label1": "getstarted",
     "label2": "",
     "label3": "",
     "order": 2
   },
    ...
    ]
}
```
190 changes: 190 additions & 0 deletions v2.5.x/LICENSE
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,190 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

Copyright 2019 ZILLIZ

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
Loading

0 comments on commit 689e41a

Please sign in to comment.