설명서에 대한 로컬 Git 리포지토리 설정

이 문서에서는 Microsoft 설명서에 참가하기 위해 로컬 컴퓨터에서 Git 리포지토리를 설정하는 단계를 설명합니다. 참가자는 로컬로 복제된 리포지토리를 사용하여 새 문서를 추가하거나, 기존 문서에 대해 주요 편집 작업을 수행하거나, 아트워크를 변경할 수 있습니다.

이러한 일회성 설정 활동을 실행하여 기여를 시작합니다.

• 적절한 리포지토리를 확인합니다.
• GitHub 계정으로 리포지토리를 포크합니다.
• 복제된 파일에 대한 로컬 폴더를 선택합니다.
• 로컬 컴퓨터에 리포지토리를 복제합니다.
• 업스트림 원격 값을 구성합니다.

Important

사소한 변경 만 수행하는 경우 이 문서의 단계를 완료할 필요가 없습니다 . 도구를 설치하지 않고 빠르게 편집하는 방법을 알아보려면 브라우저에서 편집을 참조하세요.

개요

Microsoft Learn에 대한 설명서에 기여하려면 해당 설명서 리포지토리를 복제하여 Markdown 파일을 로컬로 만들고 편집할 수 있습니다. Microsoft에서는 제안된 변경 내용을 저장할 읽기/쓰기 권한이 있도록 적절한 리포지토리를 사용자 고유의 GitHub 계정에 포크해야 합니다. 그런 다음, PR(끌어오기 요청)을 사용하여 변경 내용을 읽기 전용 중앙 공유 리포지토리에 병합합니다.

Microsoft 리포지토리를 업스트림 리포지토리라고 합니다. GitHub 사용자 인터페이스 내에서 포크 작업을 사용하여 사용자는 Microsoft 리포지토리를 자체 GitHub 계정으로 포크합니다. 이 포크를 원본이라고 합니다. 사용자는 git 클론을 사용하여 원본을 로컬 머신에 복제합니다. 마지막으로, 사용자는 git 원격 추가 업스트림을 사용하여 로컬 클론을 Microsoft 업스트림 리포지토리에 다시 연결합니다.

리포지토리 확인

Microsoft Learn에서 호스트되는 설명서는 GitHub의 여러 리포지토리에 있습니다.

1. 아티클이 있는 리포지토리를 잘 모르는 경우 웹 브라우저를 사용하여 문서를 방문하세요. 아티클의 오른쪽 위 모서리에서 편집 링크(연필 아이콘)를 선택합니다.

   

2. 이 작업을 수행하면 GitHub의 원본 파일로 이동합니다. 리포지토리 이름은 페이지의 왼쪽 위 모서리에 표시됩니다.

   

   다음은 퍼블릭 기여도 사용할 수 있는 몇 가지 인기 있는 리포지토리입니다.

   • Microsoft Learn 커뮤니티 콘텐츠 https://github.com/MicrosoftDocs/community-content/
   • Azure 설명서 https://github.com/MicrosoftDocs/azure-docs
   • SQL Server 설명서 https://github.com/MicrosoftDocs/sql-docs
   • Visual Studio 설명서 https://github.com/MicrosoftDocs/visualstudio-docs
   • .NET 설명서 https://github.com/dotnet/docs
   • Azure .NET SDK 설명서 https://github.com/azure/azure-docs-sdk-dotnet
   • ConfigMgr 설명서 https://github.com/MicrosoftDocs/SCCMdocs

리포지토리 포크

올바른 리포지토리를 확인한 후 다음 단계는 리포지토리를 사용자 고유의 GitHub 계정으로 포크하는 것입니다.

리포지토리를 포크하려면 GitHub 계정에 리포지토리의 복사본을 만드는 것을 의미합니다. 모든 Microsoft 설명서 리포지토리는 읽기 전용 액세스를 제공하지만 포크를 통해 변경하기 위한 쓰기 액세스 권한을 제공하기 때문에 개인 포크가 필요합니다. 포크를 사용하면 포크에서 Microsoft 리포지토리로의 PR을 열 수 있습니다.

1. 주 리포지토리의 GitHub 페이지에서 오른쪽 위 모서리에 있는 포크 단추를 선택합니다.

   

2. 새 포크 만들기 화면에서 소유자가 사용자 이름으로 설정되어 있고 주 분기 복사만 선택되어 있는지 확인합니다. 필요에 따라 리포지토리 이름 및 설명 필드를 변경합니다.

   

리포지토리 복제

복제 는 로컬 컴퓨터에 리포지토리의 복사본을 만드는 것을 의미합니다.

Warning

1. 로컬 리포지토리를 OneDrive 동기화 폴더에 복제하지 마세요. 리포지토리를 복제할 폴더를 선택할 때 OneDrive와 동기화되는 폴더(예 : 문서 폴더)를 사용하지 마세요. 변경 내용을 다시 주 분기로 병합할 때 OneDrive에서 의도하지 않은 병합 충돌 발생할 수 있습니다. 대신 드라이브에 C:\ 짧은 파일 경로(예 : C:\GitHub)를 만드는 것이 가장 좋습니다.

2. Windows용 Git: 긴 경로 이름 사용. 기본적으로 Windows용 Git은 긴 파일 경로 지원을 사용하지 않도록 설정되어 대상 경로가 255자보다 긴 파일이 복제되지 않도록 합니다. 관리자 권한으로 다음 명령을 실행하여 이 문제를 방지하려면 긴 파일 경로를 사용하도록 설정합니다.
   git config --global core.longpaths true

1. 로컬 컴퓨터에 폴더를 GitHub 만듭니다. 예를 들어 C:\GitHub입니다. (OneDrive 동기화 폴더에 복제하지 마세요.)

2. 브라우저에서 GitHub.com 이동하여 로그인합니다.

3. 오른쪽 위에 있는 GitHub의 프로필 드롭다운에서 리포지토리를 선택합니다. 리포지토리 페이지는 포크된 리포지토리 목록과 함께 표시됩니다.

4. 복제할 리포지토리를 선택합니다. 포크의 리포지토리 페이지가 나타납니다.

   프로덕션 리포지토리 페이지가 아니라 포크의 리포지토리 페이지에 있는지 확인합니다. URL을 확인하여 현재 리포지토리가 포크인지 확인할 수 있습니다. Microsoft 조직(예 https://github.com/nancydavolio/azure-docs : NOThttps://github.com/MicrosoftDocs/azure-docs)이 아닌 GitHub 사용자 이름이 표시됩니다. 또한 왼쪽 위 모서리에 이름이 표시되며, 다음에 기본 리포지토리의 이름이 포크된 메모가 표시됩니다.

   

5. <> 페이지의 왼쪽 위에 있는 코드 탭을 선택합니다.

6. 오른쪽의 코드 드롭다운에서 HTTPS 옵션 아래에 URL을 복사합니다.

   

Important

GitHub UI를 통해 복제 URL을 복사했습니다. 나머지 단계는 VS Code 터미널에서 수행해야 합니다.

Visual Studio Code에서 복제하려면

1. Visual Studio Code를 엽니다.

2. 위쪽 탐색 메뉴에서 보기를 선택한 다음 터미널을 선택합니다. 터미널 보기는 Visual Studio Code 화면 아래쪽에 나타납니다.

3. 터미널 보기에서 명령을 실행하여 디렉터리(cd)를 리포지토리 복제 섹션의 GitHub 1단계에서 드라이브의 리포지토리용으로 만든 폴더로 변경합니다.

   예시:

    cd C:\GitHub
   

   오류가 발생하면 디렉터리를 한 번에 한 폴더씩 변경해야 할 수 있습니다.

4. 다음 명령을 실행하여 리포지토리를 복제합니다.

   git clone <paste the clone URL you copied via the GitHub UI>
   

   예시:

   git clone https://github.com/nancydavolio/azure-docs.git
   

5. 브라우저를 통해 인증하라는 메시지가 표시되면 "브라우저로 로그인" 단추를 선택하고 프로세스를 완료합니다. 브라우저 기능을 통한 인증을 지원하는 최신 버전의 Git을 다운로드해야 합니다. GitHub 개인용 액세스 토큰을 사용하도록 선택한 경우 다음 지침 에 따라 개인 액세스 토큰을 만들 수 있습니다.

   복제 명령은 포크의 리포지토리 파일을 3단계에서 선택한 위치의 새 폴더로 다운로드합니다. 현재 폴더 내에 새 폴더가 만들어집니다. 리포지토리 크기에 따라 몇 분 정도 걸릴 수 있습니다. 완료되면 폴더를 탐색하여 구조를 확인할 수 있습니다.

원격 설정

리포지토리가 복제되면 upstream이라는 기본 리포지토리에 읽기 전용 원격 연결을 설정합니다. 원격은 원격 리포지토리를 참조하는 별칭입니다. 원본 은 포크를 참조하고 업스트림 은 프로덕션 리포지토리를 참조합니다. 명령을 실행할 때 Git에서 origin 원격을 clone 자동으로 만들었습니다. 업스트림 URL을 사용하면 로컬 리포지토리를 다른 사용자가 수행한 최근 변경 내용과 동기화된 상태로 유지됩니다.

Git Bash 또는 VS Code 터미널에서 다음 명령을 실행합니다.

1. 디렉터리(cd)를 명령이 만든 리포지토리 폴더로 clone 변경합니다. 예시:

   cd repo-name
   

2. 다음 명령을 실행하여 프로덕션 리포지토리를 가리키는 원격 이름을 upstream 추가합니다. 예를 들어 upstream 리포지토리 URL은 https://github.com/MicrosoftDocs/azure-docs.git https://github.com/nancydavolio/azure-docs.git.

   git remote add upstream <the clone URL of the main repo>
   

   예시:

   git remote add upstream https://github.com/MicrosoftDocs/azure-docs.git
   

3. 다음 명령을 실행하여 원격이 올바른지 확인합니다.

   git remote -v
   

   출력 예제:

   origin  https://github.com/nancydavolio/azure-docs.git (fetch)
   origin  https://github.com/nancydavolio/azure-docs.git (push)
   upstream        https://github.com/MicrosoftDocs/azure-docs.git (fetch)
   upstream        https://github.com/MicrosoftDocs/azure-docs.git (push)
   

4. 실수한 경우 원격을 제거하고 단계를 반복하여 추가합니다. 제거 upstream하려면 다음 명령을 실행합니다.

   git remote remove upstream
   

다음 단계

• 이제 로컬 클론을 설정했으므로 이제 크게 변경해야 합니다.