문제 해결 주제 유형

문제 해결 주제는 페이지의 마지막 주제로 배치해야 합니다.

페이지에 문제 해결 주제가 5개 이상 있는 경우 해당 주제를 별도의 페이지에 배치하세요.

포함해야 하는 문제 해결 정보 유형

문제 해결 정보에는 다음이 포함됩니다:

이 유형의 콘텐츠는 다른 사람에게 도움이 될 수 있으며, 혜택이 위험을 상회합니다. 이 규칙의 예외사항이 있다고 생각되면 기술 서적 팀에 문의하십시오.

GitLab 지원팀은 자체 문제 해결 콘텐츠를 유지 관리합니다.

문제 해결은 소개, 작업, 또는 참조 중 하나일 수 있습니다.

이 주제는 페이지의 문제 해결 섹션을 소개합니다. 예를 들면:

## 문제 해결

<x 기능>을(를) 사용하는 동안 다음 문제가 발생할 수 있습니다.

제목은 표준 작업과 유사해야 합니다. 예를 들면 “디버그 도구 실행” 또는 “구문 검증 확인.”

이 주제에는 오류 메시지가 포함됩니다. 일관된 스타일을 유지하려면 일시적 해결책에는 workaround를 사용하고, 영구적인 해결책에는 resolution 및 resolve를 사용합니다. 예를 들면:

### 오류 메시지 또는 해당 설명

다음과 같은 오류 메시지가 표시될 수 있습니다: <오류 메시지>.

이 문제는 ...에 발생합니다.

일시적인 해결책은 ...

여러 원인 또는 해결책이 존재하는 경우, 이를 테이블 형식으로 정리하는 것을 고려하십시오. 정확한 오류 메시지를 사용하는 경우, 코드 스타일로 지정되도록 역따옴표로 둘러십시오.

해결 방법 유형에 대한 자세한 지침은 workaround 및 resolution, resolve를 참조하십시오.

문제 해결 참조 주제의 제목에는 다음을 고려하십시오:

제목에 전체 오류를 넣지 않는 경우, 본문 텍스트에 포함시키십시오.

문제 해결 제안에 GitLab 인스턴스의 데이터를 변경하는 기능이 포함된 경우 다음 경고를 추가하십시오:

WARNING:
데이터를 변경하는 명령은 올바르게 실행되지 않거나 올바른 조건에서 실행되지 않는 경우 피해를 줄 수 있습니다. 항상 먼저 테스트 환경에서 명령을 실행하고 복원할 수 있는 백업 인스턴스를 준비하세요.

페이지에 문제 해결 주제가 5개 이상 있는 경우 별도의 문제 해결 페이지 유형을 만드세요.

다음 규칙을 따르세요: