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

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

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

• 기타 방법으로 생성된 콘텐츠.

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

• 프론트엔드 변경.

• 사이트 트러블슈팅 및 유지 관리.

• 기여자 경험.

이상적으로는 자동화를 표준 방식으로 수행하면 이러한 단점을 어느 정도 완화할 수 있습니다.

구조화된 데이터로 생성된 페이지#

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

• 계층적 글로벌 내비게이션 (YAML)

• 설문 배너 (YAML)

• 배지 (YAML)

• 홈페이지 콘텐츠 목록 (YAML)

• 리다이렉트 (YAML)

• 버전 메뉴 (JSON)

그 외 방식으로 생성된 페이지#

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

자동화 요청하기#

문서 사이트에서 페이지를 자동화하려는 경우:

• 이슈 246을 검토하고 피드백을 추가하는 것을 고려하세요.

• 해당 이슈에 필요한 내용이 설명되어 있지 않다면, 문서 사이트 백엔드 DRI에 문의하세요.

자동화는 복잡성과 지원 부담을 추가하기 때문에, 케이스별로 검토합니다.

자동화 문서화하기#

자동화를 추가하는 경우, 다음 항목을 반드시 문서화해야 합니다:

• 포함된 파일 목록.

• .gitlab-ci.yml 업데이트 및 파이프라인 요구 사항.

• 트러블슈팅에 필요한 단계.

다른 GitLab 팀원들이 자동화를 유지 관리하는 방법에 관한 정보를 쉽게 찾을 수 있어야 합니다. 변경 사항을 최소한 다음을 포함하여 광범위하게 공지해야 합니다:

• Slack의 #whats-happening-at-gitlab 채널.

• Technical Writer 팀 미팅 안건.