자동화된 페이지

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

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

  • 표준 프로세스 및 구조화된 데이터(예: YAML 또는 JSON 파일)를 사용하여 생성된 콘텐츠
  • 다른 수단으로 생성된 콘텐츠

자동화는 일관성과 속도에 도움이 됩니다. 그러나 표준이 아닌 방식으로 자동화된 콘텐츠는 다음과 같은 어려움을 야기시킵니다.

  • Frontend 변경
  • 사이트 문제 해결 및 유지 관리
  • 기여자 경험

이상적으로, 모든 자동화는 일부 단점을 완화해 주는 표준 방식으로 수행되어야 합니다.

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

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

  • 계층적 전역 탐색 (YAML)
  • 설문 배너 (YAML)
  • 뱃지 (YAML)
  • 홈페이지 콘텐츠 목록 (YAML)
  • 리다이렉트 (YAML)
  • 버전 메뉴 (JSON)

그 외 생성된 페이지

다른 페이지들은 표준이 아닌 프로세스를 사용하여 생성됩니다. 이러한 페이지들은 종종 여러 저장소에 걸쳐 작성된 솔루션을 사용합니다.

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

자동화 요청 작성

문서 사이트의 페이지를 자동화하고 싶다면:

  1. 이슈 823를 검토하고 거기에 피드백을 추가하는 것을 고려하세요.
  2. 해당 이슈에 필요한 내용이 없다면, 문서 사이트 백엔드의 DRI에 연락하세요.

자동화는 추가 복잡성과 지원 부담을 준다는 점으로 인해 우리는 경우별로 이를 검토합니다.

자동화 문서화

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

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

다른 GitLab 팀원들은 자동화를 유지하기 위한 정보를 쉽게 찾을 수 있어야 합니다. 변경 사항을 널리 알리고 다음을 포함하여 공지해야 합니다:

  • 슬랙 #whats-happening-at-gitlab 채널
  • 기술 작성팀 회의 안건에 포함