From 5295fc77484db8580125e8b77b8b406072ee13b9 Mon Sep 17 00:00:00 2001 From: Ryan Wang Date: Thu, 24 Nov 2022 23:53:06 +0800 Subject: [PATCH] docs: update documentation for Halo 2.0.0-rc.1 (#117) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 为 Halo 2.0.0-rc.1 更新文档。 /kind documentation ```release-note None ``` --- docs/developer-guide/core/run.md | 7 +++---- .../getting-started/install/docker-compose.md | 19 +++++++++---------- docs/getting-started/install/docker.md | 15 +++++++-------- docs/getting-started/prepare.md | 2 +- docs/intro.md | 8 ++++---- 5 files changed, 24 insertions(+), 27 deletions(-) diff --git a/docs/developer-guide/core/run.md b/docs/developer-guide/core/run.md index 8b23fba..ee425d3 100644 --- a/docs/developer-guide/core/run.md +++ b/docs/developer-guide/core/run.md @@ -105,9 +105,8 @@ VITE v3.1.6 ready in 638 ms 6. 最终访问 `http://localhost:8090/console` 即可进入控制台。访问 `http://localhost:8090` 即可进入站点首页。 :::info 注意 -目前 Beta 版本有以下几个使用注意事项： +目前 RC 版本有以下几个使用注意事项： ::: -1. 由于目前尚未完成初始化程序，所以安装完成之后没有默认主题，你可以访问 查阅所有支持 2.0 的主题，并在后台主题管理页面手动安装。 -2. 同上，由于目前评论组件也被插件化，所以如果要体验完整的评论功能，需要手动在后台安装 评论组件插件。 -3. 目前 2.0 已支持的主题和插件会同步到 ，你可以在对应仓库的 release 下载最新的主题或插件。 +1. 由于目前评论组件被插件化且暂不支持提供默认插件，所以如果要体验完整的评论功能，需要手动在后台安装 评论组件插件。 +2. 目前 2.0 已支持的主题和插件会同步到 ，你可以在对应仓库的 release 下载最新的主题或插件。 diff --git a/docs/getting-started/install/docker-compose.md b/docs/getting-started/install/docker-compose.md index e36bbdc..c84b767 100644 --- a/docs/getting-started/install/docker-compose.md +++ b/docs/getting-started/install/docker-compose.md @@ -9,7 +9,7 @@ description: 使用 Docker Compose 部署 ## 创建容器组 -可用的 Halo 2.0.0-beta.2 的 Docker 镜像： +可用的 Halo 2.0.0-rc.1 的 Docker 镜像： - [halohub/halo-dev](https://hub.docker.com/r/halohub/halo-dev) - [ghcr.io/halo-dev/halo-dev](https://github.com/halo-dev/halo/pkgs/container/halo-dev) @@ -43,11 +43,11 @@ description: 使用 Docker Compose 部署 services: halo_next: - image: halohub/halo-dev:2.0.0-beta.2 + image: halohub/halo-dev:2.0.0-rc.1 container_name: halo_next restart: on-failure:3 volumes: - - ./:/root/halo-next + - ./:/root/.halo2 ports: - "8090:8090" environment: @@ -66,7 +66,7 @@ description: 使用 Docker Compose 部署 services: halo_next: - image: halohub/halo-dev:2.0.0-beta.2 + image: halohub/halo-dev:2.0.0-rc.1 container_name: halo_next restart: on-failure:3 depends_on: @@ -75,7 +75,7 @@ description: 使用 Docker Compose 部署 networks: halo_network: volumes: - - ./:/root/halo-next + - ./:/root/.halo2 ports: - "8090:8090" environment: @@ -129,11 +129,10 @@ description: 使用 Docker Compose 部署 ## 使用 -目前 Beta 版本有以下几个使用注意事项： +目前 RC 版本有以下几个使用注意事项： -1. 由于目前尚未完成初始化程序，所以安装完成之后没有默认主题，你可以访问 查阅所有支持 2.0 的主题，并在后台主题管理页面手动安装。 -2. 同上，由于目前评论组件也被插件化，所以如果要体验完整的评论功能，需要手动在后台安装 评论组件插件。 -3. 目前 2.0 已支持的主题和插件会同步到 ，你可以在对应仓库的 release 下载最新的主题或插件。 +1. 由于目前评论组件被插件化且暂不支持提供默认插件，所以如果要体验完整的评论功能，需要手动在后台安装 评论组件插件。 +2. 目前 2.0 已支持的主题和插件会同步到 ，你可以在对应仓库的 release 下载最新的主题或插件。 ## 反向代理 @@ -211,7 +210,7 @@ reverse_proxy 127.0.0.1:8090 ```yaml {3} services: halo_next: - image: halohub/halo-dev:2.0.0-beta.2 + image: halohub/halo-dev:2.0.0-rc.1 container_name: halo_next ``` diff --git a/docs/getting-started/install/docker.md b/docs/getting-started/install/docker.md index a5a9e36..5fde393 100644 --- a/docs/getting-started/install/docker.md +++ b/docs/getting-started/install/docker.md @@ -9,7 +9,7 @@ description: 使用 Docker 部署 ## 使用 Docker 镜像 -可用的 Halo 2.0.0-beta.2 的 Docker 镜像： +可用的 Halo 2.0.0-rc.1 的 Docker 镜像： - [halohub/halo-dev](https://hub.docker.com/r/halohub/halo-dev) - [ghcr.io/halo-dev/halo-dev](https://github.com/halo-dev/halo/pkgs/container/halo-dev) @@ -23,10 +23,10 @@ description: 使用 Docker 部署 -it -d \ --name halo-next \ -p 8090:8090 \ - -v ~/halo-next:/root/halo-next \ + -v ~/.halo2:/root/.halo2 \ -e HALO_EXTERNAL_URL=http://localhost:8090/ \ -e HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD=P@88w0rd \ - halohub/halo-dev:2.0.0-beta.2 + halohub/halo-dev:2.0.0-rc.1 ``` :::info @@ -37,7 +37,7 @@ description: 使用 Docker 部署 - **-d**：后台运行容器 - **--name**：为容器指定一个名称 - **-p**：端口映射，格式为 `主机(宿主)端口:容器端口` ，可在 `application.yaml` 配置。 - - **-v**：工作目录映射。形式为：`-v 宿主机路径:/root/halo-next`，后者不能修改。 + - **-v**：工作目录映射。形式为：`-v 宿主机路径:/root/.halo2`，后者不能修改。 - **-e**：环境变量 - `HALO_EXTERNAL_URL`: 外部可访问的链接。例如： - `HALO_SECURITY_INITIALIZER_SUPERADMINPASSWORD`: 超级管理员用户（admin）的初始化密码。如果该环境变量没有设置，系统将会生成随机密码并打印在日志中。 @@ -50,11 +50,10 @@ description: 使用 Docker 部署 ## 使用 -目前 Beta 版本有以下几个使用注意事项： +目前 RC 版本有以下几个使用注意事项： -1. 由于目前尚未完成初始化程序，所以安装完成之后没有默认主题，你可以访问 查阅所有支持 2.0 的主题，并在后台主题管理页面手动安装。 -2. 同上，由于目前评论组件也被插件化，所以如果要体验完整的评论功能，需要手动在后台安装 评论组件插件。 -3. 目前 2.0 已支持的主题和插件会同步到 ，你可以在对应仓库的 release 下载最新的主题或插件。 +1. 由于目前评论组件被插件化且暂不支持提供默认插件，所以如果要体验完整的评论功能，需要手动在后台安装 评论组件插件。 +2. 目前 2.0 已支持的主题和插件会同步到 ，你可以在对应仓库的 release 下载最新的主题或插件。 ## 反向代理 diff --git a/docs/getting-started/prepare.md b/docs/getting-started/prepare.md index 0e95c58..1abac07 100644 --- a/docs/getting-started/prepare.md +++ b/docs/getting-started/prepare.md @@ -80,7 +80,7 @@ Halo 理论上可以运行在任何支持 Java 的平台。 ### 工作目录 -指 Halo 所依赖的工作目录，在 Halo 运行的时候会在系统当前用户目录下产生一个 `.halo-next` 的文件夹，绝对路径为 `~/.halo-next`。由于这个工作目录是固定的，所以上面所说的 `运行包`不限制所存放的位置，里面通常包含下列目录或文件： +指 Halo 所依赖的工作目录，在 Halo 运行的时候会在系统当前用户目录下产生一个 `.halo2` 的文件夹，绝对路径为 `~/.halo2`。由于这个工作目录是固定的，所以上面所说的 `运行包`不限制所存放的位置，里面通常包含下列目录或文件： 1. `db`：存放 H2 Database 的物理文件，如果你使用其他数据库，那么不会存在这个目录。 2. `themes`：里面包含用户所安装的主题。 diff --git a/docs/intro.md b/docs/intro.md index bceb043..19f1d8a 100644 --- a/docs/intro.md +++ b/docs/intro.md @@ -13,7 +13,7 @@ slug: /

-

Halo [ˈheɪloʊ]，一款现代化的开源博客/CMS系统，值得一试。

+

Halo [ˈheɪloʊ]，好用又强大的开源建站工具。

GitHub release @@ -23,7 +23,7 @@ slug: / GitHub Workflow Status
官网 -文档（2.0 Beta） +文档（2.0 RC） 社区 Gitee Telegram 频道 @@ -33,7 +33,7 @@ slug: / ## 注意 -当前分支为 Halo 2.0 的开发分支，目前 Halo 2.0 处于 Beta 测试阶段，无法从 1.5 直接升级，也不建议在生产环境使用。稳定版本（Halo 1.x）请查阅以下地址： +当前分支为 Halo 2.0 的开发分支，目前 Halo 2.0 处于 RC 阶段，暂时无法从 1.5 直接升级，不建议在生产环境使用。稳定版本（Halo 1.x）请查阅以下地址： - 1.5 分支： - 1.6 分支： @@ -44,7 +44,7 @@ slug: / ### Docker ```bash -docker run -it -d --name halo-next -p 8090:8090 -v ~/halo-next:/root/halo-next --restart=unless-stopped halohub/halo-dev:2.0.0-beta.2 +docker run -it -d --name halo-next -p 8090:8090 -v ~/.halo2:/root/.halo2 --restart=unless-stopped halohub/halo-dev:2.0.0-rc.1 ``` 详细部署文档请查阅：