자동화된 페이지

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

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

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

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

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

이상적으로, 모든 자동화는 어느 정도의 단점을 완화하는 데 도움이 되는 표준 방식으로 수행되어야 합니다.

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

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

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

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

다른 페이지들은 표준이 아닌 프로세스를 사용하여 생성됩니다. 이러한 페이지들은 보통 여러 리포지토리에 걸쳐 코딩된 솔루션을 사용합니다.

페이지 세부 정보 소유자
GitLab의 모든 기능 플래그 문서 빌드 중 생성됨 기술적 글쓰기
GitLab Runner 기능 플래그 페이지 소스 Runner
버전별 폐기 및 제거 GitLab 기능의 폐기  
GraphQL API 리소스 GraphQL API 스타일 가이드 가져오기 및 통합
감사 이벤트 유형 감사 이벤트 개발 지침 컴플라이언스
사용 가능한 사용자 정의 역할 권한 Rake 태스크에 의해 생성됨 인가
DAST 취약점 확인 문서 (예시) 마크다운 생성 방법 다이내믹 분석
문서 홈페이지   기술적 글쓰기

자동화 요청하기

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

  1. 이슈 823를 검토하고 거기에 의견을 추가하는 것을 고려하십시오.
  2. 해당 이슈가 필요한 내용을 설명하지 않는 경우, 문서 사이트 백엔드에 대한 DRI에 연락하십시오.

자동화는 추가 복잡성과 지원 부담을 야기하기 때문에 우리는 각각의 사례를 따로 검토합니다.

자동화 문서화하기

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

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

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

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