Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

为 Halo 2.0 提供插件开发的文档 #113

Closed
ruibaby opened this issue Nov 23, 2022 · 3 comments · Fixed by #123
Closed

为 Halo 2.0 提供插件开发的文档 #113

ruibaby opened this issue Nov 23, 2022 · 3 comments · Fixed by #123
Labels
kind/documentation Categorizes issue or PR as related to documentation.

Comments

@ruibaby
Copy link
Member

ruibaby commented Nov 23, 2022

目前 Halo 2.0 已经支持了插件机制，期望为插件开发编写文档。

/kind documentation
@f2c-ci-robot f2c-ci-robot bot added the kind/documentation Categorizes issue or PR as related to documentation. label Nov 23, 2022
@guqing
Copy link
Member

guqing commented Nov 25, 2022

大纲：

  • 介绍 - 对插件进行整体描述包括功能、插件API访问、核心接口、用户操作、插件管理等的概述
  • 先决条件 - 插件所需运行环境和准备
  • 插件结构和生命周期
  • 编写自己的插件 - 一步步介绍如何创建一个自己的插件
    • 使用模板创建一个新的插件项目
    • 初始化插件
    • 创建一个自定义模型
    • 使用 Halo 资源
    • 使用外部资源
    • 创建用户界面
    • 如何测试插件代码
    • 调试
    • 构建 JAR
  • Halo 扩展点

@ruibaby
Copy link
Member Author

ruibaby commented Nov 25, 2022

@guqing 我建议先有一个简单的从创建项目到运行起来看到效果的文档。然后再持续深入。

@guqing
Copy link
Member

guqing commented Nov 25, 2022

没有深入的点，介绍只是整体概述，然后就是创建插件了

@guqing guqing mentioned this issue Nov 28, 2022
Merged
f2c-ci-robot bot pushed a commit that referenced this issue Feb 14, 2023
@guqing
feat: add plugin development docs (#123)
f21171d 
### What this PR does?
添加插件开发文档

### Which issue(s) this PR fixes
Fixes #113

/area docs

```release-note
None
```
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
kind/documentation Categorizes issue or PR as related to documentation.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: add plugin development docs guqing/docs
2 participants
@ruibaby @guqing