Backstage 접근성
Backstage 기능을 개발하는 과정에 접근성 관행을 더 깊이 녹여내기 위해, OSS 프로젝트의 핵심 기능 일부(Software Catalog, Software Templates, Search, TechDocs)에 대해 자동화된 CI 테스트를 지원합니다. 이것들은 수많은 플러그인 중 극히 일부에 불과하므로, Backstage에서 작업하실 때 접근성 영향을 함께 고려해 모두를 위한 훌륭한 경험을 만들어 주시길 권합니다.
출처: 문서
본문
Backstage 기능을 개발하는 과정에 접근성 관행을 더 깊이 녹여내기 위해, OSS 프로젝트의 핵심 기능 일부(Software Catalog, Software Templates, Search, TechDocs)에 대해 자동화된 CI 테스트를 지원합니다. 이것들은 수많은 플러그인 중 극히 일부에 불과하므로, Backstage에서 작업하실 때 접근성 영향을 함께 고려해 모두를 위한 훌륭한 경험을 만들어 주시길 권합니다.
기여하는 방법
Backstage를 더 접근성 있게 만드는 데 기여하는 방법은 여러 가지입니다. 아래에서 시작하는 데 도움이 되는 예시 목록을 확인해 보세요.
플러그인에 대해 CI에서 Lighthouse 실행하기
플러그인이 Backstage 메인 저장소에 있다면 Lighthouse 설정의 urls를 수정해 플러그인이 존재하는 urls에서도 Lighthouse 검사를 실행할 수 있습니다. 예:
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
note
이 명령은 Lighthouse 설정을 사용하므로 필요에 따라 직접 조정해야 합니다.
자신의 저장소에서 Lighthouse GitHub Action 사용하기
Backstage 플러그인이 Backstage 메인 저장소 밖에 있고 CI에 GitHub Actions를 사용한다면, 접근성 GitHub 워크플로를 자신의 필요에 맞게 추가하고 수정해 사용하시길 권합니다.
발견된 문제 보고하기
자동화된 검사는 접근성 문제 중 일부만 잡아낼 수 있다는 점을 기억하는 것이 중요합니다. 따라서 보조 기술(스크린 리더, 대체 내비게이션, 화면 확대기 등이 예시입니다)을 사용해 플러그인을 수동으로 테스트해 보시길 권합니다.
접근성 문제를 발견했는데 수정에 시간을 낼 여유가 없다면, Backstage Issues에 이슈를 열어 알려주세요.