용어집
이 문서들의 목표는 어떤 사용자든 로컬에서 Backstage 인스턴스를 빠르게 설정할 수 있는 포괄적인 가이드 모음을 제공하는 거예요. 사용자는 Backstage 생태계에 대한 지식이 거의 없다고 가정하며, 올바른 도구(NodeJS, yarn, Docker 등)조차 설치되어 있지 않을 수 있어요. 이 가이드는 시작을 위해 처음으로 안내되는 곳이 될 것이며, 전체 골든 패스를 완료하면 무엇이든 해낼 수 있다는 자신감을 느껴야 해요.
출처: 문서
본문
-
Page: 단일
md파일. -
Guide: 같은 폴더 아래에 그룹화된 여러 페이지.
전반적인 작성 지침
이 문서들의 목표는 어떤 사용자든 로컬에서 Backstage 인스턴스를 빠르게 설정할 수 있는 포괄적인 가이드 모음을 제공하는 거예요. 사용자는 Backstage 생태계에 대한 지식이 거의 없다고 가정하며, 올바른 도구(NodeJS, yarn, Docker 등)조차 설치되어 있지 않을 수 있어요. 이 가이드는 시작을 위해 처음으로 안내되는 곳이 될 것이며, 전체 골든 패스를 완료하면 무엇이든 해낼 수 있다는 자신감을 느껴야 해요.
가이드 페이지를 작성할 때는 가볍게 유지하세요! 이 문서들은 교육적이면서도 대화체이고 읽는 즐거움이 있어야 해요. 가이드는 서로 쌓여야 하고, 진행을 따라 읽을 때 독자는 진행 수준을 넘나들며 개념에 더 편안하고 자신 있게 느껴야 해요. 가이드는 독립적이어야 하지만 서로 링크할 수 있어요.
섹션
사전 준비 사항
모든 의존성을 설정하는 방법. NodeJS 설치, nvm으로 버전 관리, brew와 git 설치. 빠뜨릴 것이 없어야 해요. create-app 스크립트가 만드는 프로젝트 출력에서 사용되는 프로젝트의 의존성이라면 설치 단계와 함께 여기에 나열되어야 해요.
일부 설치 사례는 베어본 VM이나 에어갭 환경처럼 처리하기에 너무 복잡할 수 있어요. 이 가이드는 일반적으로 Windows와 Mac 같은 주요 개발자 환경에 집중해야 하며, 다른 기술에 대한 수요가 늘어남에 따라 섹션을 추가하는 것을 염두에 두어야 해요.
create-app
create-app을 실행하는 방법과 출력이 무엇을 의미하는지.
새 애플리케이션 둘러보기
로그인하는 방법, 애플리케이션에서 탐색하는 방법.
일반적인 카탈로그 사용 사례
일반적인 검색 사용 사례
일반적인 스캐폴더 사용 사례
개발 사이클
핫 리로딩, webpack-dev-server, sqlite. 로컬 개발에서 개발자 경험은 어떤 모습인가요?
프론트엔드 플러그인 추가하기
플러그인을 추가하는 방법, 앱에서 어디에 위치하는지, lockfile에서 추가된 것이 무엇을 의미하는지 살펴봐요.
백엔드 플러그인 추가하기
백엔드에 플러그인을 추가하는 방법, 백엔드에서 어디에 위치하는지, 어떤 기능이 추가되는지 살펴봐요.
애플리케이션 테마 커스터마이징하기
애플리케이션을 조직의 디자인 시스템에 맞게 커스터마이징하는 방법.
인스턴스를 최신 상태로 유지하기
새로운 Backstage 릴리스
메인 Backstage 저장소는 매월 새 버전을 릴리스하고, 주 단위로 사전 릴리스 버전을 릴리스해요. 일반적으로 새 릴리스가 나올 때마다 매월 업그레이드하는 것이 권장돼요.
여기서 더 쉬운 방법으로 yarn 플러그인에 대해 이야기해요.
자동 의존성 업그레이드
Backstage는 그것을 훌륭하게 만드는 수많은 오픈소스 의존성에 기대고 있어요. 배포된 서비스를 소유하는 것의 일환으로 보안 태세도 소유하게 되므로, Dependabot이나 Renovate 같은 도구로 의존성을 업그레이드하는 모범 사례를 지키고 있는지 확인하세요.