문제 해결 주제 유형
문제 해결 주제는 페이지의 마지막 주제여야 합니다.
페이지에 다섯 개 이상의 문제 해결 주제가 있는 경우, 해당 주제를 별도의 페이지에 배치하세요.
포함해야 할 문제 해결 정보 유형
문제 해결 정보에는 다음이 포함됩니다:
- 위험할 수 있는 문제 해결 정보.
- 드문 경우에 대한 정보. 모든 문제 해결 정보가 포함됩니다, 사용자에게 상황이 발생할 가능성이 낮더라도.
이러한 유형의 콘텐츠는 다른 사람에게 유용할 수 있으며, 이점이 위험을 초과합니다.
이 규칙의 예외가 있다고 생각되면, 기술 문서 팀에 문의하세요.
GitLab 지원은 고유한 문제 해결 콘텐츠를 유지합니다.
형식
문제 해결은 세 가지 유형 중 하나일 수 있습니다: 소개, 작업 또는 참조.
소개 주제
이 주제는 페이지의 문제 해결 섹션을 소개합니다. 예를 들어:
## 문제 해결
<x feature>를 사용하면서 다음과 같은 문제에 직면할 수 있습니다.
문제 해결 작업
제목은 표준 작업과 유사해야 합니다. 예를 들어, “디버그 도구 실행” 또는 “구문 확인”.
문제 해결 참조
이 주제는 메시지를 포함합니다. 일관성을 위해, 임시 솔루션에 대해서는 workaround를 사용하고 영구 솔루션에 대해서는 resolution과 resolve를 사용하세요. 예를 들어:
### 메시지 또는 그 설명
<error message>라는 오류 메시지가 표시될 수 있습니다.
이 문제는 발생합니다...
임시 해결책은...
여러 가지 원인 또는 솔루션이 있을 경우, 표 형식으로 정리하는 것을 고려하세요.
정확한 오류 메시지를 사용하는 경우, 그것을 백틱으로 감싸서 코드 스타일로 표시하세요.
솔루션 유형에 대한 추가 안내는 workaround 및 resolution, resolve를 참조하세요.
문제 해결 주제 제목
문제 해결 참조 주제의 제목은 다음 사항을 고려해야 합니다:
- 출력 메시지의 일부를 포함하는 것을 고려하세요. 메시지가 70자 이상인 경우, 가장 중요한 텍스트를 포함하거나 메시지를 설명하세요.
- 제목 시작 부분에 메시지 유형을 명시하세요. 이는 심각도를 나타냅니다. 예:
오류:,경고:. - 제목에 링크를 사용하지 마세요.
전체 메시지를 제목에 포함하지 않는 경우, 본문 텍스트에 포함하세요. 예를 들어:
## 오류: `측면 패킷을 읽는 동안 예상치 못한 연결 종료`
불안정한 네트워크 상황으로 인해 Gitaly가 기본 사이트에서 대용량 리포지토리
데이터를 가져올 때 실패할 수 있습니다. 이러한 조건으로 인해 다음과 같은 오류가 발생할 수 있습니다:
```plaintext
curl 18 transfer closed with outstanding read data remaining & fetch-pack:
측면 패킷을 읽는 동안 예상치 못한 연결 종료
```
이 문제를 해결하려면...
Rails 콘솔 쓰기 함수
문제 해결 제안에 GitLab 인스턴스에서 데이터를 변경하는 함수가 포함되어 있는 경우, 다음 경고를 추가하세요:
경고:
데이터를 변경하는 명령은 올바르게 실행되지 않거나 올바른 조건에서 실행되지 않을 경우 손상을 초래할 수 있습니다. 항상 먼저 테스트 환경에서 명령을 실행하고, 복원할 백업 인스턴스를 준비하세요.
문제 해결 페이지 유형
페이지에 문제 해결 주제가 다섯 개 이상 있는 경우, 별도의 문제 해결 페이지 유형을 만듭니다.
다음 규칙을 따르세요:
- 페이지 이름을
Troubleshooting <feature>로 지정하세요. - 왼쪽 내비게이션에서는
문제 해결라는 단어만 사용하세요. - 내비게이션 파일에서, 새로운 페이지를 해당 기능 아래에 중첩하세요.
- 파일 이름을
<feature>_troubleshooting.md로 지정하세요.
도움말