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 Dec 8, 2023
1 parent 70f0ff7 commit 4f4a4ed
Show file tree
Hide file tree
Showing 9 changed files with 18 additions and 18 deletions.
2 changes: 1 addition & 1 deletion v2.3.x/site/en/adminGuide/configure-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,7 @@ Data are stored in the <code>/volumes</code> folder according to the default con
Having finished modifying the configuration file and installation file, you can then start Milvus.

```
$ sudo docker-compose up -d
$ sudo docker compose up -d
```

## What's next
Expand Down
2 changes: 1 addition & 1 deletion v2.3.x/site/en/adminGuide/deploy_etcd.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ See [etcd-related Configurations](configure_etcd.md) for more information.
Run the following command to start Milvus that uses the etcd configurations.

```
docker-compose up
docker compose up
```

<div class="alert note">Configurations only take effect after Milvus starts. See <a href=https://milvus.io/docs/install_standalone-docker.md#Start-Milvus>Start Milvus</a> for more information.</div>
Expand Down
2 changes: 1 addition & 1 deletion v2.3.x/site/en/adminGuide/deploy_s3.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ You'd also remove the `MINIO_ADDRESS` environment variable for milvus service at
### 3. Run Milvus
Run the following command to start Milvus that uses the S3 configurations.
```shell
docker-compose up
docker compose up
```
<div class="alert note">Configurations only take effect after Milvus starts. See <a href=https://milvus.io/docs/install_standalone-docker.md#Start-Milvus>Start Milvus</a> for more information.</div>

Expand Down
8 changes: 4 additions & 4 deletions v2.3.x/site/en/adminGuide/upgrade_milvus_cluster-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,8 +57,8 @@ In normal cases, you can upgrade Milvus as follows:
2. Run the following commands to perform the upgrade.
```shell
docker-compose down
docker-compose up -d
docker compose down
docker compose up -d
```

## Migrate the metadata
Expand Down Expand Up @@ -103,8 +103,8 @@ In normal cases, you can upgrade Milvus as follows:

```
Update the milvus image tag in the docker-compose.yaml
docker-compose down
docker-compose up -d
docker compose down
docker compose up -d
```

## What's next
Expand Down
8 changes: 4 additions & 4 deletions v2.3.x/site/en/adminGuide/upgrade_milvus_standalone-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ In normal cases, you can upgrade Milvus as follows:
2. Run the following commands to perform the upgrade.
```shell
docker-compose down
docker-compose up -d
docker compose down
docker compose up -d
```

## Migrate the metadata
Expand Down Expand Up @@ -83,8 +83,8 @@ In normal cases, you can upgrade Milvus as follows:

```shell
// Run the following only after update the milvus image tag in the docker-compose.yaml
docker-compose down
docker-compose up -d
docker compose down
docker compose up -d
```

## What's next
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ You can connect to Milvus using the local IP address and port number returned by

To stop Milvus standalone, run:
```
sudo docker-compose down
sudo docker compose down
```

To delete data after stopping Milvus, run:
Expand Down
2 changes: 1 addition & 1 deletion v2.3.x/site/en/reference/architecture/four_layers.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Index coord manages topology of the index nodes, builds index, and maintains ind

## Worker nodes

The arms and legs. Worker nodes are dumb executors that follow instructions from the coordinator service and execute data manipulation language (DML) commands from the proxy. Worker nodes are stateless thanks to separation of storage and computation, and can facilitate system scale-out and disaster recovery when deployed on Kubenetes. There are three types of worker nodes:
The arms and legs. Worker nodes are dumb executors that follow instructions from the coordinator service and execute data manipulation language (DML) commands from the proxy. Worker nodes are stateless thanks to separation of storage and computation, and can facilitate system scale-out and disaster recovery when deployed on Kubernetes. There are three types of worker nodes:

### Query node

Expand Down
8 changes: 4 additions & 4 deletions v2.3.x/site/en/reference/sys_config/configure_minio.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,9 @@ To share a MinIO instance among multiple Milvus instances, you need to change <c
<tr>
<td>
<li>Access key ID that MinIO or S3 issues to user for authorized access.</li>
<li>Environment variable: <code>MINIO_ACCESS_KEY</code> or <code>minio.accessKeyID</code></li>
<li>Environment variable: <code>MINIO_ACCESS_KEY_ID</code> or <code>minio.accessKeyID</code></li>
<li><code>minio.accessKeyID</code> and <code>minio.secretAccessKey</code> together are used for identity authentication to access the MinIO or S3 service.</li>
<li>This configuration must be set identical to the environment variable <code>MINIO_ACCESS_KEY</code>, which is necessary for starting MinIO or S3.</li>
<li>This configuration must be set identical to the environment variable <code>MINIO_ACCESS_KEY_ID</code>, which is necessary for starting MinIO or S3.</li>
<li>The default value applies to MinIO or S3 service that started with the default <b>docker-compose.yml</b> file.</li>
</td>
<td>minioadmin</td>
Expand All @@ -101,9 +101,9 @@ To share a MinIO instance among multiple Milvus instances, you need to change <c
<tr>
<td>
<li>Secret key used to encrypt the signature string and verify the signature string on server. It must be kept strictly confidential and accessible only to the MinIO or S3 server and users.</li>
<li>Environment variable: <code>MINIO_SECRET_KEY</code> or <code>minio.secretAccessKey</code></li>
<li>Environment variable: <code>MINIO_SECRET_ACCESS_KEY</code> or <code>minio.secretAccessKey</code></li>
<li><code>minio.accessKeyID</code> and <code>minio.secretAccessKey</code> together are used for identity authentication to access the MinIO or S3 service.</li>
<li>This configuration must be set identical to the environment variable <code>MINIO_SECRET_KEY</code>, which is necessary for starting MinIO or S3.</li>
<li>This configuration must be set identical to the environment variable <code>MINIO_SECRET_ACCESS_KEY</code>, which is necessary for starting MinIO or S3.</li>
<li>The default value applies to MinIO or S3 service that started with the default <b>docker-compose.yml</b> file.</li>
</td>
<td>minioadmin</td>
Expand Down
2 changes: 1 addition & 1 deletion v2.3.x/site/en/userGuide/build_scalar_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ To speed up [attribute filtering](boolean.md) in [hybrid searches](hybridsearch.

## Build index

To build an index on scalar fields, you do not need to set any index parameters. The default value of a scalar field index name is **_default_idx_** followed by the name of the indexed field. You can set it to another value that seems fit.
To build an index on scalar fields, you do not need to set any index parameters. The default value of a scalar field index name is **\_default\_idx\_\<fieldId\>** followed by the name of the indexed field. You can set it to another value that seems fit.

The following code snippet assumes that a collection named `book` already exists and an index is to be created on the string field `book_name`.

Expand Down

0 comments on commit 4f4a4ed

Please sign in to comment.