영어로 읽기

다음을 통해 공유


IIS(인터넷 정보 서비스) 설명서에 기여

이 문서에서는 IIS 설명서 사이트에서 호스트되는 문서 및 코드 샘플에 기여하는 프로세스를 다룹니다. 기여는 입력 체계 수정이거나 새 문서처럼 복잡할 수 있습니다.

간단한 수정 또는 제안을 수행하는 방법

문서는 리포지토리에 Markdown 파일로 저장됩니다. 브라우저 창의 오른쪽 위 모서리에 있는 편집 링크를 선택하여 브라우저에서 Markdown 파일의 내용을 약간 변경할 수 있습니다. (좁은 브라우저 창에서는 편집 링크를 보려면 옵션 표시줄을 확장해야 합니다.) 지침에 따라 PR(끌어오기 요청)을 만듭니다. Microsoft에서 PR을 살펴보고 변경 사항을 수락하거나 제안합니다.

더 복잡한 제출을 수행하는 방법

Git 및 GitHub.com의 기본적인 내용을 이해하고 있어야 합니다.

  • 기존 문서를 변경하거나 새 문서를 만드는 등 원하는 작업을 설명하는 문제를 엽니다. 많은 시간을 투자하기 전에 팀의 승인을 기다리세요.
  • iis-docs 리포지토리를 포크하고 변경 내용에 대한 분기를 만듭니다.
  • 마스터에게 변경 내용이 포함된 PR(끌어오기 요청)을 제출합니다.
  • PR에 'cla-required' 레이블이 할당된 경우 CLA(기여 사용권 계약)를 완료합니다.
  • PR 피드백에 응답합니다.

이 프로세스로 인해 새 아티클이 게시되는 예제는 .NET 리포지토리의 문제 67끌어오기 요청 798 을 참조하세요. 새 문서는 코드 문서화입니다.

Markdown 구문

문서는 GitHub-flavored Markdown(GFM)의 상위 집합인 DocFx-flavored Markdown으로 작성됩니다. 설명서에서 일반적으로 사용되는 UI 기능에 대한 DFM 구문의 예는 .NET 리포지토리 스타일 가이드의 메타데이터 및 Markdown 템플릿 을 참조하세요.

폴더 구조 규칙

각 Markdown 파일에는 이미지용 폴더와 샘플 코드용 폴더가 있을 수 있습니다. 예를 들어 문서가 /extensions/advanced-logging-module/advanced-logging-for-iis-client-logging.md 경우 이미지는 extensions/advanced-logging-module/advanced-logging-for-iis-client-loggin/_static 있고 샘플 애플리케이션 프로젝트 파일은 extensions/advanced-logging-module/advanced-logging-for-iis-client-loggin/samples에 있습니다. /advanced-logging-for-iis-client-logging.md 파일의 이미지는 다음 Markdown에 의해 렌더링됩니다.

![description of image for alt attribute](advanced-logging-for-iis-client-logging/_static/imagename.png)

모든 이미지에는 대체 텍스트가 있어야 합니다.

Markdown 파일 이름 및 이미지 파일 이름은 모두 소문자여야 합니다.

코드 조각

문서에는 요점을 설명하는 코드 조각이 포함된 경우가 많습니다. DFM을 통해 Markdown 파일에 코드를 복사하거나 별도의 코드 파일을 참조할 수 있습니다. 코드에서 오류 가능성을 최소화하기 위해 가능하면 별도의 코드 파일을 사용하는 것이 좋습니다. 코드 파일은 위의 샘플 프로젝트에서 설명한 폴더 구조를 사용하여 리포지토리에 저장되어야 합니다.

다음은 configuration.md 파일에 사용되는 DFM 코드 조각 구문의 몇 가지 예입니다.

전체 코드 파일을 코드 조각으로 렌더링하려면

[!code-csharp[Main](configuration/sample/Program.cs)]

줄 번호를 사용하여 파일의 일부를 코드 조각으로 렌더링하려면:

[!code-csharp[Main](configuration/sample/Program.cs?range=1-10,20,30,40-50]
[!code-html[Main](configuration/sample/Views/Home/Index.cshtml?range=1-10,20,30,40-50]

C# 코드 조각의 경우 C# 지역을 참조할 수 있습니다. 가능할 때마다 줄 번호보다는 지역을 사용하세요. 코드 파일의 줄 번호는 변경되거나, Markdown의 줄 번호 참조와 비동기화될 가능성이 높습니다. C#지역는 중첩될 수 있고, 외부 지역을 참조하는 경우 내부 #region#endregion 지시문이 코드 조각에서 렌더링되지 않습니다.

"snippet_Example"이라는 C# 지역을 렌더링하려면:

[!code-csharp[Main](configuration/sample/Program.cs?name=snippet_Example)]

렌더링된 코드 조각에서 선택된 줄을 강조 표시하려면(일반적으로 노란색 배경으로 렌더링됨)

[!code-csharp[Main](configuration/sample/Program.cs?name=snippet_Example&highlight=1-3,10,20-25)]
[!code-csharp[Main](configuration/sample/Program.cs?range=10-20&highlight=1-3]
[!code-html[Main](configuration/sample/Views/Home/Index.cshtml?range=10-20&highlight=1-3]
[!code-javascript[Main](configuration/sample/Project.json?range=10-20&highlight=1-3]

DocFX로 변경 내용 테스트

로컬에서 호스팅되는 사이트 버전을 만드는 DocFX 명령줄 도구로 변경 내용을 테스트하세요. DocFX는 learn.microsoft.com 위해 만든 스타일 및 사이트 확장을 렌더링하지 않습니다.

DocFX에는 Windows용 .NET Framework나 Linux 또는 macOS용 Mono가 필요합니다.

Windows 지침

  • DocFX 릴리스에서 docfx.zip을 다운로드하고 압축을 풉니다.

  • PATH에 DocFX를 추가합니다.

  • 명령줄 창에서 docfx.json 파일(iis-docs/iis)이 포함된 적절한 폴더로 이동하고 다음 명령을 실행합니다.

    docfx -t default --serve
    
  • 브라우저에서 http://localhost:8080로 이동합니다.

Mono 지침

  • Homebrew를 통해 Mono 설치 - brew install mono.

  • 최신 버전의 DocFX를 다운로드합니다.

  • \bin\docfx로 추출합니다.

  • docfx의 별칭을 만듭니다.

    function docfx {
      mono $HOME/bin/docfx/docfx.exe
    }
    
    function docfx-serve {
      mono $HOME/bin/docfx/docfx.exe serve _site
    }
    
  • 디렉터리에서 docfxiis-docs\iis실행하여 사이트를 빌드하고 docfx-serve 를 실행하여 에서 http://localhost:8080사이트를 봅니다.

음성 및 톤

가장 폭넓은 잠재 고객이 쉽게 이해할 수 있는 설명서를 작성하는 것이 목표입니다. 이에 따라 Microsoft는 기여자가 지켜주었으면 하는 문장 스타일에 대한 지침을 설정했습니다. 자세한 내용은 .NET 리포지토리에서 어투 및 어조 지침을 참조하세요.

리디렉션

아티클을 삭제하거나 파일 이름을 변경하거나 다른 폴더로 이동하는 경우 문서를 책갈피로 지정한 사용자가 404를 받지 않도록 리디렉션을 만듭니다. main 리디렉션 파일에 리디렉션을 추가합니다.