diff --git a/content/zh/docs/doc-contributor-tools/README.md b/content/zh/docs/doc-contributor-tools/README.md deleted file mode 100644 index fe0e37a2c7..0000000000 --- a/content/zh/docs/doc-contributor-tools/README.md +++ /dev/null @@ -1,7 +0,0 @@ -Kubernetes 文档贡献者的工具。 查看子目录内的 `README.md` 文件以获取更多信息。 - - - diff --git a/content/zh/docs/doc-contributor-tools/snippets/README.md b/content/zh/docs/doc-contributor-tools/snippets/README.md deleted file mode 100644 index 4058cbd4b6..0000000000 --- a/content/zh/docs/doc-contributor-tools/snippets/README.md +++ /dev/null @@ -1,84 +0,0 @@ - -# Atom 的代码段 - - - -代码段就是可以插入到编辑器中的一段文本,可以节省键入时间,减少语法错误。 -`atom-snippets.cson` 文件中所提供的代码段只用于在 Atom 中的 Markdown 文件。 - - -## 安装 - - - -将 `atom-snippets.cson` 文件中的内容复制到现有的`~/.atom/snippets.cson` 之中。 -**不要替换现有的文件。** - - -不需要重启 Atom。 - - -## 使用 - - - -浏览一遍 `atom-snippets.cson` 文件,记下代码段的标题和 `prefix`。 - - - -你可以使用以下任意一种方式来触发相应的代码段: -- 键入代码段的`prefix`,按下 `` 键 -- 在 **Packages / Snippets / Available** 中搜索代码段的标题 - - - -例如,打开一个 Markdown 文件,键入 `anote`,按下 ``。 -就会插入一段带有正确的 Hugo 短代码的空注释。 - - - -代码段可以插入一行或多行文本。一些代码行都设有预留值。想要切换到下一个预留值,再按一次`` 键即可。 - - - -一些代码段只会插入部分格式的 Markdown 或 Hugo 语法。 -例如,`coverview` 只会插入一个概念概览的开始标签,而`cclose`则会插入一个结束标签。 -这是因为每类 capture 都需要一个 capture-close 标签。 - - -## 使用代码段创建新的话题 - - -从空白文件中,创建一个新的概念,任务或者教程,使用以下的代码段: - -- `newconcept` -- `newtask` -- `newtutorial` - - -预设文本包含其中。 - - -## 提交新的代码段 - - - -1. 本地开发代码段,验证是否有效。 -2. 将代码单复制到 Github 的 `atom-snippets.cson` 文件中。 -提交 pull request,邀请 Kubernetes Slack `#sig-docs` 中的另外一名 Atom 用户进行审查。 diff --git a/content/zh/docs/doc-contributor-tools/snippets/atom-snippets.cson b/content/zh/docs/doc-contributor-tools/snippets/atom-snippets.cson deleted file mode 100644 index 878ccc4ed7..0000000000 --- a/content/zh/docs/doc-contributor-tools/snippets/atom-snippets.cson +++ /dev/null @@ -1,226 +0,0 @@ -# Your snippets -# -# Atom snippets allow you to enter a simple prefix in the editor and hit tab to -# expand the prefix into a larger code block with templated values. -# -# You can create a new snippet in this file by typing "snip" and then hitting -# tab. -# -# An example CoffeeScript snippet to expand log to console.log: -# -# '.source.coffee': -# 'Console log': -# 'prefix': 'log' -# 'body': 'console.log $1' -# -# Each scope (e.g. '.source.coffee' above) can only be declared once. -# -# This file uses CoffeeScript Object Notation (CSON). -# If you are unfamiliar with CSON, you can read more about it in the -# Atom Flight Manual: -# http://flight-manual.atom.io/using-atom/sections/basic-customization/#_cson - -'.source.gfm': - - # Capture variables for concept template - # For full concept template see 'newconcept' below - 'Insert concept template': - 'prefix': 'ctemplate' - 'body': 'content_template: templates/concept' - 'Insert concept overview': - 'prefix': 'coverview' - 'body': '{{% capture overview %}}' - 'Insert concept body': - 'prefix': 'cbody' - 'body': '{{% capture body %}}' - 'Insert concept whatsnext': - 'prefix': 'cnext' - 'body': '{{% capture whatsnext %}}' - - - # Capture variables for task template - # For full task template see 'newtask' below - 'Insert task template': - 'prefix': 'ttemplate' - 'body': 'content_template: templates/task' - 'Insert task overview': - 'prefix': 'toverview' - 'body': '{{% capture overview %}}' - 'Insert task prerequisites': - 'prefix': 'tprereq' - 'body': """ - {{% capture prerequisites %}} - - {{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} - - {{% /capture %}} - """ - 'Insert task steps': - 'prefix': 'tsteps' - 'body': '{{% capture steps %}}' - 'Insert task discussion': - 'prefix': 'tdiscuss' - 'body': '{{% capture discussion %}}' - - - # Capture variables for tutorial template - # For full tutorial template see 'newtutorial' below - 'Insert tutorial template': - 'prefix': 'tutemplate' - 'body': 'content_template: templates/tutorial' - 'Insert tutorial overview': - 'prefix': 'tuoverview' - 'body': '{{% capture overview %}}' - 'Insert tutorial prerequisites': - 'prefix': 'tuprereq' - 'body': '{{% capture prerequisites %}}' - 'Insert tutorial objectives': - 'prefix': 'tuobjectives' - 'body': '{{% capture objectives %}}' - 'Insert tutorial lesson content': - 'prefix': 'tulesson' - 'body': '{{% capture lessoncontent %}}' - 'Insert tutorial whatsnext': - 'prefix': 'tunext' - 'body': '{{% capture whatsnext %}}' - 'Close capture': - 'prefix': 'ccapture' - 'body': '{{% /capture %}}' - 'Insert note': - 'prefix': 'anote' - 'body': """ - {{< note >}} - $1 - {{< /note >}} - """ - - # Admonitions - 'Insert caution': - 'prefix': 'acaution' - 'body': """ - {{< caution >}} - $1 - {{< /caution >}} - """ - 'Insert warning': - 'prefix': 'awarning' - 'body': """ - {{< warning >}} - $1 - {{< /warning >}} - """ - - # Misc one-liners - 'Insert TOC': - 'prefix': 'toc' - 'body': '{{< toc >}}' - 'Insert code from file': - 'prefix': 'codefile' - 'body': '{{< codenew file="$1" >}}' - 'Insert feature state': - 'prefix': 'fstate' - 'body': '{{< feature-state for_k8s_version="$1" state="$2" >}}' - 'Insert figure': - 'prefix': 'fig' - 'body': '{{< figure src="$1" title="$2" alt="$3" caption="$4" >}}' - 'Insert Youtube link': - 'prefix': 'yt' - 'body': '{{< youtube $1 >}}' - - - # Full concept template - 'Create new concept': - 'prefix': 'newconcept' - 'body': """ - --- - reviewers: - - ${1:"github-id-or-group"} - title: ${2:"topic-title"} - content_template: templates/concept - --- - {{% capture overview %}} - ${3:"overview-content"} - {{% /capture %}} - - {{< toc >}} - - {{% capture body %}} - ${4:"h2-heading-per-subtopic"} - {{% /capture %}} - - {{% capture whatsnext %}} - ${5:"next-steps-or-delete"} - {{% /capture %}} - """ - - - # Full task template - 'Create new task': - 'prefix': 'newtask' - 'body': """ - --- - reviewers: - - ${1:"github-id-or-group"} - title: ${2:"topic-title"} - content_template: templates/task - --- - {{% capture overview %}} - ${3:"overview-content"} - {{% /capture %}} - - {{< toc >}} - - {{% capture prerequisites %}} - - {{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} - - ${4:"additional-prereqs-or-delete"} - - {{% /capture %}} - - {{% capture steps %}} - ${5:"h2-heading-per-step"} - {{% /capture %}} - - {{% capture discussion %}} - ${6:"task-discussion-or-delete"} - {{% /capture %}} - """ - - # Full tutorial template - 'Create new tutorial': - 'prefix': 'newtutorial' - 'body': """ - --- - reviewers: - - ${1:"github-id-or-group"} - title: ${2:"topic-title"} - content_template: templates/tutorial - --- - {{% capture overview %}} - ${3:"overview-content"} - {{% /capture %}} - - {{< toc >}} - - {{% capture prerequisites %}} - - {{< include "task-tutorial-prereqs.md" >}} {{< version-check >}} - - ${4:"additional-prereqs-or-delete"} - - {{% /capture %}} - - {{% capture objectives %}} - ${5:"tutorial-objectives"} - {{% /capture %}} - - {{% capture lessoncontent %}} - ${6:"lesson-content"} - {{% /capture %}} - - {{% capture whatsnext %}} - ${7:"next-steps-or-delete"} - {{% /capture %}} - """ -