docs: update example of plugin manifest file (#339)

更新插件开发中的 plugin.yaml 示例。

Ref https://github.com/halo-dev/halo/issues/5721

```release-note
None
```
wan92hen-patch-1
Ryan Wang 7 months ago committed by GitHub
parent 48d2ce43df
commit 710c4a480c
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -14,16 +14,18 @@ spec:
enabled: true enabled: true
requires: ">=2.0.0" requires: ">=2.0.0"
author: author:
name: halo-dev name: Halo
website: https://halo.run website: https://www.halo.run
logo: https://halo.run/logo logo: https://www.halo.run/logo
# settingName: hello-world-settings # settingName: hello-world-settings
# configMapName: hello-world-configmap # configMapName: hello-world-configmap
homepage: https://github.com/guqing/halo-plugin-hello-world homepage: https://github.com/halo-dev/plugin-starter#readme
repo: https://github.com/halo-dev/plugin-starter
displayName: "插件 Hello world" displayName: "插件 Hello world"
description: "插件开发的 hello world用于学习如何开发一个简单的 Halo 插件" description: "插件开发的 hello world用于学习如何开发一个简单的 Halo 插件"
license: license:
- name: "MIT" - name: "GPL-3.0"
url: "https://github.com/halo-dev/plugin-starter/blob/main/LICENSE"
``` ```
- `apiVersion``kind`:为固定写法,每个插件写法都是一样的不可变更。 - `apiVersion``kind`:为固定写法,每个插件写法都是一样的不可变更。
@ -48,7 +50,8 @@ spec:
如果你在 plugin.yaml 中配置了 `settingName` 但确没有对应的 `Setting` 自定义模型资源文件,会导致插件无法启动,原因是 `Setting` 模型 `metadata.name` 为你配置的 `settingName` 的资源无法找到。 如果你在 plugin.yaml 中配置了 `settingName` 但确没有对应的 `Setting` 自定义模型资源文件,会导致插件无法启动,原因是 `Setting` 模型 `metadata.name` 为你配置的 `settingName` 的资源无法找到。
::: :::
- `spec.homepage`:通常为插件的 GitHub 仓库链接,或可联系到插件作者或插件官网或帮助中心链接等。 - `spec.homepage`:通常设置为插件官网或帮助中心链接等。
- `spec.repo`:插件源码地址。
- `spec.displayName`:插件的显示名称,它通常是以少数几个字来概括插件的用途。 - `spec.displayName`:插件的显示名称,它通常是以少数几个字来概括插件的用途。
- `spec.description`:插件描述,用一段简短的说明来介绍插件的用途。 - `spec.description`:插件描述,用一段简短的说明来介绍插件的用途。
- `spec.license`:插件使用的软件协议,参考:<https://en.wikipedia.org/wiki/Software_license> - `spec.license`:插件使用的软件协议,参考:<https://en.wikipedia.org/wiki/Software_license>

@ -35,11 +35,13 @@ description: 这个例子展示了如何开发 Todo List 插件
name: halo-dev name: halo-dev
website: https://halo.run website: https://halo.run
logo: https://halo.run/logo logo: https://halo.run/logo
homepage: https://github.com/guqing/halo-plugin-hello-world homepage: https://github.com/halo-dev/plugin-starter#readme
repo: https://github.com/halo-dev/plugin-starter
displayName: "插件 Todo List" displayName: "插件 Todo List"
description: "插件开发的 hello world用于学习如何开发一个简单的 Halo 插件" description: "插件开发的 hello world用于学习如何开发一个简单的 Halo 插件"
license: license:
- name: "MIT" - name: "GPL-3.0"
url: "https://github.com/halo-dev/plugin-starter/blob/main/LICENSE"
``` ```
参考链接: 参考链接:

@ -14,16 +14,18 @@ spec:
enabled: true enabled: true
requires: ">=2.0.0" requires: ">=2.0.0"
author: author:
name: halo-dev name: Halo
website: https://halo.run website: https://www.halo.run
logo: https://halo.run/logo logo: https://www.halo.run/logo
# settingName: hello-world-settings # settingName: hello-world-settings
# configMapName: hello-world-configmap # configMapName: hello-world-configmap
homepage: https://github.com/guqing/halo-plugin-hello-world homepage: https://github.com/halo-dev/plugin-starter#readme
repo: https://github.com/halo-dev/plugin-starter
displayName: "插件 Hello world" displayName: "插件 Hello world"
description: "插件开发的 hello world用于学习如何开发一个简单的 Halo 插件" description: "插件开发的 hello world用于学习如何开发一个简单的 Halo 插件"
license: license:
- name: "MIT" - name: "GPL-3.0"
url: "https://github.com/halo-dev/plugin-starter/blob/main/LICENSE"
``` ```
- `apiVersion``kind`:为固定写法,每个插件写法都是一样的不可变更。 - `apiVersion``kind`:为固定写法,每个插件写法都是一样的不可变更。
@ -48,7 +50,8 @@ spec:
如果你在 plugin.yaml 中配置了 `settingName` 但确没有对应的 `Setting` 自定义模型资源文件,会导致插件无法启动,原因是 `Setting` 模型 `metadata.name` 为你配置的 `settingName` 的资源无法找到。 如果你在 plugin.yaml 中配置了 `settingName` 但确没有对应的 `Setting` 自定义模型资源文件,会导致插件无法启动,原因是 `Setting` 模型 `metadata.name` 为你配置的 `settingName` 的资源无法找到。
::: :::
- `spec.homepage`:通常为插件的 GitHub 仓库链接,或可联系到插件作者或插件官网或帮助中心链接等。 - `spec.homepage`:通常设置为插件官网或帮助中心链接等。
- `spec.repo`:插件源码地址。
- `spec.displayName`:插件的显示名称,它通常是以少数几个字来概括插件的用途。 - `spec.displayName`:插件的显示名称,它通常是以少数几个字来概括插件的用途。
- `spec.description`:插件描述,用一段简短的说明来介绍插件的用途。 - `spec.description`:插件描述,用一段简短的说明来介绍插件的用途。
- `spec.license`:插件使用的软件协议,参考:<https://en.wikipedia.org/wiki/Software_license> - `spec.license`:插件使用的软件协议,参考:<https://en.wikipedia.org/wiki/Software_license>

@ -35,11 +35,13 @@ description: 这个例子展示了如何开发 Todo List 插件
name: halo-dev name: halo-dev
website: https://halo.run website: https://halo.run
logo: https://halo.run/logo logo: https://halo.run/logo
homepage: https://github.com/guqing/halo-plugin-hello-world homepage: https://github.com/halo-dev/plugin-starter#readme
repo: https://github.com/halo-dev/plugin-starter
displayName: "插件 Todo List" displayName: "插件 Todo List"
description: "插件开发的 hello world用于学习如何开发一个简单的 Halo 插件" description: "插件开发的 hello world用于学习如何开发一个简单的 Halo 插件"
license: license:
- name: "MIT" - name: "GPL-3.0"
url: "https://github.com/halo-dev/plugin-starter/blob/main/LICENSE"
``` ```
参考链接: 参考链接:

Loading…
Cancel
Save