问题:我们有很多组件(约1000个,以及约10000个故事)。对于不同的人(开发人员、质量保证人员、分析人员、管理人员等)来说,导航变得困难。
例如,我们有两个包:componentA和componentB。很明显,树形视图应该是这样的:
components/
componentA/
- story1
- story2
componentB
- story3
- story4
这对开发人员来说很方便。但是(例如)对于QA来说就不方便了。假设story1和story3负责认证,而story2和story4不负责。如果有一个像这样的树形结构就很方便:
auth/
- story1
- story3
not-auth/
- story2
- story4
现在,考虑一下story1、2和4在pageOne上使用,而story3在pageTwo上使用。我们还有一个可能的树形结构:
pageOne/
- story1
- story2
- story3
pageTwo/
- story4
所以,有很多不同的结构,没有一个适合每个人。
解决方案:自定义树形结构。
对于上面的示例,我们有以下标签:
story1: { component: 'componentA', auth: true, page: 'pageOne' }
story2: { component: 'componentA', auth: false, page: 'pageOne' }
story3: { component: 'componentB', auth: true, page: 'pageTwo' }
story4: { component: 'componentB', auth: false, page: 'pageOne' }
现在我们可以构造三个不同的树形结构:
1: component
2: auth
3: page
我们还可以在这里做更多的事情:
4: component → page
这给我们带来了:
componentA/
pageOne/
- story1
- story2
componentB/
pageOne/
- story3
pageTwo/
- story4
现在,只需在运行时选择您最喜欢的自定义树形结构,根据您最喜欢/最理解的标签进行导航!
这对于文档特别有用(您支持mdx,因此我们正在考虑从docusaurus迁移到storybook),可以根据以下内容进行划分:
- 组件/包
- 项目
- 团队
- 上下文(指南/教程/信息/解释)
- 角色
- 依赖项
- ...
您是否能够协助将这个功能实现?
不确定。我会尝试在我们的项目中实现它。
PS:自定义树形结构在 https://github.com/allure-framework/allure-docs 中实现,但文档较差,我不知道在哪里可以找到实时示例。但它确实很酷且有用。
2条答案
按热度按时间fcg9iug31#
大家好!最近似乎没有太多关于这个问题的进展。如果还有问题、评论或错误,请随时继续讨论。遗憾的是,我们没有时间处理每一个问题。我们始终欢迎贡献,所以如果你想帮忙,请发送一个pull request。30天后未活跃的问题将被关闭。谢谢!
kxeu7u2r2#
或许,或许有一天。