Lumie 문서
목적
이 사이트는 Lumie의 제품 문서 허브입니다. 이 문서는 프론트엔드, 백엔드, 워커, 인프라, 데이터 모델, 개발자 워크플로 전반에서 Lumie 시스템이 어떻게 구축되고, 운영되며, 확장되는지를 설명합니다.
docusaurus/docs/** 아래의 영어 페이지가 기준 원본입니다. 한국어 페이지는
현지화된 미러이며, 영어 원본 페이지가 바뀐 뒤에도 동일한 구조를 따라야
합니다.
문서 읽는 법
| 섹션 | 이런 내용을 이해해야 할 때 |
|---|---|
| 아키텍처 | 시스템 구조, 런타임 경계, 기술 선택 |
| 백엔드 | Spring Boot 모듈러 모놀리스, 모듈, 테넌시, 메시징, 도메인 서비스 |
| 프론트엔드 | Next.js 애플리케이션 구조, 라우팅, 상태, 테스트 |
| 워커 | 채점, 리포트, 분석, 챗봇 작업을 위한 FastAPI 백그라운드 서비스 |
| 데이터 모델 | PostgreSQL 스키마 계열, RLS, 청구 테이블, ERD, 마이그레이션 |
| 인프라 | K3s, GitOps, 네트워킹, 플랫폼 서비스, 클러스터 기반 |
| 운영 | 애플리케이션, 스토리지, 관측성, 보안을 위한 데이투 운영 |
| 개발 | 워크스페이스 구성, Tilt 워크플로, 문서화 규칙, 공유 워크플로 제어 평면 |
트러블슈팅 페이지는 의도적으로 레퍼런스 문서와 분리되어 있습니다. 서비스나 아키텍처의 기준 설명이 아니라, 특정 장애 상황용 런북이 필요할 때 사용하세요.
기준 원본 규칙
- 먼저 영어 페이지를 작성하거나 업데이트합니다.
- 기술적 주장은 실제 코드, 설정, 마이그레이션, 매니페스트, 또는 배포된 동작에 근거해야 합니다.
- Docusaurus 구조는
sidebars.js,_category_.json, 페이지 frontmatter에 유지합니 다. - 완성된 영어 페이지는 원본 페이지가 안정화된 뒤에만 한국어로 미러링합니다.
- 새 문서를 작성할 때 현지화된 페이지를 상위 원본으로 사용하지 않습니다.
자주 시작하는 지점
- 저장소 구조가 처음이라면 워크스페이스부터 시작하세요.
- 백엔드 모듈을 변경한다면 백엔드 개요부터 시작하세요.
- 워커 동작을 변경한다면 워커 개요부터 시작하세요.
- 테이블이나 마이그레이션을 변경한다면 데이터 모델 개요부터 시작하세요.
- 클러스터 구성을 변경한다면 인프라 개요부터 시작하세요.
검증
구조 변경이나 링크가 많은 문서 변경의 경우 사이트를 빌드하세요.
cd lumie-document/docusaurus
npm run build
Docusaurus는 현재 일부 경로에서 깨진 링크를 경고로 보고하도록 구성되어 있습니다. 빌드가 성공적으로 끝나더라도 해당 경고는 작업 항목으로 취급하세요.