Skip to main content

Backstage无障碍设施

为了将可访问性实践进一步融入我们为 Backstage 构建功能的过程中,我们支持对 OSS 项目中的一些核心功能进行自动 CI 测试:软件目录、软件模板、搜索和 TechDocs。 由于这些只是众多插件中的一小部分,我们鼓励您考虑您在 Backstage 上的工作对可访问性的影响,以便为每个人构建良好的体验。

如何捐款

您可以通过多种方式为让更多人了解Backstage做出贡献,下面列出的例子将帮助您开始行动。

在插件的 CI 中运行light house

如果您的插件位于Backstage主存储库您可以修改配置中的网址对存在插件的网址进行light house检查。 例如

ci: {
collect: {
url: [
/** Software Catalog */
'http://localhost:3000/catalog',
'http://localhost:3000/catalog-import',
'http://localhost:3000/catalog/default/component/backstage',
...
+ /** Your plugin paths */
+ 'http://localhost:3000/your-plugin-path,
],
settings: {
...
},
...
},
assert: {
...
},
},

确保无障碍 GitHub 工作流程运行时,修改路径列表.

开发新功能时在本地运行Lighthouse CLI

如果你想使用 Lighthouse CLI 并根据配置运行检查,可以使用以下命令:

yarn dlx @lhci/[email protected] autorun

注意:运行该命令将使用Lighthouse config,因此请务必根据需要进行调整。

在自己的软件仓库中使用 Lighthouse Github Action

如果您的Backstage插件不在Backstage主存储库如果您使用 GitHub Actions 进行持续集成,我们鼓励您添加并修改无障碍 GitHub 工作流程满足您的需求。

报告发现的问题

重要的是要记住,自动检查只能发现少数可访问性问题,因此我们也鼓励您使用辅助技术(屏幕阅读器、替代导航和屏幕放大镜等)对插件进行手动测试。

如果您发现了可访问性问题,但没有时间进行修复,请在以下网址打开一个问题Backstage问题让我们知道。