자동화된 페이지

GitLab 문서의 대부분의 페이지는 매뉴얼으로 Markdown으로 작성됩니다. 그러나 일부 페이지는 자동화된 프로세스에 의해 생성됩니다.

GitLab 문서의 자동화된 주요 카테고리는 두 가지가 있습니다.

  • 표준 프로세스 및 구조화된 데이터(예: YAML 또는 JSON 파일)를 사용하여 생성된 내용.
  • 기타 방법으로 생성된 내용.

자동화는 일관성과 속도에 도움이 되지만, 비표준적인 방식으로 자동화된 콘텐츠는 다음과 같은 어려움을 야기시킵니다.

  • 프론트엔드 변경 사항
  • 사이트 문제 해결 및 유지 관리
  • 기여자 경험

이상적으로, 모든 자동화는 일관된 방식으로 수행되어야 하며, 이는 일부 단점을 완화하는 데 도움이 됩니다.

구조화된 데이터에서 생성된 페이지

문서 사이트의 일부 기능은 구조화된 데이터를 사용합니다.

  • 계층적 전역 탐색 (YAML)
  • 설문 조사 배너 (YAML)
  • 뱃지 (YAML)
  • 홈페이지 내용 디렉터리 (YAML)
  • 리디렉션 (YAML)
  • 버전 메뉴 (JSON)

기타 방법으로 생성된 페이지

다른 페이지는 비표준적인 프로세스를 사용하여 생성됩니다. 이러한 페이지는 종종 여러 리포지터리에 걸쳐 코딩된 솔루션을 사용합니다.

페이지 상세정보 소유자
GitLab의 모든 피처 플래그 문서 빌드 중 생성 기술 서술
GitLab Runner 피처 플래그 페이지 소스 Runner
버전별 폐지 및 제거 항목 GitLab 기능 폐지  
GraphQL API 리소스 GraphQL API 스타일 가이드 가져오기 및 통합
감사 이벤트 유형 감사 이벤트 개발 지침 컴플라이언스
사용 가능한 사용자 정의 역할 권한 Rake 작업에 의해 생성 인가
DAST 취약점 확인 문서 (예시) Markdown 생성 방법 동적 분석
청사진 (예시)    
문서 홈페이지   기술 서술

자동화 요청하기

문서 사이트의 페이지를 자동화하려면 다음을 수행하세요:

  1. 이슈 823을 검토하고 거기에 의견을 추가하는 것을 고려해 보세요.
  2. 해당 이슈에서 필요한 내용이나 설명이 되어 있지 않은 경우 문서 사이트 백엔드의 DRI에 연락하세요.

자동화는 추가적인 복잡성과 지원 부담을 야기시키기 때문에, 우리는 서면에 의해 그것을 검토합니다.

자동화 문서화

자동화를 추가하는 경우 다음 사항을 문서화해야 합니다.

  • 포함된 파일 디렉터리
  • .gitlab-ci.yml 업데이트 및 필요한 파이프라인 요구사항
  • 문제 해결에 필요한 단계

기타 GitLab 팀원들은 자동화를 유지하는 방법에 대한 정보를 쉽게 찾을 수 있어야 합니다. 변경 사항은 최소한 다음과 같은 곳에 널리 알려져야 합니다.

  • Slack의 #whats-happening-at-gitlab 채널
  • 기술 작가 팀 회의 안건