stackabletech / stackabletech/documentation
Operator overview pages for internal operators (commons, secret, listener)
オープン
まだ誰も着手していません。
area/documentation
size/M
- 主要言語
- CSS
- スター
- 13
- フォーク
- 14
- 平均マージ
- 4日 8時間
- マージ済み PR(30日)
- 10
説明
Follow up to https://github.com/stackabletech/documentation/issues/282
Explain for every operator:
- which roles does it have and what do they mean?
- Which resources does it create:
- i.e. statefulsets per role
- configmap for discovery
- also a diagram
- which resources does it tear down again?
- for example, ConfigMaps and PVCs are staying
- what are the dependencies, what other operators does it connect to?
- link to demos
Operators:
- commons
- secret
- listener
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まずフォローアップ issue #282 を読み、commons、secret、listener operator の既存ドキュメントを確認してください。各 operator について、その役割、作成され保持されるリソースまたは削除されるリソース、依存関係、図、デモへのリンクを文書化してください。3 つすべての operator のチェックボックスが網羅されたら、作業は完了です。
索引モデルが issue の本文から書いたものです。
評価
- 領域
- documentation
- issue の種類
- ドキュメント
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 35/100