stackabletech / stackabletech/documentation
Improve docs authoring experience
オープン
まだ誰も着手していません。
- 主要言語
- CSS
- スター
- 13
- フォーク
- 14
- 平均マージ
- 4日 8時間
- マージ済み PR(30日)
- 10
説明
As a dev, writing docs is made unpleasant by a few things in the process, especially when writing docs for an Operator, because multiple repos are involved.
Currently the workflow is:
- checkout both the docs repo and the operator repo
- edit the playbook file to point to the local operator repo checkout
- write the docs in the operator repo and rebuild the docs periodically
Main pain points are:
- the setup is cumbersome
- build times are long
### Tasks
- [ ] Cache UI bundle in the build
- [ ] investigate Atlas/partial build extension
Links:
- Antora Atlas extension: https://gitlab.com/antora/antora-atlas-extension
- partial build extension: https://github.com/spring-io/antora-extensions#partial-build (depends on the Atlas extension)
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
まず、issue にリンクされている Antora Atlas 拡張機能と部分ビルド拡張機能を確認し、その後、現在のドキュメントビルドのワークフローを調査します。UI バンドルのキャッシュと部分ビルドが 2 つのリポジトリ構成にどのような影響を与えるかを定義します。完了の条件は、ビルド時間が短縮された、文書化済みで動作する authoring ワークフローです。
索引モデルが issue の本文から書いたものです。
評価
- 領域
- documentation, tooling
- issue の種類
- 機能追加
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 活発さ
- 停滞
- 明瞭さ
- 説明が足りない
- 初心者へのやさしさ
- 30/100