디렉터리에 추가
레거시 문서
출처: 문서
본문
레거시 문서
이 섹션은 레거시 플러그인 문서의 일부예요. 여기 설명된 플러그인을 디렉터리에 추가하는 과정은 여전히 유효해요.
플러그인을 디렉터리에 추가
새 플러그인을 플러그인 디렉터리에 추가하려면 <plugin-name>.yaml 패턴의 파일을 만드세요. 여기서 <plugin-name>은 플러그인 이름이에요. 이 파일은 플러그인 정보와 함께 microsite/data/plugins에 들어가요. 예시:
---title: Your Pluginauthor: Your NameauthorUrl: # A link to information about the author E.g. Company url, github user profile, etccategory: Monitoring # A single category e.g. CI, Machine Learning, Services, Monitoringdescription: A brief description of the plugin. # Max 170 charactersdocumentation: # A link to your documentation E.g. Your github READMEiconUrl: # Used as the src attribute for your logo.# You can provide an external url or add your logo under static/img and provide a path# relative to static/ e.g. /img/my-logo.pngnpmPackageName: # Your npm package name E.g. '@backstage/plugin-<etc>' quotes are requiredaddedDate: # The date plugin added to directory E.g. '2022-10-01' quotes are required
팁
저장소 루트에서 다음을 실행해 YAML 파일이 올바른지 검증할 수 있어요.
- 먼저
yarn install실행 - 그런 다음
node ./scripts/verify-plugin-directory.js실행
오류가 있으면 나열되고 수정해야 해요. 우리는 CI의 일부로 이와 같은 검사를 실행해요.
제출 팁
플러그인을 제출할 때 검토 과정을 빠르게 하는 데 도움이 되는 몇 가지 팁이에요.
- 사용하는 아이콘에 대해 적절한 사용 권한이 있는지 확인하세요. 아이콘이 없으면
iconUrl: '/img/logo-gradient-on-dark.svg'로 기본 설정돼요. - 패키지가 NPM 레지스트리에 게시되었고 공개인지 확인하세요.
- NPM의 패키지가 코드 저장소로 다시 연결되는 링크가 있는지 확인하세요. 이는 올바른 패키지임을 신뢰하는 데 도움이 돼요.
- 가능하면 조직 이름이나 사용자 이름과 일치하는 NPM 스코프를 사용하세요. 이는 플러그인에 대한 신뢰를 제공해요.
- 플러그인에 프론트엔드와 백엔드가 모두 있다면 문서를 프론트엔드 패키지에 연결하되, 백엔드 패키지 설치가 필요하다는 것을 언급했는지 확인하세요.
- 가능하면 플러그인 문서에 기능 스크린샷을 포함하세요. 플러그인 사용을 결정할 때 정말 도움이 돼요.