diff --git a/README_JP.md b/README_JP.md index b0992e206..1a4e7bdce 100644 --- a/README_JP.md +++ b/README_JP.md @@ -108,8 +108,7 @@ Olaresは以下のLinuxプラットフォームで動作検証を完了してい 自分のデバイスでOlaresを始めるには、[はじめにガイド](https://docs.olares.com/manual/get-started/)に従ってステップバイステップの手順を確認してください。 -## プロジェクトナビゲーション - +## プロジェクトナビゲーションx このセクションでは、Olares リポジトリ内の主要なディレクトリをリストアップしています： * **[`apps`](./apps)**: システムアプリケーションのコードが含まれており、主に `larepass` 用です。 diff --git a/docs/.vitepress/en.ts b/docs/.vitepress/en.ts index b3b2a7e18..895c52b4e 100644 --- a/docs/.vitepress/en.ts +++ b/docs/.vitepress/en.ts @@ -4,27 +4,21 @@ const side = { "/manual/": [ { text: "What is Olares", - link: "/manual/docs-home", + link: "/manual/overview", items: [ - // A{ text: "Why Olares", link: "/manual/why-olares" }, - //{ text: "Feature comparison", link: "/manual/feature-overview" }, - { text: "Olares architecture", link: "/manual/system-architecture" }, { text: "Compare Olares and NAS", link: "/manual/olares-vs-nas" }, - { - text: "Help and support", - collapsed: true, - items: [ - { text: "FAQs", link: "/manual/help/faqs" }, - { - text: "Request support", - link: "/manual/help/request-technical-support", - }, + { text: "Help and support", link: "/manual/help/request-technical-support"} + // collapsed: true, + // items: [ + // { text: "FAQs", link: "/manual/help/faqs" }, + // { + // text: "Request support", + // link: "/manual/help/request-technical-support", + // }, //{ // text: "Troubleshooting Guide", // link: "/manual/help/troubleshooting-guide", // }, - ], - }, ], }, { @@ -290,9 +284,8 @@ const side = { collapsed: true, link: "/manual/concepts/", items: [ - { text: "Architecture", link: "/manual/concepts/architecture" }, - { text: - "Olares ID", + { text: "Olares architecture", link: "/manual/concepts/system-architecture" }, + { text: "Olares ID", link: "/manual/concepts/olares-id", collapsed: true, items: [ @@ -616,51 +609,50 @@ const side = { }, ], }, - { - text: "Advanced", - collapsed: true, - items: [ - { - text: "terminus-info", - link: "/developer/develop/advanced/terminus-info", - }, - { - text: "Service provider", - link: "/developer/develop/advanced/provider", - }, - { - text: "AI", - link: "/developer/develop/advanced/ai", - }, - { text: "Cookie", link: "/developer/develop/advanced/cookie" }, - { text: "Database", link: "/developer/develop/advanced/database" }, - { - text: "Account", - link: "/developer/develop/advanced/account", - }, - { - text: "Market", - link: "/developer/develop/advanced/market", - }, - { - text: "Websocket", - link: "/developer/develop/advanced/websocket", - }, - { - text: "File upload", - link: "/developer/develop/advanced/file-upload", - }, - { - text: "Secret", - link: "/developer/develop/advanced/secret", - }, - { - text: "Kubesphere", - link: "/developer/develop/advanced/kubesphere", - }, - ], - }, - + // { + // text: "Advanced", + // collapsed: true, + // items: [ + // { + // text: "terminus-info", + // link: "/developer/develop/advanced/terminus-info", + // }, + // { + // text: "Service provider", + // link: "/developer/develop/advanced/provider", + // }, + // { + // text: "AI", + // link: "/developer/develop/advanced/ai", + // }, + // { text: "Cookie", link: "/developer/develop/advanced/cookie" }, + // { text: "Database", link: "/developer/develop/advanced/database" }, + // { + // text: "Account", + // link: "/developer/develop/advanced/account", + // }, + // { + // text: "Market", + // link: "/developer/develop/advanced/market", + // }, + // { + // text: "Websocket", + // link: "/developer/develop/advanced/websocket", + // }, + // { + // text: "File upload", + // link: "/developer/develop/advanced/file-upload", + // }, + // { + // text: "Secret", + // link: "/developer/develop/advanced/secret", + // }, + // { + // text: "Kubesphere", + // link: "/developer/develop/advanced/kubesphere", + // }, + // ], + // }, { text: "Submit application", collapsed: true, @@ -789,7 +781,7 @@ export const en = defineConfig({ socialLinks: [{ icon: "github", link: "https://github.com/beclab/olares" }], nav: [ - { text: "Olares", link: "/manual/docs-home" }, + { text: "Olares", link: "/manual/overview" }, { text: "Olares Space", link: "/space/" }, { text: "Use Cases", link: "/use-cases/" }, { text: "Developer Guide", link: "/developer/install/" }, diff --git a/docs/.vitepress/zh.ts b/docs/.vitepress/zh.ts index 7186ec19b..d1aea5e65 100644 --- a/docs/.vitepress/zh.ts +++ b/docs/.vitepress/zh.ts @@ -3,30 +3,26 @@ import { defineConfig, type DefaultTheme } from "vitepress"; const side = { "/zh/manual/": [ { - text: "文档站", - link: "/zh/manual/docs-home", + text: "Olares 是什么？", + link: "/zh/manual/overview", items: [ // { text: "应用场景", link: "/zh/manual/why-olares" }, //{ text: "功能对比", link: "/zh/manual/feature-overview" }, - { text: "系统架构", link: "/zh/manual/system-architecture" }, { text: "比较 Olares 和 NAS", link: "/zh/manual/olares-vs-nas" }, - { - text: "帮助与支持", - collapsed: true, - items: [ - { text: "常见问题", link: "/zh/manual/help/faqs" }, - { - text: "技术支持", - link: "/zh/manual/help/request-technical-support", - }, + {text: "帮助与支持", link: "/zh/manual/help/request-technical-support",} + // collapsed: true, + // items: [ + // { text: "常见问题", link: "/zh/manual/help/faqs" }, + // { + // text: "技术支持", + // link: "/zh/manual/help/request-technical-support", + // }, // { // text: "Troubleshooting Guide", // link: "/zh/manual/help/troubleshooting-guide", // }, ], }, - ], - }, { text: "快速开始", collapsed: false, @@ -292,7 +288,7 @@ const side = { collapsed: true, link: "/zh/manual/concepts/", items: [ - { text: "架构", link: "/zh/manual/concepts/architecture" }, + { text: "系统架构", link: "/zh/manual/concepts/system-architecture" }, { text: "Olares ID", link: "/zh/manual/concepts/olares-id", collapsed: true, @@ -619,52 +615,52 @@ const side = { }, ], }, - { - text: "进阶", - collapsed: true, - items: [ - { - text: "terminus-info", - link: "/zh/developer/develop/advanced/terminus-info", - }, - { - text: "Service Provider", - link: "/zh/developer/develop/advanced/provider", - }, - { - text: "AI", - link: "/zh/developer/develop/advanced/ai", - }, - { text: "Cookie", link: "/zh/developer/develop/advanced/cookie" }, - { text: "数据库", link: "/zh/developer/develop/advanced/database" }, - { - text: "账户", - link: "/zh/developer/develop/advanced/account", - }, - { - text: "应用市场", - link: "/zh/developer/develop/advanced/market", - }, + // { + // text: "进阶", + // collapsed: true, + // items: [ + // { + // text: "terminus-info", + // link: "/zh/developer/develop/advanced/terminus-info", + // }, + // { + // text: "Service Provider", + // link: "/zh/developer/develop/advanced/provider", + // }, + // { + // text: "AI", + // link: "/zh/developer/develop/advanced/ai", + // }, + // { text: "Cookie", link: "/zh/developer/develop/advanced/cookie" }, + // { text: "数据库", link: "/zh/developer/develop/advanced/database" }, + // { + // text: "账户", + // link: "/zh/developer/develop/advanced/account", + // }, + // { + // text: "应用市场", + // link: "/zh/developer/develop/advanced/market", + // }, // { // text: "Analytic", // link: "/zh/developer/develop/advanced/analytic", // }, - { - text: "Websocket", - link: "/zh/developer/develop/advanced/websocket", - }, - { - text: "文件上传", - link: "/zh/developer/develop/advanced/file-upload", - }, + // { + // text: "Websocket", + // link: "/zh/developer/develop/advanced/websocket", + // }, + // { + // text: "文件上传", + // link: "/zh/developer/develop/advanced/file-upload", + // }, // { // text: "Rss", // link: "/zh/developer/develop/advanced/rss", // }, - { - text: "密钥", - link: "/zh/developer/develop/advanced/secret", - }, + // { + // text: "密钥", + // link: "/zh/developer/develop/advanced/secret", + // }, // { // text: "Notification", // link: "/zh/developer/develop/advanced/notification", @@ -673,13 +669,12 @@ const side = { // text: "Frontend", // link: "/zh/developer/develop/advanced/frontend", // }, - { - text: "Kubesphere", - link: "/zh/developer/develop/advanced/kubesphere", - }, - ], - }, - + // { + // text: "Kubesphere", + // link: "/zh/developer/develop/advanced/kubesphere", + // }, + // ], + // }, { text: "提交应用", collapsed: true, @@ -808,7 +803,7 @@ export const zh = defineConfig({ socialLinks: [{ icon: "github", link: "https://github.com/beclab/olares" }], nav: [ - { text: "Olares", link: "zh/manual/docs-home" }, + { text: "Olares", link: "zh/manual/overview" }, { text: "Olares Space", link: "/zh/space/" }, { text: "应用示例", link: "/zh/use-cases/" }, { text: "开发者文档", link: "/zh/developer/install/" }, diff --git a/docs/manual/best-practices/install-olares-multi-node.md b/docs/manual/best-practices/install-olares-multi-node.md index 1ed2c1188..7b17f5cc3 100644 --- a/docs/manual/best-practices/install-olares-multi-node.md +++ b/docs/manual/best-practices/install-olares-multi-node.md @@ -150,7 +150,7 @@ Once your cluster is set up, changes in network configurations can disrupt the m ## Learn more -- [Olares system architecture](../system-architecture.md#distributed-file-system): Understand the distributed file system that underpins Olares, ensuring scalability, high availability, and seamless data management. +- [Olares system architecture](../concepts/system-architecture.md#distributed-file-system): Understand the distributed file system that underpins Olares, ensuring scalability, high availability, and seamless data management. - [The system daemon: olaresd](../../developer/install/installation-overview.md#system-daemon-olaresd): Learn about the central system process that orchestrates and manages core Olares functions. - [Data](../concepts/data.md#juicefs): Dive into how Olares leverages JuiceFS to provide a unified file system for efficient data storage and retrieval. - [Olares CLI](../../developer/install/cli/olares-cli.md): Explore the command-line interface for managing Olares installation. diff --git a/docs/manual/system-architecture.md b/docs/manual/concepts/system-architecture.md similarity index 94% rename from docs/manual/system-architecture.md rename to docs/manual/concepts/system-architecture.md index 4a07c3ff0..99eb78fbc 100644 --- a/docs/manual/system-architecture.md +++ b/docs/manual/concepts/system-architecture.md @@ -59,14 +59,14 @@ Currently, Olares GPU support is restricted to deployments with one GPU per node Starting with Olares v1.11, [CUDA](https://developer.nvidia.com/cuda-toolkit) (12.4 and above) is supported. Changes in the host environment's CUDA configuration can be synchronized with the Olares cluster using `olares-cli`. ### Container management -Olares uses [containerd](../developer/install/installation-overview.md#container-runtime-containerd), a lightweight container runtime, for containerized deployments. +Olares uses [containerd](../../developer/install/installation-overview.md#container-runtime-containerd), a lightweight container runtime, for containerized deployments. ### Olares Controller Panel The management of Olares is implemented through the following: -- [olares-cli](../developer/install/cli/olares-cli.md): A command-line tool for managing Olares clusters, applications, and hardware nodes. -- [olaresd](../developer/install/installation-overview.md#container-runtime-containerd): A daemon process that monitors hardware and network changes, while also managing cluster upgrades, restarts, and other maintenance operations. +- [olares-cli](../../developer/install/cli/olares-cli.md): A command-line tool for managing Olares clusters, applications, and hardware nodes. +- [olaresd](../../developer/install/installation-overview.md#container-runtime-containerd): A daemon process that monitors hardware and network changes, while also managing cluster upgrades, restarts, and other maintenance operations. These tools streamline installation, maintenance, and scaling for Olares. @@ -215,6 +215,6 @@ The console for Olares, providing precise and autonomous control over the system A development tool for building and deploying Olares applications. ## Learn more -- To get started with Olares, see the [Getting Started guide](get-started/index.md). -- To learn more about the internals of Olares, see the topics in [Concept](concepts/index.md). -- For in-depth details about how each component of Olares is orchestrated, see [Olares installation overview](../developer/install/index.md). \ No newline at end of file +- To get started with Olares, see the [Getting Started guide](../get-started/index.md). +- To learn more about the internals of Olares, see the topics in [Concept](index.md). +- For in-depth details about how each component of Olares is orchestrated, see [Olares installation overview](../../developer/install/index.md). \ No newline at end of file diff --git a/docs/manual/docs-home.md b/docs/manual/overview.md similarity index 87% rename from docs/manual/docs-home.md rename to docs/manual/overview.md index 59734db4f..f01da544b 100644 --- a/docs/manual/docs-home.md +++ b/docs/manual/overview.md @@ -10,10 +10,6 @@ This documentation provides a preview of features for an upcoming Olares version Olares is an open-source personal cloud operating system designed to empower you to own and manage your digital assets locally. Instead of relying on public cloud services, you can deploy powerful open-source alternatives locally on Olares, such as Ollama for hosting LLMs, SD WebUI for image generation, and Mastodon for building censor free social space. Imagine the power of the cloud, but with you in complete command. -With Olares, self-hosting is no longer a daunting task. It simplifies complex processes like network setup, domain management, and service orchestration, enabling both beginners or experienced users to focus on what truly matters. - -Privacy and independence are at the core of Olares. It is perfect for individuals or teams who want to avoid relying on centralized platforms. Your data stays on your hardware, and all tasks are processed locally, so your sensitive information never leaves your control. Olares gives you complete ownership of your data and infrastructure without sacrificing performance or simplicity. -
@@ -24,6 +20,16 @@ Privacy and independence are at the core of Olares. It is perfect for individual
+## Core components + +Olares comprises the following core components: + +- [**Olares ID**](./concepts/olares-id.md): A decentralized identity and credit system that facilitates secure, trustless exchanges of information and value. It serves as your digital identity across the Olares ecosystem. + +- [**Olares OS**](https://github.com/beclab/Olares): An open-source, self-hosted operating system that transforms edge devices into robust personal cloud. + +- [**LarePass**](./larepass): A secure, cross-platform client that bridges you and your Olares system. It provides seamless access, unified identity management, fast file synchronization, and comprehensive device management across all your devices. + ## Highlighted features Olares offers a wide array of features designed to enhance security, ease of use, and development flexibility: diff --git a/docs/zh/manual/best-practices/install-olares-multi-node.md b/docs/zh/manual/best-practices/install-olares-multi-node.md index 0b9bd0c32..d23374227 100644 --- a/docs/zh/manual/best-practices/install-olares-multi-node.md +++ b/docs/zh/manual/best-practices/install-olares-multi-node.md @@ -150,7 +150,7 @@ olares-cli olares uninstall ## 了解更多 -- [Olares 系统架构](../system-architecture.md#分布式存储)：了解支持 Olares 的分布式文件系统，确保可扩展性、高可用性以及无缝的数据管理。 +- [Olares 系统架构](../concepts/system-architecture.md#分布式存储)：了解支持 Olares 的分布式文件系统，确保可扩展性、高可用性以及无缝的数据管理。 - [系统守护进程](../../developer/install/installation-overview.md#系统守护进程olaresd)：olaresd：了解 orchestrates 和管理 Olares 核心功能的中央系统进程。 - [数据](../concepts/data.md#juicefs)：探索 Olares 如何利用 JuiceFS 提供统一文件系统，实现高效的数据存储和检索。 - [Olares CLI](../../developer/install/cli/olares-cli.md)：深入了解用于管理 Olares 安装的命令行工具。 diff --git a/docs/zh/manual/system-architecture.md b/docs/zh/manual/concepts/system-architecture.md similarity index 93% rename from docs/zh/manual/system-architecture.md rename to docs/zh/manual/concepts/system-architecture.md index 16028e608..4f5fc2b2c 100644 --- a/docs/zh/manual/system-architecture.md +++ b/docs/zh/manual/concepts/system-architecture.md @@ -59,14 +59,14 @@ Olares 目前的 GPU 管理功能仅支持单节点单 GPU 的部署场景。 从 Olares v1.11 开始，支持 [CUDA](https://developer.nvidia.com/cuda-toolkit)（12.4 及以上版本）。当宿主机环境的 CUDA 配置变更时，可以通过 `olares-cli` 通知 Olares 集群进行配置。 ### 容器管理 -Olares 使用轻量级容器运行时 [containerd](../developer/install/installation-overview.md#容器运行时containerd) 进行容器化部署。 +Olares 使用轻量级容器运行时 [containerd](../../developer/install/installation-overview.md#容器运行时containerd) 进行容器化部署。 ### Olares Controller Panel Olares 的集群管理通过以下工具实现： -- [olares-cli](../developer/install/cli/olares-cli.md)：命令行工具，用于管理 Olares 集群、应用和硬件节点等。 -- [olaresd](../developer/install/installation-overview.md#系统守护进程olaresd)：Olares 的守护进程，用于监控硬件和网络变更、处理集群升级和重启等。 +- [olares-cli](../../developer/install/cli/olares-cli.md)：命令行工具，用于管理 Olares 集群、应用和硬件节点等。 +- [olaresd](../../developer/install/installation-overview.md#系统守护进程olaresd)：Olares 的守护进程，用于监控硬件和网络变更、处理集群升级和重启等。 这些工具简化了 Olares 的安装、维护和扩展过程。 @@ -215,6 +215,6 @@ Olares 的控制台，提供对系统及其环境的精确和自主控制。 用于构建和部署 Olares 应用的开发工具。 ## 了解更多 -- 要开始使用 Olares，请参阅[快速开始](get-started/index.md)。 -- 要深入了解 Olares 的内部原理，请参阅[概念](concepts/index.md)中的主题。 -- 要详细了解 Olares 中各组件如何被编排，请参阅 [Olares 安装概述](../developer/install/index.md)。 \ No newline at end of file +- 要开始使用 Olares，请参阅[快速开始](../get-started/index.md)。 +- 要深入了解 Olares 的内部原理，请参阅[概念](index.md)中的主题。 +- 要详细了解 Olares 中各组件如何被编排，请参阅 [Olares 安装概述](../../developer/install/index.md)。 \ No newline at end of file diff --git a/docs/zh/manual/docs-home.md b/docs/zh/manual/overview.md similarity index 87% rename from docs/zh/manual/docs-home.md rename to docs/zh/manual/overview.md index 409840ad1..77dbc85c3 100644 --- a/docs/zh/manual/docs-home.md +++ b/docs/zh/manual/overview.md @@ -10,10 +10,6 @@ description: Olares 是为本地 AI 打造的开源私有云操作系统，支 ## Olares 是什么？ Olares 是一款开源个人云操作系统，旨在让你能够轻松在本地拥有并管理自己的数字资产。你无需再依赖公有云服务，而可以在 Olares 上本地部署强大的开源平替服务或应用，例如可以使用 Ollama 托管大语言模型，使用 SD WebUI 用于图像生成，以及使用 Mastodon 构建不受审查的社交空间。Olares 让你坐拥云计算的强大威力，又能完全将其置于自己掌控之下。 -有了 Olares，自托管不再是复杂艰难的任务。它简化了诸如网络设置、域名管理和服务编排等繁琐流程，无论是初学者还是资深用户，都可以专注于真正重要的事情。 - -隐私和自主性是 Olares 的核心理念。对于希望避免依赖中心化平台的个人或团队来说，Olares 是理想之选。你的数据始终保存在自己的设备上，所有任务均在本地处理，确保应用数据和敏感信息始终掌握在手中。Olares 在保持性能和易用性的同时，赋予你对数据和应用设备完全的掌控权。 -
@@ -24,6 +20,16 @@ Olares 是一款开源个人云操作系统，旨在让你能够轻松在本地
+## Olares 组成部分 + +Olares 由以下核心组件组成： + +- [Olares ID](./concepts/olares-id.md)：一种去中心化的身份与信用系统，支持信息和价值的安全、无信任交换。Olares ID 是你在整个 Olares 生态中的数字身份。 + +- [**Olares OS**](https://github.com/beclab/Olares)：一个开源自主托管操作系统，可将边缘设备转化为强大的个人云。 + +- [**LarePass**](./larepass)：一款安全的跨平台客户端，连接您与 Olares 系统。它提供无缝访问、统一身份管理、快速文件同步，以及强大的设备管理能力。 + ## 功能亮点 Olares 提供了丰富的功能，旨在提升安全性、易用性和开发灵活性：