TechDocs 워크플로우

TechDocs 워크플로우 An architecture diagram generated by Archify. 개발자 · 문서 작성자 · Architecture component 개발자 문서 작성자 Git Repository · docs/ + mkdocs.yml · Architecture component Git Repository docs/ + mkdocs.yml MkDocs Build · CI 잡 · Architecture component MkDocs Build CI 잡 S3 Bucket · 정적 HTML 저장 · Architecture component S3 Bucket 정적 HTML 저장 TechDocs UI · 통합 문서 뷰어 · Architecture component TechDocs UI 통합 문서 뷰어 TechDocs Backend · 인증 · 권한 · S3 읽기 · Architecture component TechDocs Backend 인증 · 권한 · S3 읽기 Markdown 작성 CI에서 빌드 업로드 산출물 응답 문서 열람 문서 응답 Legend 프런트엔드 백엔드 서비스 클라우드 서비스 외부 시스템

docs-as-code

  • • 코드 리포지토리에 Markdown 문서 작성
  • • mkdocs.yml로 문서 구조 정의
  • • builder: external — CI에서 빌드

S3 스토리지 백엔드

  • • publisher: awsS3
  • • CI publisher와 Backstage reader 권한 분리
  • • S3를 공개하지 않고 backend를 통해 문서 제공