diff --git a/docs/en/community/integrations.md b/docs/en/community/integrations.md index e02da849c508..6a9996369da6 100644 --- a/docs/en/community/integrations.md +++ b/docs/en/community/integrations.md @@ -24,3 +24,38 @@ slug: /integrations ## DevOps - [Terraform Provider for JuiceFS](https://github.com/toowoxx/terraform-provider-juicefs) by Toowoxx IT GmbH, an IT service company from Germany + +## Alfred + +JuiceFS documents offers an Alfred workflow to search documents of JuiceFS with instant results + +![JuiceFS Alfred Workflow](../images/workflow-root.png) + +Simply type your keyword into Alfred (default: jfs) and provide a query to see instant search results from JuiceFS documents. + +### Install + +Workflow of Alfred 5 version: [Latest Download](https://github.com/zwwhdls/juicefs-alfred-workflow/releases/download/v0.1.0/JuiceFS.Search.alfredworkflow) + +### Usage + +Search all documents of JuiceFS, including community, enterprise and CSI: + +``` +# JuiceFS community documents +jfs ce +# JuiceFS enterprise documents +jfs ee +# JuiceFS csi documents +jfs csi +``` + +![JuiceFS Alfred Workflow demo](../images/workflow-demo.gif) + +## Workflow Variables + +- `API_KEY`: API key for algolia which JuiceFS documents uses. Default value is ok. +- `LANGUAGE`: Language of JuiceFS documents to search. Default is `en`. +- `HITS_PER_PAGE`: Hits of each search. Default is `10`. + +![JuiceFS Alfred Workflow configuration](../images/configuration.png) diff --git a/docs/en/images/configuration.png b/docs/en/images/configuration.png new file mode 100644 index 000000000000..0e4013c6d425 Binary files /dev/null and b/docs/en/images/configuration.png differ diff --git a/docs/en/images/workflow-demo.gif b/docs/en/images/workflow-demo.gif new file mode 100644 index 000000000000..beb32a216782 Binary files /dev/null and b/docs/en/images/workflow-demo.gif differ diff --git a/docs/en/images/workflow-root.png b/docs/en/images/workflow-root.png new file mode 100644 index 000000000000..66fa96c764c4 Binary files /dev/null and b/docs/en/images/workflow-root.png differ diff --git a/docs/zh_cn/community/integrations.md b/docs/zh_cn/community/integrations.md index 13a3b74693ca..72eecdda5b56 100644 --- a/docs/zh_cn/community/integrations.md +++ b/docs/zh_cn/community/integrations.md @@ -22,3 +22,38 @@ slug: /integrations ## DevOps - [Terraform Provider for JuiceFS](https://github.com/toowoxx/terraform-provider-juicefs) 由 Toowoxx IT GmbH 贡献,他们是一家来自德国的 IT 服务公司。 + +## Alfred + +JuiceFS 文档站集成了 Alfred,可以快速搜索 JuiceFS 文档。 + +![JuiceFS Alfred Workflow](../images/workflow-root.png) + +只需在 Alfred 中输入关键字(默认:jfs)并提供查询即可查看 JuiceFS 文档的即时搜索结果。 + +### 安装 + +安装 Alfred 5 的 JuiceFS workflow: [下载最新版本](https://github.com/zwwhdls/juicefs-alfred-workflow/releases/download/v0.1.0/JuiceFS.Search.alfredworkflow) + +### 使用 + +可以搜索 JuiceFS 的所有文档,包括社区、企业和 CSI: + +``` +# 查询 JuiceFS 社区版文档 +jfs ce +# 查询 JuiceFS 企业版文档 +jfs ee +# 查询 JuiceFS CSI 文档 +jfs csi +``` + +![JuiceFS Alfred Workflow demo](../images/workflow-demo.gif) + +## Workflow 可配置的变量 + +- `API_KEY`:JuiceFS 文档使用的 algolia 的 API 密钥,使用默认值就可以。 +- `LANGUAGE`:要搜索的 JuiceFS 文档的语言(en/zh),默认为 en。 +- `HITS_PER_PAGE`:每次搜索的点击量,默认值为 10。 + +![JuiceFS Alfred Workflow configuration](../images/configuration.png) diff --git a/docs/zh_cn/community/usage_tracking.md b/docs/zh_cn/community/usage_tracking.md index 5220ed1328f4..87707fbda0f0 100644 --- a/docs/zh_cn/community/usage_tracking.md +++ b/docs/zh_cn/community/usage_tracking.md @@ -3,7 +3,7 @@ title: 用量上报 sidebar_position: 4 --- -JuiceFS 默认会收集并上报**「匿名」**的使用数据。这些数据仅仅包含核心指标(如版本号、文件系统大小),不会包含任何用户信息或者敏感数据。你可以查看[这里](https://github.com/juicedata/juicefs/blob/main/pkg/usage/usage.go)检查相关代码。 +JuiceFS 默认会收集并上报 **「匿名」** 的使用数据。这些数据仅仅包含核心指标(如版本号、文件系统大小),不会包含任何用户信息或者敏感数据。你可以查看[这里](https://github.com/juicedata/juicefs/blob/main/pkg/usage/usage.go)检查相关代码。 这些数据帮助我们理解社区如何使用这个项目。你可以简单地通过 `--no-usage-report` 选项关闭用量上报: diff --git a/docs/zh_cn/images/configuration.png b/docs/zh_cn/images/configuration.png new file mode 100644 index 000000000000..0e4013c6d425 Binary files /dev/null and b/docs/zh_cn/images/configuration.png differ diff --git a/docs/zh_cn/images/workflow-demo.gif b/docs/zh_cn/images/workflow-demo.gif new file mode 100644 index 000000000000..0f0ab46b5177 Binary files /dev/null and b/docs/zh_cn/images/workflow-demo.gif differ diff --git a/docs/zh_cn/images/workflow-root.png b/docs/zh_cn/images/workflow-root.png new file mode 100644 index 000000000000..66fa96c764c4 Binary files /dev/null and b/docs/zh_cn/images/workflow-root.png differ