문서 테스트

GitLab 문서 품질 유지를 위한 CI/CD 파이프라인 린팅 도구, 번역 문서 테스트, 로컬 실행 방법, 린터 설정 업데이트 절차를 설명합니다.

GitLab 문서는 코드와 함께 프로젝트에 저장되며, 코드와 동일하게 취급됩니다. 문서의 표준과 품질을 유지하기 위해 코드에서 사용하는 것과 유사한 프로세스를 사용합니다. Markdown( .md ) 파일의 변경을 포함한 머지 리퀘스트는 다음 CI/CD job을 실행합니다: docs-lint markdown : 다음을 포함한 여러 유형의 테스트를 실행합니다: Vale : 문서 콘텐츠를 검사합니다. markdownlint : Markdown 구조를 검사합니다. lint-docs.sh 스크립트: 기타 테스트 docs-lint links : 문서 모음 내 상대 링크 의 유효성을 검사합니다. docs-lint mermaid : mermaidlint 를 실행하여 유효하지 않은 Mermaid 차트를 검사합니다. rubocop-docs : .rb 파일 의 문서 링크를 검사합니다. eslint-docs : .js 및 .vue 파일 의 문서 링크를 검사합니다. docs-lint redirects : 리디렉션 없이 삭제되거나 이름이 변경된 문서 파일을 검사합니다. docs code_quality 및 code_quality cache : 코드 품질 을 실행하여 Vale 경고 및 오류를 MR 변경 탭(diff 뷰)에 추가 합니다. docs hugo_build : 테스트 전용 설정 을 사용하여 Hugo 웹사이트의 부분 빌드를 실행하고 shortcode 및 파일명을 검증합니다. 일부 파일은 스크립트로 생성됩니다. 소스 코드 파일이나 문서 파일이 올바른 프로세스를 따르지 않고 업데이트되면 CI/CD job이 실패합니다: graphql-verify : doc/api/graphql/reference/_index.md 가 업데이트 프로세스 에 따라 업데이트되지 않으면 실패합니다. docs-lint deprecations-and-removals : doc/update/deprecations.md 가 업데이트 프로세스 에 따라 업데이트되지 않으면 실패합니다. 자동화된 파일의 전체 목록은 자동화된 페이지 를 참조하세요. lint-doc.sh의 테스트 # /scripts/lint-doc.sh 의 테스트는 Vale와 markdownlint로 테스트할 수 없는 페이지 콘텐츠 문제를 찾습니다. 다음 lint-doc.sh 테스트 중 하나라도 실패하면 docs-lint markdown job이 실패합니다: Curl( curl ) 명령어는 짧은 옵션(예: -h ) 대신 긴 형식 옵션( --header )을 사용해야 합니다. 문서 페이지에는 페이지 소유권을 나타내는 프론트매터가 포함되어야 합니다. CHANGELOG.md 에 중복된 버전이 없어야 합니다. doc/ 디렉터리의 파일은 실행 권한이 없어야 합니다. 파일명 및 디렉터리는 다음 조건을 충족해야 합니다: README.md 대신 _index.md 를 사용해야 합니다. 소문자여야 합니다. 이미지 파일명은 추가된 버전을 명시해야 합니다. Mermaid 차트는 오류 없이 렌더링되어야 합니다. Mermaid 차트 린팅 # 히스토리 GitLab