stackabletech / stackabletech/documentation

Operators: Turn examples into documentation

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

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

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

調査の方向性

まず、operator のサンプルディレクトリと Getting Started ガイドを確認します。そこでは、サンプルをテスト済みのドキュメントに移行し始めています。すべての operator に残っているサンプルを洗い出し、どれを個別のガイドにすべきかを特定し、選択した各サンプルがドキュメント化され、テスト済みであることを完了の定義とします。

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

評価

領域
documentation
issue の種類
ドキュメント
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
説明が足りない
初心者へのやさしさ
25/100

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

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