Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ko] 한국 첫 기여자들을 위한 가이드라인 #827

Closed
10 of 11 tasks
hochan222 opened this issue May 12, 2021 · 18 comments
Closed
10 of 11 tasks

[ko] 한국 첫 기여자들을 위한 가이드라인 #827

hochan222 opened this issue May 12, 2021 · 18 comments
Assignees
Labels
l10n-ko Issues related to Korean content.

Comments

@hochan222
Copy link
Member

hochan222 commented May 12, 2021

현재 이슈는 공식 가이드가 존재하기 전에 작성된 이슈입니다. 현재는 MDN 공식 안내서가 작성되어 있습니다. 해당 안내서를 우선으로 참고 부탁드립니다.






Progress


오픈소스 참여의 장벽을 없애고자 한국 가이드라인 작성전에 먼저 이슈를 생성하게됐습니다. 예시는 현재 아무런 번역작업이 이뤄지지 않은 React이지만 다른 문서로 진행하셔도 좋습니다.

먼저, @JaeSeoKim 님께서 같이 작성하는데 도움을 주셔서 감사드립니다.

한국 첫 기여자들을 위한 가이드라인 (Git Gui 응용법) << 클릭

진행전 다운로드 해야할 목록

진행 방법

  1. MDN 한국 문서중에 오타/오역이나 영문 버전과 비교했을때 번역이 안된 부분을 찾는다.

(같은 한국페이지에서 ko를 en-US로 바꾸면 영어 페이지가 나와요!)

단어 한개! 한줄 번역도 좋아요! 어렵지 않습니댜!

오늘은 React docs 한줄 번역을 먼저 해봐요!

  • MDN 한국

https://developer.mozilla.org/ko/docs/Web

  • MDN 미국

https://developer.mozilla.org/en-US/docs/Web

  1. 아래 두 레파지토리를 git fork 후 clone 한다.

image

git clone https://github.com/[본인 github ID]/translated-content
git clone https://github.com/[본인 github ID]/content
  • 예시
git clone https://github.com/hochan222/translated-content
git clone https://github.com/hochan222/content

원문 content가 있는 repository입니다. en-US 버전이 원문을 기반으로 10개가 넘는 로케일에서 자체 번역을 합니다. (translated-content의 수정사항을 확인하기위해 git clone 을 받습니다. )

  • translated-content

한국 locale의 content가 있는 repository입니다. 한국 번역 문서들이 있으며 저희들의 변경사항이 저장되는 공간입니다.

  1. translated-content 폴더에 들어가서 브랜치를 생성해줍니다.

[comment]에는 자신의 수정사항에 대해 간략하게 적어줍니다.

git checkout -b [comment]
  • 예시
git checkout -b ko_type_err_promise
  1. content 폴더에 들어갑니다!
cd content
  1. content폴더 내부에 .env 파일을 만들어준뒤 translated-content repo 경로를 추가해줍니다.

메모장, 에디터를 이용해서 .env 파일을 content 폴더 내부에 생성합니다.

.
├── translated-content
├── content
|   ├── .github
|   ├── files
|   ├── pr-lint
|   ├── rfcs
|   └── scripts
|   └── .editorconfig
|   └── .env       <==== content 폴더 내부에 만들어준다.
|   ├── ...
└── ...

만든 후, .env 파일 안에 다음 옵션을 작성한다.

.env 파일에 translated-content repo 경로를 작성해줍니다.

CONTENT_TRANSLATED_ROOT=/path/to/translated-content/files
  • 예시 (사용하는 editor에따라 옵션을 추가할 수 있어요! 아래 예시는 vscode)
CONTENT_TRANSLATED_ROOT=/Users/tonybyeon/Desktop/translated-content/files
EDITOR=code
  1. content 폴더에서 yarn 실행

package.json 파일이 있는 경로에서 yarn 명령어를 실행해야합니다.
컴퓨터에 yarn이 다운로드 되어있어야합니다! 되어있지않다면 아래 링크를 참고해주세요!
#827 (comment)

yarn install
yarn start
  1. http://localhost:5000/ko/ 접속 후 원하는 페이지에 들어갑니다! (현재는 5042로 포트 바뀌었습니다.)

원하는 페이지의 주소는 아래 링크페이지를 수정하고 싶으면
https://developer.mozilla.org/ko/docs/Web/JavaScript/Reference/Global_Objects/Array
아래 링크와 같이 ko 뒷부분을 그대로 옮겨주시면 됩니다.
http://localhost:5000/ko/docs/Web/JavaScript/Reference/Global_Objects/Array

( 만약에 아래와같이 뜬다면! 새로고침 한번만 눌러주세요! )

( .env 파일에서 EDITOR=code 를 설정하셨으면 open in your editor를 누르면 그 페이지가 vscode에서 켜집니댜! )

  1. http://localhost:5000/ko/docs/Learn/Tools_and_testing/Client-side_JavaScript_frameworks/React_getting_started 로 접속합니다.!
    자신이 편한 방법(Open in your editor, Quick-edit)을 통해 번역을 진행하여 주시면 됩니다.

여기서는 Quick-edit 방법으로 진행하겠습니다.

현재 제목 및 본문이 번역이 안되어 있기 때문에 제목을 수정을 하도록 하겠습니다!

이때 한국어 문서 번역 스타일 가이드, 번역 가이드 를 참고 하여서 수정해주시면 더욱 좋습니다.

"한국어 문서 번역 스타일 가이드"는 모질라 전체 번역 가이드로 MDN 가이드는 https://github.com/mdn/translated-content/blob/main/docs/README.md 에 존재합니다. MDN 가이드를 우선으로 참고 부탁드립니다.

번역을 하여 수정 후 아래에 있는 Save 버튼을 눌러서 저장을 합니다.

터미널로 돌아가서 아래와 같이 번역한 문서를 확인을 하고 git add를 합니다.

git이 무엇인지 잘 모르신다면 다음 링크를 참고해주세요!
https://backlog.com/git-tutorial/kr/intro/intro1_1.html

이제 방금 수정한 항목에 대한 커밋을 합니다.

(이 때 무엇에 대해서 수정을 하였는지 메세지를 작성하여 주시면 됩니다.)

이제 fork된 repo로 push를 한후 fork된 github 주소로 들어갑니다.

이제 위에 보이는 contribute 버튼을 눌러서 pr를 create 합니다.

아래와 같이 번역을 한 내용에 대하여 작성을 하여서 다른 사람들이 확인을 할 수 있도록 합니다.

작성을 완료하여 pr를 날리게 되면 기여에 참여하실 수 있습니다.

@hochan222 hochan222 added the l10n-ko Issues related to Korean content. label May 12, 2021
@hochan222 hochan222 assigned cos18 and hochan222 and unassigned cos18 May 12, 2021
@JaeSeoKim
Copy link
Contributor

JaeSeoKim commented May 12, 2021

6. yarn 실행 시 오류가 나시는 분 필독!

개발 서버를 띄우기 전에 Node.js 와 함께 yarn를 설치 하셔야 합니다!

https://github.com/mdn/translated-content#making-contributions
https://nodejs.org/ko/
https://yarnpkg.com/

@hochan222 hochan222 changed the title [ko] 한국 처음 기여자들을 위한 가이드라인 [ko] 한국 첫 기여자들을 위한 가이드라인 May 12, 2021
@hwang1588
Copy link
Contributor

Git Gui 를 통해 참여 할 수 있는 가이드라인도 있으면 좋을 것 같습니다

@hochan222
Copy link
Member Author

Git Gui 를 통해 참여 할 수 있는 가이드라인도 있으면 좋을 것 같습니다

제가 하고있는 작업이있어서 당장은 진행을 못할것 같습니댜. 혹시 관심있으시면 도와주실 수 있으신가요?

@hwang1588
Copy link
Contributor

hwang1588 commented May 13, 2021

Git Gui 를 통해 참여 할 수 있는 가이드라인도 있으면 좋을 것 같습니다

제가 하고있는 작업이있어서 당장은 진행을 못할것 같습니댜. 혹시 관심있으시면 도와주실 수 있으신가요?

음..우선 흐름을 먼저 파악해야 할거 같은데 조언이 필요합니다~!

  • 내려받기
  1. mdn/translated-content (원격) 리포에서 fork
  2. 개인 깃허브 리포지터리(원격) 로 소스를 가져옴
  3. fork한 리포지터리를 clone한 뒤 Git Gui를 통해 개인 컴퓨터(로컬) 에 내려받아 편집

  • 업로드 (pr)
  1. 로컬에 내려받아 편집이 끝난 파일을 내 리포지터리에 push
  2. 개인 깃허브 리포지터리(원격)에 업로드한 파일이 업데이트 됨
  3. 개인 리포지터리에서 mdn/translated-content (원격) 리포에 PR

이 순서로 진행하면 될까요?

@hochan222
Copy link
Member Author

hochan222 commented May 13, 2021

네! 맞습니다. 만약 수정한 코드에 대해서 브라우저에서 확인이 필요하면 위에 이슈대로 진행하여 확인하면 될것같습니다.

추가적으로 이슈 내용중

( .env 파일에서 EDITOR=code 를 설정하셨으면 open in your editor를 누르면 그 페이지가 vscode에서 켜집니댜! )

이 부분이 있는데 Git Gui가 editor를 이용한 편집을 의미하면 나중에 이 사이부분에 추가해도 좋을것같습니다!

@alattalatta
Copy link
Member

alattalatta commented May 14, 2021

용어 가이드라인 만드실 때 도움이 될까 하여, 위키에서 참고서 쪽을 주로 작업하면서 사용했던 용어입니다.

MozKR 슬랙도 죽어있어서 제대로 논의할 곳도 없었고 문서를 따로 남긴 것도 아니지만... 위키 후기에 이르러서는 한국어 편집 히스토리 세 페이지를 혼자 채운 적도 있으니 참고서 한정해서는 꽤 큰 비중이 아닐까 해요. Learning은 거의 건드리지도 못해서 차이가 큽니다.

공통

브랜드 이름은 번역하지 않았습니다.

- 자바스크립트
- 씨에스에스
- 모질라
+ JavaScript
+ CSS
+ Mozilla

"무슨무슨 값" (numeric value, integer value, ...) 같은 경우, "무슨무슨"과 "값"을 붙여서 쓰면 대개 발음이 [무슨무슨깝]이 되어 사이시옷이 필요합니다. 그런데 되게 어색(정숫값, 소숫값)하게 보이므로 사이시옷을 빼기 위해 항상 띄어서 썼습니다. (정수 값, 소수 값) 아직 정숫값/소숫값으로 되어있는 부분은 띄어쓰기로 결정하기 전에 했던 부분이구요, "반환 값" 같은 경우 붙여써도 사이시옷의 여지가 없지만 통일하기 위해서 똑같이 띄어서 썼습니다.

Deprecated/Deprecation 같은 경우 마지막까지 정하지 못했습니다. "더 이상 사용하지 않는"으로 길게 번역한 경우도 있고... 다만 Obsolete에 해당하는 "폐기"로는 바꾸지 않았습니다. 영어 편집 지침도 모든 Obsolete을 Deprecated로 바꾸는 것이고, Deprecated 되더라도 하위호환을 위해 API가 남아있는 경우가 대다수니까요.


  • Attribute: 특성
  • Property: 속성
    • Attribute/Property 구분은 MSDN 번역에서 가져왔습니다. 보통 둘 다 속성이라고 부르는 것은 알고 있으나 그러면 정확하게 전달하기 힘들더라구요.

  • Object: 객체
  • Entity: 개체
    • Object/Entity도 구분해야 할 필요가 있었으므로 검색했을 때 많이 쓰이는 표기법을 택했습니다.

  • Method: 메서드
    • 메소드도 많이 쓰지만, 메서드가 표준 외래어 표기법입니다.

  • Override: 재정의
    • Overload의 경우 영문 페이지에서도 거의 사용하고 있지 않아서 정해둔 것이 없습니다. (참고)

  • Expression: 표현식 또는 식
  • Statement: 명령문 또는 문
    • 그냥 "문"이라고 하면 무슨 소리인지 이해하기 어려운 상황이 좀 있었습니다.

  • Content(s): 콘텐츠
    • "내용"이나 기타 한국어 단어로 번역하지 못할 때에 한정해서, "컨"텐츠 대신 사용합니다.

  • Global: 전역
    • 전역 객체, 전역 특성, 전역 맥락...

  • Psuedo-: 의사-
    • Pseudo-code를 의사 코드라고는 하지만 가상 코드라고 하지는 않듯, Psuedo-element는 가상 요소가 아닌 의사 요소로 번역했습니다.

  • Rendering: 렌더링
    • 여러가지로 해보다가 번역하지 않는 것이 제일 나아보였습니다. "화면에 그리는 메서드"처럼 시각적으로 표시하는 것이 확실하면 "그리다"로 바꾼 부분은 있습니다.

  • Regular expression: 정규 표현식
    • 정규식이라고 사용한 경우도 정규 표현식으로 바꿨습니다.

  • Grammar: 문법
  • Syntax: 구문
    • Syntax를 문법이라고 번역한 경우 구문으로 바꿨습니다.

  • Origin: 출처
    • Cross origin이면 교차 출처입니다.

  • Glossary: 용어 사전

  • Reference: 참고서

  • Tutorial: 자습서

    • 이렇게 되어있던 것을 그대로 사용했습니다.
  • Specification: 명세

    • 사양, 스펙, 명세를 명세로 바꿨습니다.
  • (헤딩) Accessibility concerns: 접근성 고려사항

  • (헤딩) Example: 예제

    • 헤딩으로 사용하는 Example에 예시/예제 혼용하던 것을 예제로 바꿨습니다.
    • 본문에서는 혼용했습니다.
  • (헤딩) See also: 같이 보기

    • 함께 보기, 외부 링크, 참고 링크, ... 를 같이 보기로 바꿨습니다.

  • Boolean: 불리언
  • Class: 클래스
  • Context: 맥락
  • Document: 문서
  • Element: 요소
  • Enumerated: 열거형
  • Literal: 리터럴
  • Primitive: 원시 (값)
  • Section: 구획
  • User agent: 사용자 에이전트

CSS

명세 이름은 번역하지 않았습니다.

- CSS 글꼴 모듈 레벨 4
+ CSS Fonts Module Level 4

명세 이름이 본문에 나오더라도 번역하지 않았습니다. e.g "<number> 구문은 CSS Fonts Level 4가 추가했습니다."


  • At-rule: @규칙
    • 앳룰, 앳 규칙, @규칙 셋 다 이상한데 대안이 없었어요.

  • Formal syntax: 형식 구문
    • Formal grammar가 형식 문법이므로.

  • Shorthand property: 단축 속성
  • Longhand property: 본디 속성
    • 본디 속성의 경우 계속 이렇게 되어있던 것을 사용했습니다.


  • Box: 박스
  • Block: 블록
  • Inline: 인라인
  • Flow: 플로우 (레이아웃 방식일 경우에 한정)
  • Flexbox: 플렉스박스
  • Grid: 그리드
    • 레이아웃 방식은 굳이 대체하지 않았습니다. 다만 Flow는 플로우가 아닌 "플로"가 되어야 맞을 것 같습니다...

  • Border: 테두리
  • Margin: 바깥 여백
  • Padding: 안쪽 여백

API/JavaScript

  • Argument/Parameter: 매개변수
    • 영문판 편집 지침부터 Argument 대신 Parameter만 사용하는 것이므로 인수/인자 대신 매개변수 하나로 통일했습니다.

  • Handler: 처리기
  • Listener: 수신기
    • 이벤트 처리기와 이벤트 수신기에 사용했습니다.

  • Iterate: 순회
    • Loop/Repeat과 구별하기 위해서 "순회"로 번역했었습니다. ("배열을 반복합니다." 대신 "배열을 순회합니다.")
    • Iterator는 반복기/반복자가 아닌 순회기/순회자가 됩니다.
    • 그런데 일반적으로 "반복" 용례가 훨씬 많아서 잘 모르겠네요.

  • Prototype: 프로토타입
    • 원형이라고 번역한 곳도 바꿨습니다. e.g. 함수 원형 -> 함수 프로토타입

  • Resolve: 이행
  • Fulfilled: 이행(함)
  • Reject: 거부
  • Pending: 대기
  • Settled: 처리
    • Promise 용어입니다. 설명까지만 만지고 그 아래로는 못해서 이 문서 안에서도 다른 부분이 많아요.

  • Scope: 스코프
    • 언어 기능으로서의 scope (e.g. 새로운 스코프를 생성)로 한정했었던 것 같습니다. 확실하게 정해두진 않았네요...

  • Callback: 콜백
  • Interface: 인터페이스
  • Mixin: 믹스인

HTTP

  • (Request/Response) Body: (요청/응답) 본문
  • Idempotent: 멱등성

@hochan222 hochan222 linked a pull request May 19, 2021 that will close this issue
@hochan222 hochan222 removed a link to a pull request May 19, 2021
@logic-finder
Copy link
Contributor

logic-finder commented May 19, 2021

안녕하십니까? 처음 뵙겠습니다. 초보인 입장에서 첫 풀 리퀘스트를 하기까지 어려웠던 부분을 적어보고자 합니다 (사실 본문의 내용을 한번에 보고 이해할 정도의 수준이 아닌 사람이 mdn문서 번역을 시도했다는게 이상하긴 하지만요).

  1. yarn 설치 시 구체적으로 어떻게 해야 하는 지 설명이 있다면 좋을 것 같습니다.
  2. 본문 3번에서, id와 comment에 무엇을 적어야 하는지에 대한 설명이 있다면 좋을 것 같습니다.
  3. 본문 5번에서, .env파일을 어떻게 만드는지에 대한 설명이 있다면 좋을 것 같습니다.
  4. 그리고 .env파일을 (메모장 또는 다른 프로그램으로) 열어서 그 안에 경로를 지정해야 된다는 내용이 있다면 좋을 것 같습니다.
  5. 본문 6번에서 (cmd에서) yarn을 어떤 폴더에서 실행해야 되는지에 대한 설명이 있다면 좋을 것 같습니다.
  6. 본문 7번에서 원하는 페이지의 주소는 어떻게 구하는지에 대한 설명이 있다면 좋을 것 같습니다.

이상입니다. 좋은 가이드라인 작성해주셔서 감사합니다.

@gidongkwon
Copy link
Contributor

MDN Korea 카톡방의 초보님이 만나신 중간의 깃 에러(Permission to mdn/transl... denied) 와 관련해서 문서에 좀 더 나아질 부분이 있는것 같아 제안드립니다.

진행 방법 2번의 아래 두 레파지토리를 git fork 후 clone 한다. 부분에서 포크를 유도하셨지만 아래 클론 링크 부분에는 mdn 저장소 링크가 걸려있는데요, (아래 이미지 참조)
image

처음 하시는 분들이 이걸 그대로 따라하시게되면 본인의 fork가 아니라 mdn 저장소를 클론받게되어 나중에 8번을 진행할 때 Permission denied 메시지를 받게 됩니다. 링크를 https://github.com/[본인계정]/content https://github.com/[본인계정]/translated-content 식으로 치환을 해야 하도록 유도하던지 혹은 링크가 아예 없는 대신 좀 더 자세한 설명이 같이 붙어있으면 좋을 것 같습니다.

@hochan222
Copy link
Member Author

피드백 모두 감사합니다! 주신 피드백 모두 반영했습니다. 많이 부족하지만 끝까지 보고 기여해주셔서 감사합니다. 모두 좋은 하루 보내세요 :)

@hochan222
Copy link
Member Author

hochan222 commented May 30, 2021

#878

한국 가이드라인이 머지가 되어서 이슈 닫겠습니다. 추후에 수정/추가사항이 있으면 https://github.com/mdn/translated-content/blob/main/docs/ko/translation-guide.md 에 추가해주세요 :)

@hwang1588
Copy link
Contributor

#878

한국 가이드라인이 머지가 되어서 이슈 닫겠습니다. 추후에 수정/추가사항이 있으면 https://github.com/mdn/translated-content/blob/main/docs/ko/translation-guide.md 에 추가해주세요 :)

확인했습니다! 감사합니다.

@thewoowon
Copy link
Contributor

Once started, a live preview is available at http://localhost:5042/.

일단 실행되면 http://localhost:5042/에서 실시간으로 미리보기 사용이 가능합니다.

http://localhost:5000/으로 시작하니 안되서 보니 이렇게 되어 있네요.

@hochan222
Copy link
Member Author

hochan222 commented Jan 26, 2023

정보 남겨주셔서 감사합니다!

더불어 .env 파일에서 SERVER_PORT로 원하는 포트 지정할 수 있습니다!

# .env 파일
CONTENT_TRANSLATED_ROOT=/Users/<PATH_TO_TRANSLATED-CONTENT>/translated-content/files
// ...

SERVER_PORT=5042

번역 가이드 링크도 아래 링크로 변경되어 첨부 드립니다 :)

@rbals0445
Copy link
Contributor

rbals0445 commented Aug 5, 2023

@hochan222 님, mac에서는 editor에서 수정하기가 작동하지 않더라구요.

mac 사용자의 경우 command + shift + p를 누르고 code를 설치해주어야 합니다.

image

문제의 원인은 @mdn/yari에서 'open-editor' 라이브러리를 사용하는데, execa(‘code ~~’) 를 통해서 프로세스를 실행시킬때 MAC은 code를 인식할수 없어서 생기는 문제더라구요.

vsc는 code 명령어를 통해서 바로 편집기를 열 수 있습니다.


추가로, 가끔 code를 이미 설치했는데 editor를 열 수 없다고 나오는 경우가 있습니다.

그때는 아래 명령어를 입력하신후에 다시 code를 설치하시면 됩니다.

cd /usr/local/bin
sudo rm -rf code

@nag0124
Copy link
Contributor

nag0124 commented Mar 17, 2024

@hochan222 님, 번역 가이드에 관련해서 의견 남기기 위해 코멘트 작성했습니다.

제가 처음으로 MDN에 기여를 하고자 이 이슈 본문에 있는 진행 방법을 따라서 번역을 했습니다.
제가 참고한 번역 가이드는 한국어 문서 번역 스타일 가이드, 번역 가이드이고요.
그리고 PR을 열었는데(#18643) 리뷰어 분께서 새로운 번역 가이드를 알려 주셨습니다.
혹시나 제가 놓친 부분이 있어서 이슈를 다시 보니 댓글에 새로운 번역 가이드가 있었습니다.

그래서 이슈 본문의 번역 가이드 링크를 교체 혹은 추가하는 건 어떨까 해서 코멘트 남깁니다.
새로 MDN에 기여하실 분들이 이 이슈를 많이 참고할 것이라고 생각합니다.
다만 새로운 번역 가이드가 본문에 있지 않고 댓글에 달려 있어 저처럼 현재 가이드와 맞지 않은 번역을 할 가능성이 있고요.
이슈 본문의 번역 가이드를 아직 사용하신다면 링크를 본문에 추가하거나, 번역 가이드가 변경됐다면 링크도 변경하는 건 어떨까요?

@hochan222
Copy link
Member Author

hochan222 commented Mar 18, 2024

@nag0124 님 안녕하세요. 먼저, 불편함을 드려서 정말 죄송합니다.

현재 이슈는 공식 가이드가 존재하기 전에 작성된 이슈입니다. 현재는 MDN 공식 안내서가 작성되어 있습니다. 해당 안내서를 우선으로 참고 부탁드립니다.

MDN ko 공식 안내서에는 현재 이슈 본문에 있는 세부 다운로드 후 기여 방법에 대한 안내가 부족하여, 영역 하단에 "첫 기여자분들을 위해 다음 issues 827에 기여 방법을 작성했습니다. 참고해주세요." 문장에 현재 이슈 링크를 남겨두었는데, 이로인해서 불편함을 드린것 같아 죄송합니다.

그래서 이슈 본문의 번역 가이드 링크를 교체 혹은 추가하는 건 어떨까 해서 코멘트 남깁니다.

현재 이슈 접근 경로가 궁금합니다. 혹시 MDN ko 공식 안내서의 "첫 기여자분들을 위해 다음 issues 827에 기여 방법을 작성했습니다. 참고해주세요." 문장의 이슈 링크를 통해서 접근하셨을까요?

새로 MDN에 기여하실 분들이 이 이슈를 많이 참고할 것이라고 생각합니다. 이슈 본문의 번역 가이드를 아직 사용하신다면 링크를 본문에 추가하거나, 번역 가이드가 변경됐다면 링크도 변경하는 건 어떨까요?

네! 본문 첫줄에 별도의 안내문구 추가 및 본문 중간 내용 수정 하겠습니다.

제가 참고한 번역 가이드는 한국어 문서 번역 스타일 가이드, 번역 가이드이고요.

참고차, 번역 가이드의 아래 경로에 말씀해주신 새로운 번역 가이드 링크 안내가 되어있습니다.

(1) https://developer.mozilla.org/en-US/docs/MDN/Community/Contributing/Translated_content
image

(2) https://github.com/mdn/translated-content/blob/main/docs/ko/README.md
image

(3) https://github.com/mdn/translated-content/blob/main/docs/ko/README.md
image

앞서 말씀드린바와 같이 MDN ko 공식 안내서에는 현재 이슈 본문에 있는 세부 다운로드 후 기여 방법에 대한 안내가 부족한데, 여유가 되신다면 해당 부분 /docs/ko/guides/~~.md로 기여주셔도 좋을 듯합니다!

소중한 의견 남겨주셔서 정말 감사드립니다. 좋은 하루 보내세요 :)

