Skip to content

Commit e2d9910

Browse files
authored
Merge pull request #310 from jimcat8/main
Chinese translation of the new document rockDocs_web_dev.zh.md
2 parents f426e27 + 4a7e802 commit e2d9910

File tree

1 file changed

+102
-0
lines changed

1 file changed

+102
-0
lines changed
Lines changed: 102 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
---
2+
title: 运行文档的本地副本
3+
contributors: tianci li
4+
date: 2021-10-19
5+
---
6+
7+
# 为Web开发和内容作者运行docs.rockylinux.org网站的本地副本
8+
9+
本文档介绍了如何在本地计算机上重新创建且运行整个docs.rockylinux.org网站的本地副本。**这是一项正在进行中的工作。**
10+
11+
在以下情况下,运行文档网站的本地副本可能很有用:
12+
13+
* 您有兴趣了解docs.rockylinux.org网站的Web开发方面并为其做出贡献
14+
* 您是一名作者,在贡献文档之前,您希望查看文档在Docs网站上的外观呈现
15+
* 您是一名Web开发人员,希望贡献或帮助维护docs.rockylinux.org网站
16+
17+
18+
### 一些注意事项:
19+
20+
* 本指南中的说明**不是**Rocky文档作者或内容贡献者的必备条件
21+
* 整个环境在Docker容器中运行,因此您需要在本地计算机上安装Docker引擎
22+
* 该容器构建在官方的RockyLinux docker镜像之上,可从 https://hub.docker.com/r/rockylinux/rockylinux 获得
23+
* 容器将文档内容(guides、books、images等)与Web引擎(Mkdocs)分开
24+
* 容器会启动一个监听端口为8000的本地Web服务器,而8000端口将被转发到Docker主机上
25+
26+
27+
## 创建内容环境
28+
29+
1. 将你本地系统中的当前工作目录改为你打算进行写作的文件夹,本指南的其余部分中,我们将该目录称为`$ROCKYDOCS`。在我们这里的演示中,`$ROCKYDOCS`指向我们演示系统上的`~/jects/rockydocs`
30+
31+
如果$ROCKYDOCS尚不存在,请创建它,然后键入:
32+
33+
```
34+
cd $ROCKYDOCS
35+
```
36+
37+
2. 请确保您已经安装了`git`(`dnf-y install git`)。在 $ROCKYDOCS 中,使用git克隆官方Rocky文档内容存储库(git repository)。
38+
```
39+
git clone https://github.com/rocky-linux/documentation.git
40+
```
41+
42+
现在您将拥有一个`$ROCKYDOCS/Docentation`文件夹。该文件夹是一个git存储库(git repository),由git进行控制。
43+
44+
45+
## 创建并启动RockyDocs的Web开发环境
46+
47+
3. 确保你的本地机器已经启动并运行了Docker(你可以用`systemctl`检查)
48+
49+
4. 从终端中执行以下操作:
50+
51+
```
52+
docker pull wsoyinka/rockydocs:latest
53+
```
54+
55+
5. 检查以确保镜像下载成功
56+
57+
```
58+
docker image ls
59+
```
60+
61+
## 启动RockyDocs容器
62+
63+
1. 从rockydocs的镜像中启动一个容器。
64+
65+
```
66+
docker run -it --name rockydoc --rm \
67+
-p 8000:8000 \
68+
--mount type=bind,source="$(pwd)"/documentation,target=/documentation \
69+
wsoyinka/rockydocs:latest
70+
71+
```
72+
73+
74+
或者,如果您愿意并且安装了`docker-compose`,您也可以创建名为`docker-compose.yml`的撰写文件,内容如下:
75+
76+
```
77+
version: "3.9"
78+
services:
79+
rockydocs:
80+
image: wsoyinka/rockydocs:latest
81+
volumes:
82+
- type: bind
83+
source: ./documentation
84+
target: /documentation
85+
container_name: rocky
86+
ports:
87+
- "8000:8000"
88+
89+
```
90+
91+
将文件名为`docker-compose.yml`保存在$ROCKYDOCS工作目录中,并通过运行以下命令启动服务/容器:
92+
93+
```
94+
docker-compose up
95+
```
96+
97+
98+
## 浏览本地的docs.rockylinux.org网站
99+
100+
容器启动且运行后,您现在应该可以将Web浏览器指向以下URL,以查看站点的本地副本:
101+
102+
http://localhost:8000

0 commit comments

Comments
 (0)