자동화된 페이지

GitLab 문서의 대부분 페이지는 수동으로 Markdown으로 작성됩니다.
하지만 일부 페이지는 자동화된 프로세스를 통해 생성됩니다.

GitLab 문서에서는 두 가지 주요 자동화 카테고리가 존재합니다:

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

자동화는 일관성과 속도에 도움이 됩니다. 하지만 비표준 방식으로 자동화된 콘텐츠는 다음과 같은 문제를 일으킬 수 있습니다:

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

이상적으로는 모든 자동화는 표준 방식으로 진행되어야 하며, 이는 단점을 완화하는 데 도움이 됩니다.

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

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

  • 계층적 글로벌 내비게이션 (YAML)
  • 설문조사 배너 (YAML)
  • 배지 (YAML)
  • 홈페이지 콘텐츠 목록 (YAML)
  • 리다이렉트 (YAML)
  • 버전 메뉴 (JSON)

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

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

페이지 세부 사항 소유자
GitLab의 모든 기능 플래그 문서 빌드 중 생성됨 기술 writing
GitLab Runner 기능 플래그 페이지 소스 Runner
버전별 사용 중단 및 제거 GitLab 기능 사용 중단  
GraphQL API 리소스 GraphQL API 스타일 가이드 Import and Integrate
감사 이벤트 유형 감사 이벤트 개발 가이드라인 Compliance
사용 가능한 맞춤 역할 권한 Rake 작업에 의해 생성됨 Authorization
DAST 취약점 검사 문서 (예시) Markdown 생성 방법 동적 분석
문서 홈페이지   기술 writing

자동화 요청하기

문서 사이트의 페이지를 자동화하려면:

  1. 이슈 823를 검토하고 거기에 피드백을 추가하는 것을 고려하세요.

  2. 해당 이슈가 필요한 내용을 설명하지 않는 경우에는 문서 사이트 백엔드의 DRI에게 연락하세요.

자동화는 추가적인 복잡성과 지원 부담을 추가하므로, 사례별로 검토합니다.

자동화 문서화하기

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

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

기타 GitLab 팀원들이 자동화 유지 관리 방법에 대한 정보를 쉽게 찾을 수 있어야 합니다.

변경 사항을 널리 알리셔야 하며, 최소한 다음을 포함해야 합니다:

  • Slack의 #whats-happening-at-gitlab에서.
  • 기술 작가 팀 회의 안건에.