delete unreachable links

servicemesher · May 16, 2018 · 917c5ae · 917c5ae
1 parent 1e333f4
commit 917c5ae
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 21 deletions.
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -1,28 +1,33 @@
-# 翻译规范
+# 规范
 
-本文中指定了该文档的翻译规范。
+本文中指定了该文档的翻译规范与注意事项。
 
 翻译进度可以通过 [Project](https://github.com/servicemesher/envoy/projects/1) 查看。
 
 ## 文档组织规则
 
-- 所有文档使用 markdown 格式撰写
-- 文档目录严格按照英文官方文档组织
-- 所有图片都放在最顶层的 `images` 目录下
-- API 参考章节直接链接到英文文档
-
-## 文档规范
-
-- 所有的英文跟中文之间要有一个空格
+- 所有文档使用 markdown 格式撰写。
+- 文档目录严格按照英文官方文档组织。
+- 所有图片都放在最顶层的 `images` 目录下。
+- API 参考章节直接链接到英文文档。
 
 ## 翻译流程
 
 1. 首先加入到 ServiceMesher 组织中，请联系 [Jimmy Song](https://jimmysong.io/about) 加入。
-2. 在 [Issues](https://github.com/servicemesher/envoy/issues) 中找到你想翻译的文档的标题（对应的文档路径即为标题），在 issue 中回复“认领”，并将该 issue 指派给自己。
+2. 在 [Issues](https://github.com/servicemesher/envoy/issues) 中找到你想翻译的文档的标题（对应的文档路径即为标题），在 issue 中回复“认领”，确认不要与他人认领的重复。
 3. 创建一个翻译分支，翻译完成后提交 PR。
 4. 由 owner 审核后 merge 进 master 分支。
 
-### 专有名词
+## 注意事项
+
+- 一次性不要认领太多文章，最多不要超过三篇，如果一周内没有提交则取消指派，可以由其他人翻译。
+- 文中有些地方的链接可能无法到达，尤其是指向 API v1 和 API v2 参考文档的链接，因为代码库中没有加入这部分文档，所有当遇到这种情况时请直接使用官方文档上可抵达的互联网链接。
+
+## 翻译规范
+
+- 所有的英文跟中文之间要有一个空格
+
+## 专有名词
 
 下面的词汇作为专有名词，不需要翻译。
 

diff --git a/about_docs.md b/about_docs.md
@@ -2,12 +2,12 @@
 
 Envoy 文档由以下几个主要部分组成：
 
-- [简介](intro/intro.md#intro)：本部分介绍 Envoy 的概况、体系结构概述、典型部署方式等。
-- [入门](start/start.md#start)：使用 Docker 快速开始使用 Envoy。
-- [安装](install/install.md#install)：如何使用 Docker 构建/安装 Envoy。
-- [配置](configuration/configuration.md#config)：遗留 v1 API 和新 v2 API 共同的详细配置指令。相关时，配置指南还包含有关统计信息、运行时配置和 API 的信息。
-- [操作](operations/operations.md#operations)：有关如何操作 Envoy 的常规信息，包括命令行界面、热重启包装器、管理界面、常规统计概览等。
-- [扩展 Envoy](extending/extending.md#extending)：有关如何为 Envoy 编写自定义过滤器的信息。
-- [v1 API 参考](https://www.envoyproxy.io/docs/envoy/latest/api-v1/api)：特定于遗留 v1 API 的配置详细信息。
-- [v2 API 参考](https://www.envoyproxy.io/docs/envoy/latest/api-v2/api)：特定于新 v2 API 的配置细节。
-- [Envoy 常见问题](faq/overview.md#faq-overview)：有疑问？希望我们的答案能让您满意。
+- 简介：本部分介绍 Envoy 的概况、体系结构概述、典型部署方式等。
+- 入门：使用 Docker 快速开始使用 Envoy。
+- 安装：如何使用 Docker 构建/安装 Envoy。
+- 配置：遗留 v1 API 和新 v2 API 共同的详细配置指令。相关时，配置指南还包含有关统计信息、运行时配置和 API 的信息。
+- 操作：有关如何操作 Envoy 的常规信息，包括命令行界面、热重启包装器、管理界面、常规统计概览等。
+- 扩展 Envoy：有关如何为 Envoy 编写自定义过滤器的信息。
+- v1 API 参考：特定于遗留 v1 API 的配置详细信息。
+- v2 API 参考：特定于新 v2 API 的配置细节。
+- Envoy 常见问题：有疑问？希望我们的答案能让您满意。