stackabletech / stackabletech/documentation

Improve docs authoring experience

未关闭
#519 5 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

主要语言
CSS
星标
13
派生
14
平均合并
4 天 8 小时
30 天内合并 PR
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:

贡献指南

这个仓库没有索引到贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

调研方向

首先审查 issue 中链接的 Antora Atlas 扩展和部分构建扩展,然后检查当前的文档构建工作流。明确 UI bundle 缓存和部分构建将如何影响双仓库设置;完成的标准是拥有一个有文档记录且可正常工作的 authoring 工作流,并缩短构建时间。

由索引模型根据 Issue 内容生成。

评估

领域
documentation, tooling
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
需要澄清
新手友好度
30/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。