Skip to main content

codespace에서 GitHub Docs 작업

GitHub Codespaces을(를) 사용하여 GitHub Docs에 대한 설명서를 작업할 수 있습니다.

GitHub Codespaces 정보

GitHub Codespaces을(를) 사용하면 컴퓨터에서 원격으로 호스트되는 개발 환경에서 작업할 수 있습니다. 작업 환경을 설정하거나 로컬 컴퓨터에 파일을 다운로드할 필요 없이 빠르게 시작할 수 있습니다.

자세한 내용은 "GitHub Codespaces 개요"을(를) 참조하세요.

codespace에서 설명서 작업

다음 단계에서는 웹용 Visual Studio Code을(를) 사용하여 파일을 편집하도록 GitHub Codespaces가 설정되어 있다고 가정합니다. 다른 편집기를 설정한 경우 단계는 매우 유사합니다. 자세한 내용은 "Github Codespaces의 기본 편집기 설정"을(를) 참조하세요.

  1. GitHub Docsgithub/docs에 대한 오픈 소스 리포지토리로 이동합니다.

  2. 오픈 소스 기여자일 경우 리포지토리의 포크를 만든 다음 포크에서 이 절차의 나머지 단계를 수행합니다. 자세한 내용은 "리포지토리 포크"을(를) 참조하세요.

  3. 작업할 분기를 만듭니다. 자세한 내용은 "리포지토리 내에서 분기 만들기 및 삭제"을(를) 참조하세요.

  4. 리포지토리의 기본 페이지에서 코드를 클릭한 다음 BRANCH-NAME에서 codespace 만들기를 클릭합니다.

    "codespace 설정" 페이지가 표시됩니다. 잠시 후 브라우저 기반 버전의 Visual Studio Code이(가) 표시됩니다.

  5. 탐색기를 사용하여 편집할 Markdown 파일로 이동합니다. 파일이 문서인 경우 content 디렉터리에 배치됩니다. 파일이 다시 사용할 수 있는 콘텐츠인 경우 data 디렉터리에 배치됩니다.

    대부분의 경우 content 디렉터리에 있는 문서 경로는 URL의 경로와 일치하며 .md 파일 확장자는 뺀 값입니다 . 예를 들어 문서 https://docs.github.com/en/codespaces/getting-started/quickstart의 원본은 Markdown 파일 content/codespaces/getting-started/quickstart.md입니다.

  6. 필요에 따라 Markdown 파일을 편집합니다.

  7. 변경 내용을 저장합니다.

  8. 소스 제어 뷰를 사용하거나 터미널에서 Git 명령을 사용하여 변경 내용을 커밋하고 푸시합니다. 자세한 내용은 "Git 정보"을(를) 참조하세요.

끌어오기 요청 만들기

  1. github.com/github/docs/pulls에 있는 github/docs 리포지토리의 "끌어오기 요청" 탭으로 이동합니다.

  2. 새 끌어오기 요청을 클릭합니다.

  3. 오픈 소스 기여자 경우 분기 간 비교를 클릭한 다음 만든 포크된 리포지토리와 작업 분기를 선택합니다.

    그렇지 않으면 "비교" 분기를 작업 분기로 변경합니다.

  4. 표시되는 변경 내용에 codespace에서 수행한 모든 변경 내용이 포함되어 있는지 확인합니다. 그렇지 않은 경우 codespace에서 GitHub로 푸시하지 않은 변경 내용이 있음을 나타낼 수 있습니다.

  5. 끌어오기 요청 만들기를 클릭합니다.

  6. 끌어오기 요청에 대한 세부 정보를 입력하고 끌어오기 요청 만들기를 클릭합니다.

    끌어오기 요청은 GitHub Docs 팀의 구성원이 검토합니다.