From b9ac198f1903b275262b9e9b57877d473bd1eac7 Mon Sep 17 00:00:00 2001 From: Baohua Yang Date: Sun, 22 Feb 2026 08:37:51 -0800 Subject: [PATCH] Add number to section names --- 02_basic_concept/2.2_container.md | 2 +- 02_basic_concept/summary.md | 2 +- 04_image/4.7_internal.md | 2 +- 08_data_network/data/summary.md | 2 +- .../{18.1_arch.md => 11.1_arch.md} | 6 +- .../{18.2_namespace.md => 11.2_namespace.md} | 0 .../{18.3_cgroups.md => 11.3_cgroups.md} | 0 .../{18.4_ufs.md => 11.4_ufs.md} | 0 ...ner_format.md => 11.5_container_format.md} | 0 .../{18.6_network.md => 11.6_network.md} | 0 11_implementation/README.md | 12 +- 11_implementation/summary.md | 6 +- 17_security/README.md | 6 +- .../{logs_README.md => summary.md} | 0 SUMMARY.md | 159 +++++++++--------- appendix/20.4_terminology.md | 35 ---- appendix/20.5_editorial_style.md | 27 --- 17 files changed, 98 insertions(+), 161 deletions(-) rename 11_implementation/{18.1_arch.md => 11.1_arch.md} (96%) rename 11_implementation/{18.2_namespace.md => 11.2_namespace.md} (100%) rename 11_implementation/{18.3_cgroups.md => 11.3_cgroups.md} (100%) rename 11_implementation/{18.4_ufs.md => 11.4_ufs.md} (100%) rename 11_implementation/{18.5_container_format.md => 11.5_container_format.md} (100%) rename 11_implementation/{18.6_network.md => 11.6_network.md} (100%) rename 18_observability/{logs_README.md => summary.md} (100%) delete mode 100644 appendix/20.4_terminology.md delete mode 100644 appendix/20.5_editorial_style.md diff --git a/02_basic_concept/2.2_container.md b/02_basic_concept/2.2_container.md index cb87181..cba4edf 100644 --- a/02_basic_concept/2.2_container.md +++ b/02_basic_concept/2.2_container.md @@ -238,4 +238,4 @@ Docker 容器通过以下 Namespace 实现隔离： | **IPC** | 进程间通信 | 独立的信号量、消息队列 | | **USER** | 用户 | 独立的用户和组 ID | -> 想深入了解？请阅读[底层实现 - 命名空间](../11_implementation/18.2_namespace.md)。 +> 想深入了解？请阅读[底层实现 - 命名空间](../11_implementation/11.2_namespace.md)。 diff --git a/02_basic_concept/summary.md b/02_basic_concept/summary.md index 6e4912c..22f8f3b 100644 --- a/02_basic_concept/summary.md +++ b/02_basic_concept/summary.md @@ -16,7 +16,7 @@ - [获取镜像](../04_image/4.1_pull.md)：从 Registry 下载镜像 - [使用 Dockerfile 定制镜像](../04_image/4.5_build.md)：创建自己的镜像 - [Dockerfile 最佳实践](../appendix/20.1_best_practices.md)：构建高质量镜像的技巧 -- [底层实现 - 联合文件系统](../11_implementation/18.4_ufs.md)：深入理解分层存储的技术原理 +- [底层实现 - 联合文件系统](../11_implementation/11.4_ufs.md)：深入理解分层存储的技术原理 | 概念 | 要点 | |------|------| diff --git a/04_image/4.7_internal.md b/04_image/4.7_internal.md index ba790fe..d08a282 100644 --- a/04_image/4.7_internal.md +++ b/04_image/4.7_internal.md @@ -62,4 +62,4 @@ Docker 使用联合文件系统 (Union FS) 来实现这种分层挂载。常见 虽然实现细节不同，但它们都遵循上述的 **分层 + CoW** 模型。 -> 想要深入了解 Overlay2 等文件系统的具体实现原理，包括 WorkDir、UpperDir、LowerDir 等底层细节，请阅读 **[第十一章 底层实现](../11_implementation/README.md)** 中的 **[联合文件系统](../11_implementation/18.4_ufs.md)** 章节。 +> 想要深入了解 Overlay2 等文件系统的具体实现原理，包括 WorkDir、UpperDir、LowerDir 等底层细节，请阅读 **[第十一章 底层实现](../11_implementation/README.md)** 中的 **[联合文件系统](../11_implementation/11.4_ufs.md)** 章节。 diff --git a/08_data_network/data/summary.md b/08_data_network/data/summary.md index 18a001c..d3aa5d2 100644 --- a/08_data_network/data/summary.md +++ b/08_data_network/data/summary.md @@ -29,4 +29,4 @@ - [绑定挂载](bind-mounts.md)：挂载宿主机目录 - [tmpfs 挂载](tmpfs.md)：内存中的临时存储 -- [存储驱动](../../11_implementation/18.4_ufs.md)：Docker 存储的底层原理 +- [存储驱动](../../11_implementation/11.4_ufs.md)：Docker 存储的底层原理 diff --git a/11_implementation/18.1_arch.md b/11_implementation/11.1_arch.md similarity index 96% rename from 11_implementation/18.1_arch.md rename to 11_implementation/11.1_arch.md index 2ccac43..bd49e4b 100644 --- a/11_implementation/18.1_arch.md +++ b/11_implementation/11.1_arch.md @@ -154,6 +154,6 @@ flowchart TD ### 11.1.7 延伸阅读 -- [命名空间](./18.2_namespace.md)：Runc 如何隔离容器 -- [控制组](./18.3_cgroups.md)：Runc 如何限制资源 -- [联合文件系统](./18.4_ufs.md)：镜像如何存储 +- [命名空间](./11.2_namespace.md)：Runc 如何隔离容器 +- [控制组](./11.3_cgroups.md)：Runc 如何限制资源 +- [联合文件系统](./11.4_ufs.md)：镜像如何存储 diff --git a/11_implementation/18.2_namespace.md b/11_implementation/11.2_namespace.md similarity index 100% rename from 11_implementation/18.2_namespace.md rename to 11_implementation/11.2_namespace.md diff --git a/11_implementation/18.3_cgroups.md b/11_implementation/11.3_cgroups.md similarity index 100% rename from 11_implementation/18.3_cgroups.md rename to 11_implementation/11.3_cgroups.md diff --git a/11_implementation/18.4_ufs.md b/11_implementation/11.4_ufs.md similarity index 100% rename from 11_implementation/18.4_ufs.md rename to 11_implementation/11.4_ufs.md diff --git a/11_implementation/18.5_container_format.md b/11_implementation/11.5_container_format.md similarity index 100% rename from 11_implementation/18.5_container_format.md rename to 11_implementation/11.5_container_format.md diff --git a/11_implementation/18.6_network.md b/11_implementation/11.6_network.md similarity index 100% rename from 11_implementation/18.6_network.md rename to 11_implementation/11.6_network.md diff --git a/11_implementation/README.md b/11_implementation/README.md index ad9196d..e676bd9 100644 --- a/11_implementation/README.md +++ b/11_implementation/README.md @@ -12,9 +12,9 @@ Docker 底层的核心技术包括 Linux 上的命名空间 (Namespaces)、控 随着 Linux 系统对于命名空间功能的完善实现，程序员已经可以实现上面的所有需求，让某些进程在彼此隔离的命名空间中运行。大家虽然都共用一个内核和某些运行时环境 (例如一些系统命令和系统库)，但是彼此却看不到，都以为系统中只有自己的存在。这种机制就是容器 (Container)，利用命名空间来做权限的隔离控制，利用 cgroups 来做资源分配。 -* [基本架构](18.1_arch.md) -* [命名空间](18.2_namespace.md) -* [控制组](18.3_cgroups.md) -* [联合文件系统](18.4_ufs.md) -* [容器格式](18.5_container_format.md) -* [网络](18.6_network.md) +* [基本架构](11.1_arch.md) +* [命名空间](11.2_namespace.md) +* [控制组](11.3_cgroups.md) +* [联合文件系统](11.4_ufs.md) +* [容器格式](11.5_container_format.md) +* [网络](11.6_network.md) diff --git a/11_implementation/summary.md b/11_implementation/summary.md index 4011bfc..0dcd77a 100644 --- a/11_implementation/summary.md +++ b/11_implementation/summary.md @@ -13,8 +13,8 @@ ### 11.7.1 延伸阅读 -- [控制组 (Cgroups)](18.3_cgroups.md)：资源限制机制 -- [联合文件系统](18.4_ufs.md)：分层存储的实现 +- [控制组 (Cgroups)](11.3_cgroups.md)：资源限制机制 +- [联合文件系统](11.4_ufs.md)：分层存储的实现 - [安全](../17_security/README.md)：容器安全实践 - [Linux Namespace 官方文档](https://man7.org/linux/man-pages/man7/namespaces.7.html) @@ -28,7 +28,7 @@ ### 11.7.2 延伸阅读 -- [命名空间](18.2_namespace.md)：资源隔离 +- [命名空间](11.2_namespace.md)：资源隔离 - [安全](../17_security/README.md)：容器安全概述 - [Docker Stats](../05_container/README.md)：监控容器资源 diff --git a/17_security/README.md b/17_security/README.md index f0ec9f4..75a6829 100644 --- a/17_security/README.md +++ b/17_security/README.md @@ -43,7 +43,7 @@ flowchart LR | IPC | 进程通信 | 隔离共享内存 | | UTS | 主机名 | 独立主机名 | -详见[命名空间](../../11_implementation/18.2_namespace.md)章节。 +详见[命名空间](../../11_implementation/11.2_namespace.md)章节。 ### 2。控制组 @@ -419,6 +419,6 @@ $ cosign verify --key cosign.pub $IMAGE ## 延伸阅读 -- [命名空间](../../11_implementation/18.2_namespace.md)：隔离机制详解 -- [控制组](../../11_implementation/18.3_cgroups.md)：资源限制详解 +- [命名空间](../../11_implementation/11.2_namespace.md)：隔离机制详解 +- [控制组](../../11_implementation/11.3_cgroups.md)：资源限制详解 - [最佳实践](../../appendix/20.1_best_practices.md)：Dockerfile 安全配置 diff --git a/18_observability/logs_README.md b/18_observability/summary.md similarity index 100% rename from 18_observability/logs_README.md rename to 18_observability/summary.md diff --git a/SUMMARY.md b/SUMMARY.md index c3b1680..2586d7e 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -7,73 +7,73 @@ ## 第一部分：入门篇 * [第一章 Docker 简介](01_introduction/README.md) - * [快速上手](01_introduction/1.1_quickstart.md) - * [什么是 Docker](01_introduction/1.2_what.md) - * [为什么要用 Docker](01_introduction/1.3_why.md) + * [1.1 快速上手](01_introduction/1.1_quickstart.md) + * [1.2 什么是 Docker](01_introduction/1.2_what.md) + * [1.3 为什么要用 Docker](01_introduction/1.3_why.md) * [本章小结](01_introduction/summary.md) -* [第二章基本概念](02_basic_concept/README.md) - * [镜像](02_basic_concept/2.1_image.md) - * [容器](02_basic_concept/2.2_container.md) - * [仓库](02_basic_concept/2.3_repository.md) +* [第二章 基本概念](02_basic_concept/README.md) + * [2.1 镜像](02_basic_concept/2.1_image.md) + * [2.2 容器](02_basic_concept/2.2_container.md) + * [2.3 仓库](02_basic_concept/2.3_repository.md) * [本章小结](02_basic_concept/summary.md) -* [第三章安装 Docker](03_install/README.md) - * [Ubuntu](03_install/3.1_ubuntu.md) - * [Debian](03_install/3.2_debian.md) - * [Fedora](03_install/3.3_fedora.md) - * [CentOS](03_install/3.4_centos.md) - * [Raspberry Pi](03_install/3.5_raspberry-pi.md) - * [Linux 离线安装](03_install/3.6_offline.md) - * [macOS](03_install/3.7_mac.md) - * [Windows 10/11](03_install/3.8_windows.md) - * [镜像加速器](03_install/3.9_mirror.md) - * [开启实验特性](03_install/3.10_experimental.md) -* [第四章使用镜像](04_image/README.md) - * [获取镜像](04_image/4.1_pull.md) - * [列出镜像](04_image/4.2_list.md) - * [删除本地镜像](04_image/4.3_rm.md) - * [利用 commit 理解镜像构成](04_image/4.4_commit.md) - * [使用 Dockerfile 定制镜像](04_image/4.5_build.md) - * [其它制作镜像的方式](04_image/4.6_other.md) - * [实现原理](04_image/4.7_internal.md) +* [第三章 安装 Docker](03_install/README.md) + * [3.1 Ubuntu](03_install/3.1_ubuntu.md) + * [3.2 Debian](03_install/3.2_debian.md) + * [3.3 Fedora](03_install/3.3_fedora.md) + * [3.4 CentOS](03_install/3.4_centos.md) + * [3.5 Raspberry Pi](03_install/3.5_raspberry-pi.md) + * [3.6 Linux 离线安装](03_install/3.6_offline.md) + * [3.7 macOS](03_install/3.7_mac.md) + * [3.8 Windows 10/11](03_install/3.8_windows.md) + * [3.9 镜像加速器](03_install/3.9_mirror.md) + * [3.10 开启实验特性](03_install/3.10_experimental.md) +* [第四章 使用镜像](04_image/README.md) + * [4.1 获取镜像](04_image/4.1_pull.md) + * [4.2 列出镜像](04_image/4.2_list.md) + * [4.3 删除本地镜像](04_image/4.3_rm.md) + * [4.4 利用 commit 理解镜像构成](04_image/4.4_commit.md) + * [4.5 使用 Dockerfile 定制镜像](04_image/4.5_build.md) + * [4.6 其它制作镜像的方式](04_image/4.6_other.md) + * [4.7 实现原理](04_image/4.7_internal.md) * [本章小结](04_image/summary.md) -* [第五章操作容器](05_container/README.md) - * [启动](05_container/5.1_run.md) - * [守护态运行](05_container/5.2_daemon.md) - * [终止](05_container/5.3_stop.md) - * [进入容器](05_container/5.4_attach_exec.md) - * [导出和导入](05_container/5.5_import_export.md) - * [删除](05_container/5.6_rm.md) +* [第五章 操作容器](05_container/README.md) + * [5.1 启动](05_container/5.1_run.md) + * [5.2 守护态运行](05_container/5.2_daemon.md) + * [5.3 终止](05_container/5.3_stop.md) + * [5.4 进入容器](05_container/5.4_attach_exec.md) + * [5.5 导出和导入](05_container/5.5_import_export.md) + * [5.6 删除](05_container/5.6_rm.md) * [本章小结](05_container/summary.md) -* [第六章访问仓库](06_repository/README.md) - * [Docker Hub](06_repository/6.1_dockerhub.md) - * [私有仓库](06_repository/6.2_registry.md) - * [私有仓库高级配置](06_repository/6.3_registry_auth.md) - * [Nexus 3](06_repository/6.4_nexus3_registry.md) +* [第六章 访问仓库](06_repository/README.md) + * [6.1 Docker Hub](06_repository/6.1_dockerhub.md) + * [6.2 私有仓库](06_repository/6.2_registry.md) + * [6.3 私有仓库高级配置](06_repository/6.3_registry_auth.md) + * [6.4 Nexus 3](06_repository/6.4_nexus3_registry.md) * [本章小结](06_repository/summary.md) ## 第二部分：进阶篇 * [第七章 Dockerfile 指令详解](07_dockerfile/README.md) - * [RUN 执行命令](07_dockerfile/7.1_run.md) - * [COPY 复制文件](07_dockerfile/7.2_copy.md) - * [ADD 更高级的复制文件](07_dockerfile/7.3_add.md) - * [CMD 容器启动命令](07_dockerfile/7.4_cmd.md) - * [ENTRYPOINT 入口点](07_dockerfile/7.5_entrypoint.md) - * [ENV 设置环境变量](07_dockerfile/7.6_env.md) - * [ARG 构建参数](07_dockerfile/7.7_arg.md) - * [VOLUME 定义匿名卷](07_dockerfile/7.8_volume.md) - * [EXPOSE 暴露端口](07_dockerfile/7.9_expose.md) - * [WORKDIR 指定工作目录](07_dockerfile/7.10_workdir.md) - * [USER 指定当前用户](07_dockerfile/7.11_user.md) - * [HEALTHCHECK 健康检查](07_dockerfile/7.12_healthcheck.md) - * [ONBUILD 为他人作嫁衣裳](07_dockerfile/7.13_onbuild.md) - * [LABEL 为镜像添加元数据](07_dockerfile/7.14_label.md) - * [SHELL 指令](07_dockerfile/7.15_shell.md) - * [参考文档](07_dockerfile/7.16_references.md) - * [多阶段构建](07_dockerfile/7.17_multistage_builds.md) - * [实战多阶段构建 Laravel 镜像](07_dockerfile/7.18_multistage_builds_laravel.md) + * [7.1 RUN 执行命令](07_dockerfile/7.1_run.md) + * [7.2 COPY 复制文件](07_dockerfile/7.2_copy.md) + * [7.3 ADD 更高级的复制文件](07_dockerfile/7.3_add.md) + * [7.4 CMD 容器启动命令](07_dockerfile/7.4_cmd.md) + * [7.5 ENTRYPOINT 入口点](07_dockerfile/7.5_entrypoint.md) + * [7.6 ENV 设置环境变量](07_dockerfile/7.6_env.md) + * [7.7 ARG 构建参数](07_dockerfile/7.7_arg.md) + * [7.8 VOLUME 定义匿名卷](07_dockerfile/7.8_volume.md) + * [7.9 EXPOSE 暴露端口](07_dockerfile/7.9_expose.md) + * [7.10 WORKDIR 指定工作目录](07_dockerfile/7.10_workdir.md) + * [7.11 USER 指定当前用户](07_dockerfile/7.11_user.md) + * [7.12 HEALTHCHECK 健康检查](07_dockerfile/7.12_healthcheck.md) + * [7.13 ONBUILD 为他人作嫁衣裳](07_dockerfile/7.13_onbuild.md) + * [7.14 LABEL 为镜像添加元数据](07_dockerfile/7.14_label.md) + * [7.15 SHELL 指令](07_dockerfile/7.15_shell.md) + * [7.16 参考文档](07_dockerfile/7.16_references.md) + * [7.17 多阶段构建](07_dockerfile/7.17_multistage_builds.md) + * [7.18 实战多阶段构建 Laravel 镜像](07_dockerfile/7.18_multistage_builds_laravel.md) * [本章小结](07_dockerfile/summary.md) -* [第八章数据与网络管理](08_data_network/README.md) +* [第八章 数据与网络管理](08_data_network/README.md) * [数据管理](08_data_network/data/README.md) * [数据卷](08_data_network/data/volume.md) * [挂载主机目录](08_data_network/data/bind-mounts.md) @@ -84,29 +84,29 @@ * [外部访问容器](08_data_network/network/port_mapping.md) * [本章小结](08_data_network/network/summary.md) * [第九章 Docker Buildx](09_buildx/README.md) - * [BuildKit](09_buildx/9.1_buildkit.md) - * [使用 buildx 构建镜像](09_buildx/9.2_buildx.md) - * [使用 buildx 构建多种系统架构支持的 Docker 镜像](09_buildx/9.3_multi-arch-images.md) + * [9.1 BuildKit](09_buildx/9.1_buildkit.md) + * [9.2 使用 buildx 构建镜像](09_buildx/9.2_buildx.md) + * [9.3 使用 buildx 构建多种系统架构支持的 Docker 镜像](09_buildx/9.3_multi-arch-images.md) * [第十章 Docker Compose](10_compose/README.md) - * [简介](10_compose/10.1_introduction.md) - * [安装与卸载](10_compose/10.2_install.md) - * [使用](10_compose/10.3_usage.md) - * [命令说明](10_compose/10.4_commands.md) - * [Compose 模板文件](10_compose/10.5_compose_file.md) - * [实战 Django](10_compose/10.6_django.md) - * [实战 Rails](10_compose/10.7_rails.md) - * [实战 WordPress](10_compose/10.8_wordpress.md) - * [实战 LNMP](10_compose/10.9_lnmp.md) + * [10.1 简介](10_compose/10.1_introduction.md) + * [10.2 安装与卸载](10_compose/10.2_install.md) + * [10.3 使用](10_compose/10.3_usage.md) + * [10.4 命令说明](10_compose/10.4_commands.md) + * [10.5 Compose 模板文件](10_compose/10.5_compose_file.md) + * [10.6 实战 Django](10_compose/10.6_django.md) + * [10.7 实战 Rails](10_compose/10.7_rails.md) + * [10.8 实战 WordPress](10_compose/10.8_wordpress.md) + * [10.9 实战 LNMP](10_compose/10.9_lnmp.md) ## 第三部分：深入篇 * [第十一章 底层实现](11_implementation/README.md) - * [基本架构](11_implementation/18.1_arch.md) - * [命名空间](11_implementation/18.2_namespace.md) - * [控制组](11_implementation/18.3_cgroups.md) - * [联合文件系统](11_implementation/18.4_ufs.md) - * [容器格式](11_implementation/18.5_container_format.md) - * [网络](11_implementation/18.6_network.md) + * [基本架构](11_implementation/11.1_arch.md) + * [命名空间](11_implementation/11.2_namespace.md) + * [控制组](11_implementation/11.3_cgroups.md) + * [联合文件系统](11_implementation/11.4_ufs.md) + * [容器格式](11_implementation/11.5_container_format.md) + * [网络](11_implementation/11.6_network.md) * [本章小结](11_implementation/summary.md) * [第十二章 容器编排基础](12_kubernetes_concepts/README.md) * [简介](12_kubernetes_concepts/intro.md) @@ -123,7 +123,7 @@ * [一步步部署 Kubernetes 集群](13_kubernetes_setup/systemd.md) * [部署 Dashboard](13_kubernetes_setup/dashboard.md) * [Kubernetes 命令行 kubectl](13_kubernetes_setup/kubectl.md) -* [第十四章 Etcd项目](14_etcd/README.md) +* [第十四章 Etcd 项目](14_etcd/README.md) * [简介](14_etcd/intro.md) * [安装](14_etcd/install.md) * [集群](14_etcd/cluster.md) @@ -152,8 +152,8 @@ * [第十八章 容器监控与日志](18_observability/README.md) * [Prometheus](18_observability/prometheus.md) * [ELK 套件](18_observability/elk.md) - * [小结](18_observability/logs_README.md) -* [第十九章实战案例](19_cases/README.md) + * [小结](18_observability/summary.md) +* [第十九章 实战案例](19_cases/README.md) * [实战案例 - 操作系统](19_cases/os/README.md) * [Busybox](19_cases/os/busybox.md) * [Alpine](19_cases/os/alpine.md) @@ -191,5 +191,4 @@ * [附录四：Dockerfile 最佳实践](appendix/20.1_best_practices.md) * [附录五：如何调试 Docker](appendix/20.2_debug.md) * [附录六：资源链接](appendix/20.3_resources.md) - * [附录七：术语词表 (出版统一版)](appendix/20.4_terminology.md) - * [附录八：出版清稿规范 (图号与章节风格)](appendix/20.5_editorial_style.md) + diff --git a/appendix/20.4_terminology.md b/appendix/20.4_terminology.md deleted file mode 100644 index 5dd7796..0000000 --- a/appendix/20.4_terminology.md +++ /dev/null @@ -1,35 +0,0 @@ -## 术语词表 (出版统一版) - -本词表用于统一全书术语、缩写和命令表达，适用于最终出版前清稿。 - -### 核心术语统一表 - -相关信息如下表： - -| 统一写法 (推荐)| 可接受写法 | 避免写法 | 说明 | -|---|---|---|---| -| Docker Engine | Docker 引擎 | docker engine | 产品名首字母大写。 | -| Docker Desktop | - | docker desktop | 产品名首字母大写。 | -| Dockerfile | - | Docker File、dockerfile | 固定拼写。 | -| Docker 镜像 (Image)| 镜像 | image (纯英文散落)| 首次出现建议中英文并列。 | -| Docker 容器 (Container)| 容器 | container (纯英文散落)| 与镜像区分清楚。 | -| 仓库 (Repository)| Repo (非正式)| 镜像仓库/Repository 混用不解释 | 首次出现需给出英文。 | -| 注册服务器 (Registry)| 镜像注册服务 | 私有仓库/Registry 混指 | Registry 与 Repository 需区分。 | -| 标签 (Tag)| 版本标签 | tag (正文中小写裸写)| 命令中保留原样。 | -| Docker Compose | Compose | docker compose (当作产品名)| 产品名用 `Docker Compose`。 | -| `docker compose` | - | `docker-compose` (新示例中)| 命令统一使用 V2 子命令写法。 | -| `compose.yaml` | `compose.yml` | 新示例继续使用 `docker-compose.yml` | 教学默认文件名统一为 `compose.yaml`。 | -| Kubernetes | K8s (缩写)| kubernetes (正文)| 正文统一首字母大写。 | -| `kubectl` | - | kubeclt (拼写错误)| 命令与二进制名用反引号包裹。 | -| etcd | - | Etcd (混用)| 项目官方写法为小写 `etcd`。 | -| Docker Buildx | Buildx | buildx (正文裸写)| 产品名用 `Docker Buildx`。 | -| BuildKit | - | buildkit | 固定大小写。 | -| 控制平面 (Control Plane)| - | 主控平面 (未定义)| 章节内保持单一译名。 | -| 工作节点 (Worker Node)| 节点 (在上下文明确时)| 工作机器 (未定义)| 与控制平面对照使用。 | - -### 清稿执行规则 - -1. 术语首次出现采用 “中文 (英文)” 格式，例如 “注册服务器 (Registry)”。 -2. 命令、文件名、配置键统一使用反引号包裹。 -3. 同一章节中，术语只保留一种主写法，不混用同义词。 -4. 若引用历史名词 (如 `docker-compose.yml`)，需显式标注 “历史文件名”。 diff --git a/appendix/20.5_editorial_style.md b/appendix/20.5_editorial_style.md deleted file mode 100644 index 8fde56b..0000000 --- a/appendix/20.5_editorial_style.md +++ /dev/null @@ -1,27 +0,0 @@ -## 出版清稿规范 (图号与章节风格) - -本规范用于最终出版前清稿，确保全书图号、图题、章节结构与行文风格一致。 - -### 图号与图题规范 - -1. 图号格式统一为：`图 <章号>-<序号> <图题>`，例如 `图 10-2 Rails + PostgreSQL 的 Compose 架构`。 -2. 图号在同一章内按出现顺序连续编号，不重复、不跳号。 -3. 正文引用图片统一写法：`如图 <章号>-<序号> 所示`，不使用 “下图/上图/示意图如下”。 -4. 所有图片必须提供有意义的 alt 文本，不使用空 alt (`![图](...)`)。 -5. 图题单独成行，放在图片下方。 - -### 章节风格规范 - -1. 小节标题统一使用编号体例：`## 10.6 ...`、`### 步骤 1：...`。 -2. 步骤型内容统一使用 “步骤 N：” 中文格式，不使用 `Step N:`。 -3. 命令行示例统一以 `bash` 代码块展示，提示符统一为 `$`。 -4. 关键提醒统一使用引用块 (`> 注意/提示/警告`)，避免正文中混杂多种强调样式。 -5. 章节内术语使用需遵循《[术语词表 (出版统一版)](20.4_terminology.md)》。 - -### 出版前自检清单 - -1. 是否仍存在 “下图/上图/示意图如下” 等相对指代。 -2. 是否存在未编号或编号冲突的图题。 -3. 是否存在 `kubernetes`、`compose` 等正文大小写不统一写法。 -4. 是否存在 `Step N:` 与 “步骤 N：” 混用。 -5. 是否存在未加反引号的命令、文件名和配置键名。