Skip to content

Commit 6b13694

Browse files
authored
Merge pull request #1313 from aFlyBird0/fix-typo
docs: fix typo
2 parents 7856b96 + 3de8768 commit 6b13694

File tree

2 files changed

+4
-6
lines changed

2 files changed

+4
-6
lines changed

docs/development/architecture.zh.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ _注意:为了简单起见,CLI被命名为`dtm`(DevOps Toolchain Manager)
2424

2525
`pluginengine`首先调用`configmanager`,将本地YAML配置文件读取到一个结构体中,然后调用`pluginmanager`来下载所需的插件。
2626

27-
之后,`pluginengine`调用`statemanager`来计算congfig、状态和实际DevOps工具的状态之间的"差异"。最后,`pluginengine`根据这变更执行对应的操作,并更新状态。在执行过程中,`pluginengine`加载每个插件(`*.so`文件)并根据每个变更调用相应的接口。
27+
之后,`pluginengine`调用`statemanager`来计算config、状态和实际DevOps工具的状态之间的"差异"。最后,`pluginengine`根据这变更执行对应的操作,并更新状态。在执行过程中,`pluginengine`加载每个插件(`*.so`文件)并根据每个变更调用相应的接口。
2828

2929
## 2 插件引擎
3030

docs/development/dev/creating-a-plugin.zh.md

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -41,16 +41,14 @@
4141

4242
### 2.2 返回值
4343

44-
`create``read``update`方法返回两个值`(statemanager.ResourceStatus, error)`第一个是 "状态"。
44+
`Create`, `Read``Update` 方法返回两个值 `(statemanager.ResourceStatus, error)`第一个是 "状态",第二个是 "错误"。
4545

46-
`delete'接口返回两个值`(bool, error)`。如果没有错误,它返回`(true, nil)`;否则将返回`(false, error)`。
47-
48-
如果没有发生错误,返回值将是`(true, nil)`。否则,结果将是`(false, error)`
46+
`Delete` 接口返回两个值 `(bool, error)`。如果没有错误,它应当返回 `(true, nil)`;否则应返回 `(false, error)`
4947

5048
## 3 插件是如何工作的?
5149

5250
DevStream是使用[go plugin](https://pkg.go.dev/plugin)来实现自定义插件的。。
5351

5452
当你执行一个调用任何接口(`Create`, `Read`, `Update`, `Delete`)的命令时,DevStream的`pluginengine`会调用[`plugin.Lookup("DevStreamPlugin")`函数](https://github.com/devstream-io/devstream/blob/38307894bbc08f691b2c5015366d9e45cc87970c/internal/pkg/pluginengine/plugin_helper.go#L28)来加载插件,获得实现`DevStreamPlugin`接口的变量`DevStreamPlugin`,然后你就可以调用相应的插件接口。所以我们不建议你直接修改`/cmd/plugin/YOUR-PLUGIN-NAME/main.go`文件,因为该文件是根据接口定义自动生成好的。
5553

56-
注意:`/cmd/plugin/YOUR-PLUGIN-NAME/main.go`文件中的`main()`不会被执行,它只是用来避免golangci-lint错误
54+
注意:`/cmd/plugin/YOUR-PLUGIN-NAME/main.go`文件中的`main()`不会被执行,它只是用来避免 `golangci-lint` 错误

0 commit comments

Comments
 (0)