문제 해결 토픽 유형

문제 해결 토픽은 페이지의 마지막 토픽이어야 합니다.

만일 페이지에 다섯 개 이상의 문제 해결 토픽이 있다면, 해당 토픽들을 별도의 페이지에 넣으세요.

포함할 문제 해결 정보 유형

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

이러한 종류의 콘텐츠는 다른 사용자에게 도움이 되는 경우가 많으며, 이득이 위험을 상회합니다. 이 규칙에 대한 예외가 있다고 생각된다면 기술 문서팀에 문의하세요.

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

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

이 토픽은 페이지의 문제 해결 섹션을 소개합니다. 예를 들어:

## Troubleshooting

<x 기능>을(를) 사용하는 동안 다음과 같은 문제에 직면할 수 있습니다.

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

이 토픽에는 오류 메시지가 포함됩니다. 일관성을 유지하기 위해 임시 해결책에는 workaround를 사용하고, 영구적인 해결책에는 resolution 및 resolve를 사용하세요. 예를 들어:

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

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

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

임시 해결책은 다음과 같습니다...

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

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

문제 해결 참조 토픽의 제목으로는 최소한 부분적인 오류 메시지를 포함하는 것을 고려하세요. 70자 이하로 작성하세요. 제목에 링크를 사용하지 마세요.

제목에 전체 오류 내용이 포함되지 않는 경우, 내용 본문에 포함하세요.

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

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

페이지에 문제해결 토픽이 다섯 개 이상 있을 경우, 별도의 문제 해결 페이지 유형을 만드세요.

다음 규칙을 따르세요: