Skip to content

Commit

Permalink
Docs: update quick_start_guide (#1280)
Browse files Browse the repository at this point in the history
  • Loading branch information
yuhr123 authored Jan 11, 2022
1 parent 1a56707 commit 0839351
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 5 deletions.
10 changes: 8 additions & 2 deletions docs/en/getting-started/for_local.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,14 @@ juicefs format [command options] META-URL NAME

As you can see, there are 3 types of information required to format a file system.

1. **[command options]**: used to provide data storage related information, if nothing is specified then **default to local disk** as the storage medium, default path is `"$HOME/.juicefs/local"` or `"/var/jfs"`.
1. **[command options]**: Sets the storage media for the file system, if nothing is specified then **default to local disk** as the storage media, default path is `"$HOME/.juicefs/local"` or `"/var/jfs"`.
2. **META-URL**: used to set the metadata engine, usually the URL or file path to the database.
3. **NAME**: the name of the file system.

:::tip
JuiceFS supports a wide range of storage media and metadata storage engines, see [JuiceFS supported storage medias](../reference/how_to_setup_object_storage.md) and [JuiceFS supported metadata storage engines](../reference/how_to_setup_metadata_engine.md)
:::

### Hands-on Practice

On a Linux system, for example, the following command creates a file system named `myjfs`.
Expand Down Expand Up @@ -108,7 +112,9 @@ The previous content is only suitable to quickly help you experience and underst

Object Storage is a web storage service based on the HTTP protocol that offers simple API for access. It has a flat structure, easy to scale, relatively inexpensive, and is ideal for storing large amounts of unstructured data. Almost all major cloud computing platforms provide object storage services, such as Amazon S3, Alibaba Cloud OSS, Backblaze B2, etc.

JuiceFS supports almost all object storage services, and in general, creating an object store usually requires only 2 parts.
JuiceFS supports almost all object storage services, see [JuiceFS supported storage medias](../reference/how_to_setup_object_storage.md).

In general, creating an object store usually requires only 2 parts.

1. Create a `Bucket` and get the Endpoint address.
2. Create the `Access Key ID` and `Access Key Secret`, the access keys for the Object Storage API.
Expand Down
12 changes: 9 additions & 3 deletions docs/zh_cn/getting-started/for_local.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,14 @@ juicefs format [command options] META-URL NAME

可见,格式化文件系统需要提供 3 种信息:

1. **[command options]**用来提供数据存储相关的信息,如果不作任何指定则**默认使用本地磁盘**作为存储介质,默认为 `"$HOME/.juicefs/local"``"/var/jfs"`
2. **META-URL**:用来设置元数据存储即数据库相关的信息,通常是数据库的 URL 或文件路径;
1. **[command options]**设定文件系统的存储介质,留空则**默认使用本地磁盘**作为存储介质,路径为 `"$HOME/.juicefs/local"``"/var/jfs"`
2. **META-URL**:用来设置元数据存储即数据库相关的信息,通常是数据库的 URL 或文件路径;
3. **NAME**:是文件系统的名称。

:::tip 提示
JuiceFS 支持丰富的存储介质和元数据存储引擎,查看 [JuiceFS 支持的存储介质](../reference/how_to_setup_object_storage.md)[JuiceFS 支持的元数据存储引擎](../reference/how_to_setup_metadata_engine.md)
:::

### 上手实践

以 Linux 系统为例,以下命令创建了一个名为 `myjfs` 的文件系统。
Expand Down Expand Up @@ -108,7 +112,9 @@ juicefs umount mnt

对象存储是一种基于 HTTP 协议的,提供简单访问 API 的网络存储服务。它的结构扁平,易于扩展,价格相对低廉,非常适合存储海量的非结构化数据。几乎所有主流的云计算平台都有提供对象存储服务,如亚马逊 S3、阿里云 OSS、Backblaze B2 等。

JuiceFS 支持几乎所有的对象存储服务,一般来说,创建对象存储通常只需要 2 个环节:
JuiceFS 支持几乎所有的对象存储服务,查看「[JuiceFS 支持的存储介质](../reference/how_to_setup_object_storage.md)」。

一般来说,创建对象存储通常只需要 2 个环节:

1. 创建 `Bucket` 存储桶,拿到 Endpoint 地址;
2. 创建 `Access Key ID``Access Key Secret`,即对象存储 API 的访问密钥。
Expand Down

0 comments on commit 0839351

Please sign in to comment.