Missing documentation for alarm commands

未关闭 适合新手
  • 哪里不对？
#3,998 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
1/5
预计耗时
1 小时以内
新手友好度
85/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
技术栈
java
领域
documentation

调研方向

从链接的告警 UI 文档页面以及 app/alarm/ui/doc 下对应的源码开始。对比现有的 guidance、displays 和 automated actions 章节，然后以相同的格式添加 commands 章节。当 commands 完成文档化并且文档构建能渲染出新章节时即完成。

由索引模型根据 Issue 内容生成。

描述

See https://control-system-studio.readthedocs.io/en/latest/app/alarm/ui/doc/index.html#alarm-configuration-options

Guidance, displays, and automated actions are all documented but commands are not.

主要语言
Java
星标
130
派生
132
平均合并
2 天 12 小时
30 天内合并 PR
22

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 有 Pull Request 模板
  • 没有贡献指南

从这里开始

  1. 先读完整个 Issue，再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库，在一个分支上完成修改。
  4. 提交 Pull Request，并在描述里引用这个 Issue 编号。

ControlSystemStudio/phoebus 的其他 Issue

查看 ControlSystemStudio/phoebus 的全部 Issue

相似的 Issue

更多 Java Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。