stackabletech / stackabletech/documentation

Explore alternatives to Antora for documentation

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

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

主要言語
CSS
スター
13
フォーク
14
平均マージ
4日 8時間
マージ済み PR(30日)
10

説明

[!IMPORTANT]
This issue is not a commitment to replacing Antora. It is just to record the frustrations of the current documentation workflow, look into alternatives, do timeboxed trials, and understand what we then lose by switching.

Acceptance
  • List shortcomings of the status-quo (Antora)
  • List things we like about the status-quo (Antora)
  • Timeboxed trial of select alternatives to understand the tradeoffs

コントリビューションガイド

このリポジトリのコントリビューションガイドは索引されていません

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

調査の方向性

ファイル、テスト、エントリポイントは指定されていません。まず Antora のドキュメントワークフローを記録し、その弱点と強みを分けて整理してから、選定した代替案を時間制限付きで試し、それぞれの選択肢についてトレードオフと失われるものを記録してください。

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

評価

領域
documentation
issue の種類
リファクタリング
難易度
5/5
見積もり時間
1週間以上
活発さ
停滞
明瞭さ
おおむね明確
初心者へのやさしさ
25/100

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

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