跳至内容

为网站开发和/或内容作者运行 docs.rockylinux.org 网站的本地副本

本文档将指导您如何在本地计算机上重新创建和运行 docs.rockylinux.org 网站的完整本地副本。此文档仍在进行中。

在以下场景中运行文档网站的本地副本可能很有用

  • 您有兴趣了解并为 docs.rockylinux.org 网站的网站开发方面做出贡献
  • 您是一名作者,并希望在贡献文档之前查看您的文档在 docs 网站上的渲染/外观
  • 您是一名网站开发者,希望为 docs.rockylinux.org 网站做出贡献或协助维护

一些说明

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

创建内容环境

  1. 将本地系统的当前工作目录更改为您打算编写内容的文件夹。在本指南的其余部分,我们将此目录称为 $ROCKYDOCS。在本演示中,$ROCKYDOCS 指向我们演示系统上的 ~/projects/rockydocs

    如果 $ROCKYDOCS 不存在,请创建它,然后输入

    cd  $ROCKYDOCS
    
  2. 确保您已安装 git (dnf -y install git)。在 $ROCKYDOCS 中,使用 git 克隆官方 Rocky Documentation 内容仓库。输入

    git clone https://github.com/rocky-linux/documentation.git
    

您现在将拥有一个 $ROCKYDOCS/documentation 文件夹。此文件夹是一个 git 仓库,受 git 控制。

创建并启动 RockyDocs 网站开发环境

  1. 请确保您的本地计算机上已启动并运行 Docker(您可以使用 systemctl 进行检查)

  2. 在终端中输入

    docker pull wsoyinka/rockydocs:latest
    
  3. 检查以确保镜像已成功下载。输入

    docker image  ls
    

启动 RockyDocs 容器

  1. 从 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,以查看您本地网站的副本

https://:8000

作者:Wale Soyinka

贡献者:Steve Spencer, Ganna Zhyrnova