아키텍처 결정 기록(ADR)
Backstage 프로젝트에서 내려진 중요한 아키텍처 결정들이 여기에 있습니다.
출처: 문서
본문
Backstage 프로젝트에서 내려진 중요한 아키텍처 결정들이 여기에 있습니다. ADR에 대한 더 많은 정보, 언제 작성하는지, 왜 작성하는지는 이 블로그 게시물을 참조하세요.
기록은 삭제되지 않지만, 새 결정으로 대체(superseded)되거나 더 이상 사용되지 않음(deprecated)으로 표시될 수 있습니다.
기록은 architecture-decisions 디렉토리 아래에 저장해야 합니다.
기여하기
ADR 생성하기
-
docs/architecture-decisions/adr000-template.md를docs/architecture-decisions/adr000-my-decision.md로 복사합니다(my-decision은 설명적이어야 합니다. ADR 번호를 지정하지 마세요). -
템플릿의 지침에 따라 ADR을 작성합니다.
-
풀 리퀘스트를 제출합니다.
-
커뮤니티의 피드백을 다루고 통합합니다.
-
결국 번호를 지정합니다.
-
ADR의 경로를
sidebars.ts의 마이크로사이트 사이드바에 추가합니다. -
ADR의 경로를
mkdocs.yml에 추가합니다. -
풀 리퀘스트를 병합합니다.
ADR 대체하기
ADR이 이전 ADR을 대체한다면, 이전 ADR의 상태가 "superseded by ADR-XXXX"로 변경되고 새 ADR에 대한 링크가 추가됩니다.