stackabletech / stackabletech/documentation

Operator env vars documentation

オープン
#515 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

主要言語
CSS
スター
13
フォーク
14
平均マージ
4日 8時間
マージ済み PR(30日)
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. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

まず、環境変数とコマンドラインパラメーターに関する既存の手書きドキュメントを見つけ、次に Reference セクションと関連する issue 514 を確認します。完了条件は、ユーザーが Helm または OpenShift で適用できる形式で設定が文書化され、共有 partial または生成に関する決定が結果のドキュメントに記録されていることです。

索引モデルが issue の本文から書いたものです。

評価

技術スタック
helm
領域
documentation
issue の種類
ドキュメント
難易度
4/5
見積もり時間
3〜5日
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
38/100

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。