TRANSLATE_GUIDELINE.md

칼리 리눅스 문서 번역 가이드라인

아래 내용을 따르지 않았을 시 PR이 거절될 수 있어요.

1. OS 명칭과 일부 패키지 이름(ex. Kali Linux, Python 등)은 영문 대신 한글로 표기해 주세요. 단, 아래와 같은 경우에는 영문 표기를 유지하거나 바꾸지 말아야 합니다.

   1. 사용자 계정 이름, 비밀번호 및 명령어에 사용되는 경우
   2. URL에서 사용되는 경우
   3. 정책 문서인 경우
   4. 문서 내에 감사의 표시 또는 출처의 목적으로 이름이 표시된 경우
   4. 한글 표기가 자연스럽지 않거나 문서상에서 영문 표기를 써야하는 경우 (예: nethunter - "CARsenal")
   

2. 상단에 있는 title, description, author, 번역 헤더들은 임의로 수정해서는 안되며 번역 속성을 추가하려는 경우에는 기존 틀을 유지하여야 합니다.

   올바른 예시:

   ---
   title: "문서 제목"
   description: "문서 설명"
   author: ["문서 작성자"]
   ---

   틀린 예시:

   ---
   title:
     - "문서 제목"
   description:
     - "문서 설명"
   author:
     - 문서 작성자
   ---

3. 사람들이 이해하기 어려운 내용의 경우 아래와 같은 박스를 생성하여 작성해 주세요.

   {{% notice info %}}
   
   내용
   
   {{% /notice %}}
   

4. 가능하면 GitHub 내 에디터 대신 VSCode를 이용하여 작업 후 PR을 보내주세요.

5. AI를 사용하여 작업을 자동화 하는 경우 AI가 실수하지 않게 프롬프트를 잘 작성해주세요. 아래는 예시입니다. 상황에 맞게 바꿔서 사용하세요. 만약 이보다 더 좋은 프롬프트가 있다면 알려주세요.

   1. 사람들이 이해하기 어려울 수 있는 내용의 경우 아래와 같은 방식으로 추가 설명을 하도록 해야 합니다.
   {{% notice info %}}
    
    내용
    
    {{% /notice %}} 까지가 예시입니다.
   
   2. about-us 같은 링크는 kali.org/about-us로 바꿔야 합니다. 또한 칼리 공식 문서 링크인 kali.org/docs로 된 링크들은 kali.org를 없애고 /docs만 남기도록 합니다.
   3. 문서 내 목차 이동 링크의 경우(#내용) 대소문자가 모두 일치하도록 해야 합니다.
   4. 번역할 때 문서 메타데이터에 '번역: ["사용자이름"]'을 넣도록 하세요. 다른 데이터는 수정하지 않습니다.
   5. 영어 원문에서 OS 명칭과 한글 표기가 가능한 일부 패키지명은 한글로 표기해야 하나 특정 인물의 경우 그대로 유지하여야 합니다. (Kali Linux의 경우 칼리 리눅스, Python의 경우 파이썬과 같이)