From f3d0214130b6acca723fe632eba94197a05717e3 Mon Sep 17 00:00:00 2001 From: Tiexin Guo Date: Tue, 29 Nov 2022 10:57:51 +0800 Subject: [PATCH 1/2] docs: fix architecture doc link Signed-off-by: Tiexin Guo --- docs/development/{devstream => }/architecture.md | 0 docs/development/{devstream => }/architecture.zh.md | 0 docs/development/{devstream => }/project-layout.md | 0 docs/development/{devstream => }/project-layout.zh.md | 0 mkdocs.yml | 5 ++--- 5 files changed, 2 insertions(+), 3 deletions(-) rename docs/development/{devstream => }/architecture.md (100%) rename docs/development/{devstream => }/architecture.zh.md (100%) rename docs/development/{devstream => }/project-layout.md (100%) rename docs/development/{devstream => }/project-layout.zh.md (100%) diff --git a/docs/development/devstream/architecture.md b/docs/development/architecture.md similarity index 100% rename from docs/development/devstream/architecture.md rename to docs/development/architecture.md diff --git a/docs/development/devstream/architecture.zh.md b/docs/development/architecture.zh.md similarity index 100% rename from docs/development/devstream/architecture.zh.md rename to docs/development/architecture.zh.md diff --git a/docs/development/devstream/project-layout.md b/docs/development/project-layout.md similarity index 100% rename from docs/development/devstream/project-layout.md rename to docs/development/project-layout.md diff --git a/docs/development/devstream/project-layout.zh.md b/docs/development/project-layout.zh.md similarity index 100% rename from docs/development/devstream/project-layout.zh.md rename to docs/development/project-layout.zh.md diff --git a/mkdocs.yml b/mkdocs.yml index ea746515c..002d9f9dd 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -130,9 +130,8 @@ nav: - development/git-workflow/commit-messages*.md - development/git-workflow/branch-and-release*.md - development/git-workflow/reviewing*.md - - DevStream Architecture: - - development/devstream/architecture*.md - - development/devstream/project-layout*.md + - development/architecture*.md + - development/project-layout*.md - Environment Setup and Development: - development/dev/dev-env-setup*.md - development/dev/lint*.md From e9710f37cda5e23f18266acf5ba0bd43360bc303 Mon Sep 17 00:00:00 2001 From: Tiexin Guo Date: Tue, 29 Nov 2022 11:02:15 +0800 Subject: [PATCH 2/2] chore: fix broken links Signed-off-by: Tiexin Guo --- docs/contributing_guide.md | 4 ++-- docs/contributing_guide.zh.md | 4 ++-- docs/development/architecture.md | 2 +- docs/development/architecture.zh.md | 2 +- docs/development/dev/creating-a-plugin.md | 2 +- docs/development/dev/creating-a-plugin.zh.md | 2 +- 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/contributing_guide.md b/docs/contributing_guide.md index 915b854a5..f7b70bfa5 100644 --- a/docs/contributing_guide.md +++ b/docs/contributing_guide.md @@ -85,8 +85,8 @@ For more documentation on GitHub collaboration, see the [GitHub Collaboration Pr ## DevStream Architecture -- [Architecture Overall](development/devstream/architecture.md) -- [Project Layout](development/devstream/project-layout.md) +- [Architecture Overall](development/architecture.md) +- [Project Layout](development/project-layout.md) ## Documentation Contribution diff --git a/docs/contributing_guide.zh.md b/docs/contributing_guide.zh.md index 9be355148..18e623941 100644 --- a/docs/contributing_guide.zh.md +++ b/docs/contributing_guide.zh.md @@ -82,8 +82,8 @@ DevStream 真诚地欢迎每一个人参与我们的会议，不需要被邀请 ## 架构解读 -- [整体架构](development/devstream/architecture.zh.md) -- [项目组织结构](development/devstream/project-layout.zh.md) +- [整体架构](development/architecture.zh.md) +- [项目组织结构](development/project-layout.zh.md) ## 文档类贡献 diff --git a/docs/development/architecture.md b/docs/development/architecture.md index c251187a1..becda1b07 100644 --- a/docs/development/architecture.md +++ b/docs/development/architecture.md @@ -64,4 +64,4 @@ A _plugin_ implements the aforementioned, predefined interfaces. It executes operations like `Create`, `Read`, `Update`, and `Delete`. -To develop a new plugin, see [creating a plugin](../dev/creating-a-plugin.md). +To develop a new plugin, see [creating a plugin](dev/creating-a-plugin.md). diff --git a/docs/development/architecture.zh.md b/docs/development/architecture.zh.md index 8941d73ad..773c573af 100644 --- a/docs/development/architecture.zh.md +++ b/docs/development/architecture.zh.md @@ -62,4 +62,4 @@ Plugin engine通过调用以下模块来实现目标： 它执行的包括"创建"、"读取"、"更新"和"删除"等操作。 -要开发一个新的插件，请参阅[创建一个插件](../dev/creating-a-plugin.zh.md)。 +要开发一个新的插件，请参阅[创建一个插件](dev/creating-a-plugin.zh.md)。 diff --git a/docs/development/dev/creating-a-plugin.md b/docs/development/dev/creating-a-plugin.md index f290551de..9c41623ef 100644 --- a/docs/development/dev/creating-a-plugin.md +++ b/docs/development/dev/creating-a-plugin.md @@ -24,7 +24,7 @@ Although dtm is automagic, but it can’t read your mind. I’m afraid that you Please fill in the main logic of the plugin here. -You can check out our [Standard Go Project Layout](../devstream/project-layout.md) document for detailed instruction on the project layout. +You can check out our [Standard Go Project Layout](../project-layout.md) document for detailed instruction on the project layout. ## 2 Interfaces diff --git a/docs/development/dev/creating-a-plugin.zh.md b/docs/development/dev/creating-a-plugin.zh.md index d4acd48bf..43baa819b 100644 --- a/docs/development/dev/creating-a-plugin.zh.md +++ b/docs/development/dev/creating-a-plugin.zh.md @@ -24,7 +24,7 @@ 请在这里编写插件的主要逻辑。 -可以查看我们的[Standard Go Project Layout](../devstream/project-layout.zh.md)文件，了解关于项目布局的详细说明。 +可以查看我们的[Standard Go Project Layout](../project-layout.zh.md)文件，了解关于项目布局的详细说明。 ## 2 接口