dockerfile-fedora-documentation 镜像文档

镜像概述

本镜像为基于Fedora的Docker镜像，专门用于创建"容器最佳实践"（Containers Best Practices）指南的文档。其核心功能是处理asciidoc格式的文档源文件，生成PDF和HTML格式的文档输出，支持文档构建与清理操作。

核心功能与特性

• 文档格式处理：支持解析asciidoc格式文档（如labs.adoc），生成标准化的PDF（labs.pdf）和HTML（labs.html）输出
• 构建与清理支持：集成make命令用于文档构建，make clean命令用于清理已生成的文档文件
• 目录挂载：通过Docker卷（volume）挂载本地文档目录，实现本地文档与容器的实时交互
• 轻量高效：基于Fedora系统，仅包含文档处理所需依赖，确保资源占用优化

使用场景与适用范围

• 为"容器最佳实践"指南（projectatomic/container-best-practices）生成或更新文档
• 技术文档撰写者需要将asciidoc格式源文件转换为PDF/HTML格式
• 开发团队或个人需要自动化构建、清理asciidoc文档的场景

使用方法与配置说明

前置要求

• 已安装Docker引擎（可通过docker version命令验证Docker版本）
• 本地克隆"容器最佳实践"文档仓库

步骤1：克隆文档仓库

git clone [***]
cd container-best-practices

步骤2：构建镜像

将Dockerfile源文件复制到本地后，执行以下命令构建镜像：

sudo docker build -t fedora/container-best-practices .

步骤3：运行容器

3.1 构建文档（生成PDF和HTML）

通过make命令构建文档，需将本地克隆的仓库目录挂载到容器的/workdir目录：

docker run --privileged -v /本地仓库路径/container-best-practices:/workdir -dt fedora/docs make

参数说明：

• --privileged：赋予容器特权模式，确保文件系统操作权限
• -v /本地仓库路径/container-best-practices:/workdir：将本地文档目录挂载到容器内的/workdir工作目录（需将/本地仓库路径替换为实际克隆路径，如/home/user/git/container-best-practices）
• -dt：后台运行容器并分配伪终端
• fedora/docs：镜像名称（与构建时的fedora/container-best-practices可能存在命名差异，以实际构建结果为准）
• make：执行文档构建命令

构建成功验证：在本地仓库目录下会生成labs.pdf和labs.html文件：

ls
# 预期输出：content  docker  labs.adoc  labs.fo  labs.html  labs.pdf  labs.xml  Makefile  README.adoc  README.md  scripts

3.2 清理文档（删除已生成文件）

通过make clean命令清理已生成的文档文件，释放目录空间：

docker run --privileged -v /本地仓库路径/container-best-practices:/workdir -dt fedora/docs make clean

清理成功验证：本地仓库目录中的labs.pdf、labs.html等生成文件将被删除：

ls
# 预期输出：content  docker  labs.adoc  Makefile  README.adoc  README.md  scripts

Docker部署示例

构建镜像

# 克隆仓库（若未克隆）
git clone [***]
cd container-best-practices

# 构建Docker镜像
sudo docker build -t fedora/container-best-practices .

构建文档示例

# 挂载本地仓库目录并执行构建
docker run --privileged -v /home/user/git/container-best-practices:/workdir -dt fedora/docs make

# 查看生成的文档文件
ls /home/user/git/container-best-practices
# 输出应包含：labs.pdf  labs.html

清理文档示例

# 挂载本地仓库目录并执行清理
docker run --privileged -v /home/user/git/container-best-practices:/workdir -dt fedora/docs make clean

# 确认生成文件已删除
ls /home/user/git/container-best-practices
# 输出不应包含：labs.pdf  labs.html