stackabletech / stackabletech/documentation

Operator env vars documentation

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

还没有人认领这个 Issue。

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

描述

currently there is hand written docs for env vars and commandline parameters, but that in itself isn't useful.

The users want to set this with Helm, or somehow in OpenShift (or maybe with stackablectl?)

These things should go into the Reference section.

We should also think about maybe generating this if we can (but not necessary, as there are probably not that many settings). Maybe we can have instead common operator flags as a partial somewhere, that we can simply reference in all the operators.

related: https://github.com/stackabletech/documentation/issues/514

贡献指南

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

从这里开始

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

调研方向

首先找到现有的手写环境变量和命令行参数文档,然后查看 Reference 部分以及相关 issue 514。完成的标准是:以用户可以通过 Helm 或 OpenShift 应用的形式记录这些设置,并将有关共享 partial 或生成的任何决定记录在最终文档中。

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

评估

技术栈
helm
领域
documentation
Issue 类型
文档
难度
4/5
预计耗时
3-5 天
活跃度
停滞
描述清晰度
基本清楚
新手友好度
38/100

把新 issue 发到你的邮箱

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