在本地运行 docs.rockylinux.org 网站的副本以进行 Web 开发和/或内容作者¶

本文档介绍了如何在本地机器上重新创建和运行 docs.rockylinux.org 网站的完整副本。它正在开发中。

在以下情况下，运行文档网站的本地副本可能很有用

您有兴趣了解和参与 docs.rockylinux.org 网站的 Web 开发方面
您是一位作者，并且希望在贡献文档之前查看您的文档在文档网站上的渲染/外观
您是一位 Web 开发人员，希望为 docs.rockylinux.org 网站做出贡献或帮助维护它

一些注意事项¶

本指南中的说明不是 Rocky 文档作者/内容贡献者的先决条件
整个环境在 Docker 容器中运行，因此您需要在本地机器上安装 Docker 引擎
该容器基于这里提供的官方 RockyLinux docker 镜像 https://hub.docker.com/r/rockylinux/rockylinux
该容器将文档内容（指南、书籍、图像等）与 Web 引擎（mkdocs）分开
该容器启动一个本地 Web 服务器，监听端口 8000。端口 8000 将被转发到 Docker 主机

创建内容环境¶

将本地系统上的当前工作目录更改为打算进行写作的文件夹。在本指南的其余部分中，我们将此目录称为$ROCKYDOCS。在我们的演示中，$ROCKYDOCS 指向我们演示系统上的~/projects/rockydocs。
如果$ROCKYDOCS 不存在，请创建它，然后输入
```
cd  $ROCKYDOCS
```
确保已安装git（dnf -y install git）。在$ROCKYDOCS 中，使用 git 克隆官方 Rocky 文档内容仓库。输入
```
git clone https://github.com/rocky-linux/documentation.git
```

现在，您将拥有一个$ROCKYDOCS/documentation 文件夹。此文件夹是一个 git 仓库，并且处于 git 的控制之下。

创建和启动 RockyDocs Web 开发环境¶

确保您的本地机器上已启动并运行 Docker（您可以使用systemctl 检查）。
从终端输入
```
docker pull wsoyinka/rockydocs:latest
```
检查以确保镜像已成功下载。输入
```
docker image  ls
```

启动 RockyDocs 容器¶

从 rockydocs 镜像启动一个容器。输入

docker run -it --name rockydoc --rm \
    -p 8000:8000  \
    --mount type=bind,source="$(pwd)"/documentation,target=/documentation  \
    wsoyinka/rockydocs:latest

或者，如果您愿意，并且已安装docker-compose，则可以创建名为docker-compose.yml 的组合文件，其内容如下

version: "3.9"
services:
  rockydocs:
    image: wsoyinka/rockydocs:latest
    volumes:
      - type: bind
        source: ./documentation
        target: /documentation
    container_name: rocky
    ports:
      - "8000:8000"

将该文件保存为docker-compose.yml，并将其放置在您的$ROCKYDOCS 工作目录中。通过运行以下命令启动服务/容器

docker-compose  up

查看本地 docs.rockylinux.org 网站¶

容器启动并运行后，您现在应该能够将 Web 浏览器指向以下 URL 来查看您的本地网站副本

http://localhost:8000

作者：Wale Soyinka

贡献者：Steve Spencer、Ganna Zhyrnova