cc. @mdn/yari-content-ko

@nag0124
Copy link
Contributor

nag0124 commented Mar 19, 2024

@hochan222 님, 정성스런 답변 감사합니다! 덕분에 MDN 가이드에 대해서 상세히 알게 되었습니다.

그리고 위의 댓글에서 누락된 생각을 적겠습니다.

현재 이슈 접근 경로가 궁금합니다. 혹시 MDN ko 공식 안내서의 "첫 기여자분들을 위해 다음 issues 827에 기여 방법을 작성했습니다. 참고해주세요." 문장의 이슈 링크를 통해서 접근하셨을까요?

hochan222님의 답글을 읽고 제 글을 다시보니 제 글이 자기중심적이었다는 생각이 듭니다. 근거를 생략한 부분이 있어 맥락을 잡기 힘드셨을 것 같은데 불편함을 드려서 죄송합니다.
그리고 이 이슈에 어떤 경로로 접근했는지 적어보겠습니다.

  1. http 쿠키 한글 페이지에서 번역할 부분이 있어 해당 페이지 하단의 Learn how to contribute를 클릭했습니다.
  2. 그 페이지는 한글 번역 기여에 관한 페이지가 아니라 원문(es 버전)에 관한 기여 설명 페이지라는 생각이 들었습니다.
  3. 구글에 'MDN 기여하기'라는 키워드로 검색하고 블로그 글에서 지금 이슈를 접근했습니다.
  4. 이슈의 가이드를 따라서 번역했습니다. (블로그에는 변경된 번역 가이드에 관한 링크도 있었는데 문서의 주소가 변경되어 못찾았습니다.)

제가 조금 더 공식 문서를 들여다 봤어야 했는데, 빨리 기여하고 싶은 마음이 컸습니다. 친절한 답변 감사드립니다.

새로 MDN에 기여하실 분들이 이 이슈를 많이 참고할 것이라고 생각합니다.

제가 이전에 적은 댓글에서 쓴 문장입니다. 제가 이렇게 생각한 이유는 처음 기여를 하려는 분들이 "블로그를 통해서 MDN 한글 번역을 시작하지 않을까"라는 생각 때문이었습니다.
먼저, 제가 그랬듯이 Learn how to contribute로 접근해서 에서 한글 번역 관련 정보를 얻기는 힘들어 보입니다.
Learn how to contribute -> Contribute page -> Translated content -> translation guide -> Korean translation guide / 한국 번역 지침을 타고 들어가 한국 번역 지침을 찾을 수 있지만 경로가 복잡해 보입니다.

traslated content 레포지토리에서도 한국 번역 지침을 찾는 것도 힘들지 않나 생각합니다.
translated content 레포지토리에서도 기여에 관한 내용은 Learn how to contribute로 연결되기에 여기서 한국 번역 지침을 찾는 것은 힘들 것 같습니다.

이에 비해, MDN Discord와 카카오톡 오픈 채팅 정보를 얻는 것은 수월합니다.
MDN ko 문서에서 '기여'라고 검색하면 MDN Web Docs에 기여하기 페이지가 나오고 이 페이지에서 번역 링크를 클릭하면 카카오톡 오픈 채팅방과 DIscord 채널 정보가 나옵니다. 해당 창구에서 질문을 올리고 많은 정보를 얻을 수 있습니다.

