Operators: Turn examples into documentation
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
- issue の種類
- ドキュメント
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
調査の方向性
まず、operator のサンプルディレクトリと Getting Started ガイドを確認します。そこでは、サンプルをテスト済みのドキュメントに移行し始めています。すべての operator に残っているサンプルを洗い出し、どれを個別のガイドにすべきかを特定し、選択した各サンプルがドキュメント化され、テスト済みであることを完了の定義とします。
索引モデルが issue の本文から書いたものです。
説明
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.
- 主要言語
- CSS
- スター
- 13
- フォーク
- 14
- 平均マージ
- 4日 8時間
- マージ済み PR（30日）
- 10
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
stackabletech/documentation のほかの issue
-
Withdraw ADR018 オープン
難易度 1/5 1時間未満 初心者へのやさしさ 68/100
stackabletech/documentation#734 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 55/100
stackabletech/documentation#779 ·
-
customer-request
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
stackabletech/documentation#773 ·
-
難易度 4/5 3〜5日 初心者へのやさしさ 25/100
stackabletech/documentation#754 ·
-
難易度 3/5 1〜2日 初心者へのやさしさ 25/100
stackabletech/documentation#753 ·
stackabletech/documentation の issue をすべて見る
似ている issue
-
Add: hunch オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
AbdelStark/awesome-typesafe#104 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
-
A11y ♿️
難易度 2/5 1〜3時間 初心者へのやさしさ 72/100
-
Link Checker Report オープンautomated issue report
難易度 2/5 1〜3時間 初心者へのやさしさ 85/100
-
documentation improve or update documentation priority/low triage
難易度 2/5 半日 初心者へのやさしさ 86/100
warpdotdev/docs#782 · コメント 1 件 ·