stackabletech / stackabletech/documentation

Operators: Turn examples into documentation

未关闭
#287 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

priority/low refinement-needed
主要语言
CSS
星标
13
派生
14
平均合并
4 天 8 小时
30 天内合并 PR
10

描述

We have the example directories in the operators, which are very useful for us devs to quicky deploy an instance of something. But the examples are not tested.

With the getting started guide we started moving examples into the docs and testing them. It would make sense to keep doing this, with the other examples as well. There are specific examples which deploy an instance + OPA etc., which we could turn into specific docs guides.

This would be an epic and needs to be done for all operators.

贡献指南

这个仓库没有索引到贡献指南

从这里开始

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

调研方向

首先检查 operator 示例目录和入门指南,其中的示例已经开始迁移到经过测试的文档中。盘点所有 operator 中剩余的示例,确定哪些示例应转变为具体指南,并将完成定义为每个选定的示例都已编写文档并完成测试。

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

评估

领域
documentation
Issue 类型
文档
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
需要澄清
新手友好度
25/100

把新 issue 发到你的邮箱

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