트러블슈팅 주제는 페이지의 마지막 주제여야 합니다.

페이지에 트러블슈팅 주제가 5개 이상 있는 경우, 해당 주제들을 별도 페이지에 배치하세요.

포함할 트러블슈팅 정보 유형#

트러블슈팅 정보에는 다음이 포함됩니다:

• 위험할 수 있는 문제 해결 정보.

• 드문 경우에 대한 정보. 사용자가 상황을 접할 가능성이 아무리 낮더라도 모든 트러블슈팅 정보를 포함합니다.

이런 유형의 콘텐츠는 다른 사람들에게 도움이 될 수 있으며, 이점이 위험보다 큽니다. 이 규칙에 예외가 있다고 생각되면 기술 문서 팀에 문의하세요.

GitLab Support는 자체 트러블슈팅 콘텐츠를 유지 관리합니다.

형식#

트러블슈팅은 소개형(introductory), 작업형(task), 참조형(reference) 세 가지 유형 중 하나일 수 있습니다.

소개형 주제#

이 주제는 페이지의 트러블슈팅 섹션을 소개합니다. 예를 들어:

## Troubleshooting

When working with <x feature>, you might encounter the following issues.

트러블슈팅 작업형#

제목은 표준 작업형과 유사해야 합니다. 예를 들어, "Run debug tools" 또는 "Verify syntax."

트러블슈팅 참조형#

이 주제는 메시지를 포함합니다. 일관성을 위해 임시 해결책에는 workaround를, 영구적 해결책에는 resolution 및 resolve를 사용하세요. 예를 들어:

### The message or a description of it

You might get an error that states <error message>.

This issue occurs when...

The workaround is...

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

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

트러블슈팅 주제 제목#

트러블슈팅 참조형 주제의 제목:

• 출력 메시지의 일부라도 포함하는 것을 고려하세요. 메시지가 70자를 초과하는 경우, 가장 중요한 텍스트를 포함하거나 메시지를 설명하세요. line-length markdownlint 규칙을 비활성화하지 마세요.

• 오류 메시지가 포함된 제목을 줄여야 하는 경우, 줄임표(...)를 사용하여 일부 세부 정보가 제거되었음을 나타내세요.

• 제목 시작 부분에 메시지 유형을 명시하세요. 이는 심각도를 나타냅니다. 예를 들어, Error:, Warning:.

• 제목에 링크를 사용하지 마세요.

전체 메시지를 제목에 넣지 않는 경우, 본문 텍스트에 포함하세요. 예를 들어:

## Error: `... unexpected disconnect while reading sideband packet`

Unstable networking conditions can cause Gitaly to fail when trying to fetch large repository
data from the primary site. Those conditions can result in this error:

```plaintext
curl 18 transfer closed with outstanding read data remaining & fetch-pack:
unexpected disconnect while reading sideband packet

To resolve this issue...

## Rails 콘솔 쓰기 함수

트러블슈팅 제안이 GitLab 인스턴스의 데이터를 변경하는 함수를 포함하는 경우,
다음 경고를 추가하세요:

```

트러블슈팅 페이지 유형#

페이지에 트러블슈팅 주제가 5개 이상 있는 경우, 별도의 트러블슈팅 페이지를 만드세요.

다음 규칙을 따르세요:

• 페이지 이름을 Troubleshooting <feature>로 지정하세요.

• 왼쪽 탐색에서는 Troubleshooting 단어만 사용하세요.

• 탐색 파일에서 새 페이지를 속한 기능 아래에 중첩하세요.

• 파일 이름을 <feature>_troubleshooting.md로 지정하세요.