OSS 프로젝트 - LocalizeFlow Docs

오픈 소스 프로젝트는 종종 하나의 README로 시작합니다.

커뮤니티가 성장함에 따라 여러 나라의 기여자들이 번역을 요청합니다.
README.ko.md, README.fr.md 등 다른 언어 파일을 수동으로 관리하는 것은 빠르게 어려워집니다.

Localizeflow는 기존 워크플로를 변경하지 않고도 풀 리퀘스트를 통해 README와 문서를 자동으로 동기화합니다.

전제 조건

GitHub 계정.
번역하려는 GitHub 조직 또는 저장소에 대한 접근 권한.

GitHub 조직에 Localizeflow GitHub 앱을 설치하려면 조직 소유자 권한이 필요합니다.
소유자가 아닌 경우, 이 페이지를 소유자에게 공유하고 설치 단계를 완료해 달라고 요청하세요.

저장소 준비 (선택 사항)

이미 수동 번역(README.ko.md 또는 docs/ja/ 등)을 유지 관리 중이라면, 자동화를 활성화하기 전에 제거하여 기본 언어가 단일 진실 소스가 되도록 하세요.

Localizeflow GitHub 앱 로그인 및 설치

**localizeflow.com**에 접속하세요.
GitHub로 로그인하세요.
Install in new account를 선택하세요.
Localizeflow GitHub 앱을 설치할 계정—개인 계정 또는 관리 중인 조직을 선택하세요.

GitHub 조직에 앱을 설치하려면 조직 소유자 권한이 필요합니다.
소유자가 아닌 경우, 이 페이지를 소유자에게 공유하고 설치 단계를 완료해 달라고 요청하세요.
Localizeflow가 접근할 저장소를 선택한 후 Save를 선택하세요.
Localizeflow 대시보드로 리디렉션됩니다.

조직 소유자가 Localizeflow GitHub 앱을 설치했다면, 사이드바의 Team 페이지에서 이메일 초대 또는 초대 링크 공유를 통해 팀원을 초대할 수 있습니다.

나중에 저장소를 추가하려면 헤더에서 계정을 선택하고 + Add more repositories를 선택하세요.

저장소를 Localizeflow와 연결

Localizeflow 홈 페이지에서 + Connect repositories를 선택하세요.
하나 이상의 저장소를 선택한 후 Save를 선택하세요.
연결된 저장소는 Home 및 Repositories 페이지 모두에 나타납니다.

첫 번째 번역 실행

저장소를 연결한 후 대시보드에서 선택하여 온보딩 마법사를 엽니다.

마법사는 2분 이내에 완료되며 다음을 정의합니다:

사용할 언어
변경하지 말아야 할 용어

단계 1: 언어 및 대상 브랜치

대상 언어

하나 이상의 대상 언어를 선택하세요.
Localizeflow는 선택한 각 언어에 대해 풀 리퀘스트를 생성하고 유지합니다.

언어는 나중에 저장소 설정에서 수정할 수 있습니다.

대상 브랜치

번역 풀 리퀘스트를 열 브랜치를 선택하세요.

대부분의 경우 기본 브랜치(예: main)를 사용합니다.
스테이징 또는 문서 브랜치를 사용하는 경우 해당 브랜치를 선택하세요.

비워두면 Localizeflow가 저장소의 기본 브랜치를 사용합니다.

Continue를 선택하세요.

단계 2: 출력 위치

프로젝트 유형 선택

대부분 오픈 소스 저장소는 다음으로 구성됩니다:

루트의 README.md
간단한 docs/ 폴더
문서 프레임워크 없이 마크다운 기반 콘텐츠

선택:

Simple repository

소스 및 대상 경로를 수동으로 정의하고 싶다면 Structured documentation site를 선택하여 직접 번역 그룹을 구성할 수 있습니다.

번역 옵션

추가 처리를 활성화할 수 있습니다:

Markdown (기본)
이미지 번역 (베타, 문서 사이트에는 불가)
노트북 번역
번역에 면책 조항 추가

대부분 오픈 소스 프로젝트에는 다음을 권장합니다:

README 중심 저장소에는 Markdown만
Jupyter 노트북이나 예제가 포함된 경우 Markdown + 노트북 번역

이렇게 하면 커뮤니티용 문서 접근성을 유지하면서 유지 보수 부담을 줄일 수 있습니다.

Continue를 선택하세요.

단계 3: 용어집 및 최종 확인 사항

자동화 시작 전 번역 중 변경하면 안 되는 용어를 정의할 수 있습니다.

용어집 만들기 (권장)

용어집은 다음을 보호합니다:

제품명
회사명
기능명
법률이나 컴플라이언스 문구

한 줄에 한 개 용어를 추가하세요. 각 용어는 생성된 번역에서 변경되지 않습니다.

예:

Localizeflow
Co-op Translator
GitHub App

나중에 편집하거나 추가 용어집을 첨부할 수 있습니다.

최종 확인 사항

Save & Finish를 선택하기 전에 다음을 확인하세요:

소스 경로가 마크다운 파일 위치와 올바르게 일치하는지.
기존 수동 번역이 생성 결과와 충돌하지 않는지.
필요 시 오래된 번역 폴더가 제거됐는지.

이 체크리스트는 중복 파일과 깨진 링크를 방지하는 데 도움이 됩니다.

자동화 시작

Save & Finish를 선택하면 저장소 상세 페이지로 리디렉션됩니다.

번역은 자동으로 시작되지 않습니다.

자동 번역을 시작하려면:

Automate를 선택하세요.
Localizeflow가 저장소를 스캔합니다.
번역 작업이 생성됩니다.
임시 풀 리퀘스트가 자동으로 열립니다.

자동화는 기본적으로 비활성화되어 있습니다.

활성화되면 Localizeflow가 원본 README 또는 문서가 변경될 때마다 번역 풀 리퀘스트를 자동으로 열고 업데이트합니다.

기여자는 다른 풀 리퀘스트처럼 번역 변경을 검토할 수 있습니다.

언제든지 Pause automate를 사용하여 자동화를 일시 중지할 수 있습니다.