그래도 가장 간편한 건 구글링이 아닐까 생각했습니다. 검색 창에 키워드만 입력하면 결과가 나오니까요.
스크린샷 2024-03-19 오후 1 05 28
위 이미지는 'MDN 기여하기'라고 검색했을 때 결과입니다. 상위 결과 중 블로그 글이 3개가 있는데, 3개의 글 모두 작성 연도가 21, 22년 입니다. 작성한 지 시간이 지난 글이어서 그런지 3개의 글 다 이 이슈 링크를 첨부했습니다. 블로그 글을 읽는 사람들이 이슈 링크도 참고할 것이고, 그렇기에 "새로 MDN에 기여하실 분들이 이 이슈를 많이 참고할 것이라고 생각합니다."라고 적었습니다.

ko 문서의 Learn how to contribute링크를 Korean translation guide / 한국 번역 지침와 연결하는건 어떨까요?

저는 한국 번역 지침 자체가 번역 지침'이라기 보단 전반적인 기여 안내라는 생각이 들었습니다.
MDN 번역 콘텐츠에 대한 일반 안내서 부분과 첫 기여자들을 위한 안내서 부분이 있기 때문인데요.
그래서 MDN ko 문서의 하단에 있는 Learn how to contribute링크를 클릭할 때 한국 번역 지침을 띄우면 어떨까 생각합니다.
MDN ko 문서에서 Learn how to contribute링크를 클릭하는 사람들은 MDN 원본이 아니라 MDN ko 문서에 기여를 하고 싶은 사람일 것이라는 추측이 이유입니다.(개인적인 의견입니다.)
해당 링크와 한국 번역 지침을 연결하면 기여하시는 분들의 접근성이 향상되지 않을까해서 의견 제시합니다.
감사합니다.

++

"한국어 문서 번역 스타일 가이드"는 모질라 전체 번역 가이드로 MDN 가이드는 https://github.com/mdn/translated-content/blob/main/docs/README.md에 존재합니다. MDN 가이드를 우선으로 참고 부탁드립니다.

이슈 본문의 일부입니다. 여기에서 링크가 '에'까지로 잘못 걸려있습니다.

@hochan222
Copy link
Member Author

hochan222 commented Mar 19, 2024

@nag0124 이런 문제들이 있었군요. 알려주셔서 감사합니다.

ko 문서의 Learn how to contribute링크를 Korean translation guide / 한국 번역 지침와 연결하는건 어떨까요?

좋은 생각입니다~!

기존의 Learn how to contribute에 대한 링크는 content 저장소 (en-US)의 CONTRIBUTING.md 여서, locale 페이지에서 translated-content 저장소 (locale)의 CONTRIBUTING.md로 링크 변경하는 PR mdn/yari#10743 생성했습니다. 현재 문제는 알맞은 CONTRIBUTING.md 파일로 링크 변경해주는것만으로도 충분하다고 생각합니다!

MDN ko 문서에서 '기여'라고 검색하면 MDN Web Docs에 기여하기 페이지가 나오고 이 페이지에서 번역 링크를 클릭하면 카카오톡 오픈 채팅방과 DIscord 채널 정보가 나옵니다.

content 저장소 (en-US)가 원본으로 translated-content 저장소(각 locale)에서 번역하고 있는데요! "MDN Web Docs 지역화" 페이지에서 "How to contribute" 영역이 한국어 페이지에 번역되지 않았습니다. "How to contribute" 영역 번역해주셔도 좋을듯합니다. (+ 누락된 부분)

traslated content 레포지토리에서도 한국 번역 지침을 찾는 것도 힘들지 않나 생각합니다.

Contribute to MDN Web Docs 영역에 작성된 내용 이상으로 내용을 추가하기보다는 현재가 좋다고 생각하는데요! 더 좋은 방법이 있다면, PR 생성하여 의견 주시면 같이 고민해보겠습니다.

좋은 하루 보내세요 :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
l10n-ko Issues related to Korean content.
Projects
None yet
Development

No branches or pull requests

10 participants