SQL Server 설명서에 기여하는 방법

  • 아티클

적용 대상:SQL ServerAzure SQL 데이터베이스Azure Synapse AnalyticsAnalytics Platform System(PDW)

모든 사용자는 SQL Server 설명서에 기여할 수 있습니다. 오타 수정, 더 나은 설명 제안 및 기술적 정확성 향상을 포함합니다. 이 문서는 콘텐츠 참여를 시작하는 방법 및 프로세스 작동 방법을 설명합니다.

참여하기 위해 사용할 수 있는 두 가지 주 워크플로가 있습니다.

워크플로 Description
브라우저에서 편집 모든 문서의 작고 빠른 편집에 적합합니다.
도구를 사용하여 로컬로 편집 더 복잡한 편집, 여러 문서를 포함하는 편집 및 빈번한 참여에 적합합니다.

SQL 콘텐츠 팀은 기술적 정확성과 일관성을 위해 모든 퍼블릭 기여도를 검증합니다.

브라우저에서 편집

브라우저에서 SQL Server 콘텐츠를 간단하게 편집한 다음, Microsoft에 제출할 수 있습니다. 자세한 내용은 기여자 가이드 개요를 참조하세요.

다음 단계는 프로세스를 요약합니다.

  1. 관련 피드백이 있는 페이지에서 오른쪽 상단의 연필 아이콘을 선택합니다.
  2. 다음 페이지에서 오른쪽 상단의 연필 아이콘을 선택합니다. 이 아이콘이 표시되지 않으면 먼저 GitHub 계정에 로그인해야 할 수 있습니다.
  3. 다음 페이지의 파일 편집 텍스트 창에서 변경하려는 텍스트를 직접 편집합니다. 새 텍스트 또는 변경된 텍스트의 서식을 지정하는 데 도움이 필요한 경우 Markdown 참고 자료를 참조하세요.
  4. 편집한 후 변경 내용 커밋에서 다음을 수행합니다.
    1. 첫 번째 텍스트 상자에 변경 내용에 대한 간략한 설명을 입력합니다.
    2. 자세한 설명(선택 사항) 추가 상자에 변경 내용에 대한 간략한 설명을 제공합니다.
  5. Propose file change(파일 변경 제안) 를 선택합니다.
  6. 변경 내용 비교 페이지에서 끌어오기 요청 만들기를 선택합니다.
  7. 끌어오기 요청 열기 페이지에서 끌어오기 요청 만들기를 선택합니다.

다음 GIF는 브라우저에서 변경 사항을 제출하는 엔드투엔드 프로세스를 보여 줍니다.

Screenshot of Edit SQL Docs.

도구를 사용하여 로컬로 편집

또 다른 편집 옵션은 sql-docs 또는 azure-docs 리포지토리를 포크하고 컴퓨터에 로컬로 복제하는 것입니다. 그런 다음, Markdown 편집기 및 git 클라이언트를 사용하여 변경 내용을 전송할 수 있습니다. 이 워크플로는 더 복잡하거나 여러 파일을 포함하는 편집에 적합합니다. Microsoft 기술 설명서에 대한 빈번한 참가자에게도 적합합니다.

이 방법을 사용하여 참여하려면 다음 문서를 참조하세요.

설명서에 중요한 변경 내용이 있는 끌어오기 요청을 제출하는 경우 GitHub에서 온라인 기여 CLA(라이선스 규약) 를 제출하도록 요청하는 메시지를 받습니다. 끌어오기 요청을 수락되도록 하려면 온라인 양식을 완료해야 합니다.

인식

변경 내용이 수락된 경우 문서 맨 위에서 참가자로 인식됩니다.

Screenshot of Content contribution recognition.

SQL-docs 개요

이 섹션에서는 sql-docs 리포지토리에서 사용에 대한 추가 지침을 제공합니다.

중요

이 섹션의 정보는 sql-docs에 관련된 것입니다. Azure 설명서에서 SQL 문서를 편집하는 경우 GitHub의 azure-docs 리포지토리에 대한 추가 정보를 참조하세요.

sql-docs 리포지토리는 콘텐츠를 구성하기 위해 여러 개의 표준 폴더를 사용합니다.

폴더 Description
docs 게시된 모든 SQL Server 콘텐츠를 포함합니다. 하위 폴더는 논리적으로 다양한 영역의 콘텐츠를 구성합니다.
docs/includes include 파일을 포함합니다. 이러한 파일은 하나 이상의 다른 문서에 포함될 수 있는 콘텐츠의 블록입니다.
./media 각 폴더는 문서 이미지에 대해 하나의 media 하위 폴더를 가질 수 있습니다. media 폴더는 이미지가 나타나는 문서와 동일한 이름이 있는 하위 폴더를 차례로 갖습니다. 이미지는 모두 소문자이며 공백이 없는 .png 파일이어야 합니다.
TOC.MD 콘텐츠의 테이블 파일입니다. 각 하위 폴더에는 하나의 TOC.MD 파일을 사용하는 옵션이 있습니다.

Applies-to includes

각 SQL Server 문서는 제목 뒤에 applies-to include 파일을 포함합니다. 이는 문서가 적용되는 영역 또는 SQL Server의 버전을 나타냅니다.

applies-to-version/sql-asdb-asa-pdw.md include 파일을 끌어오는 다음 Markdown 예제를 고려합니다.

[!INCLUDE [SQL Server Azure SQL Database Synapse Analytics PDW](../includes/applies-to-version/sql-asdb-asdbmi-asa-pdw.md)]

문서의 위쪽에 다음 텍스트를 추가합니다.

Screenshot of Applies to text.

문서에 대한 올바른 applies-to include 파일을 찾으려면 다음 팁을 사용합니다.

  • 일반적으로 사용되는 include 목록은 버전 관리 및 applies-to에 대한 SQL Server include 파일을 참조하세요.
  • 동일한 기능 또는 관련된 작업을 다루는 다른 문서를 살펴봅니다. 해당 문서를 편집하는 경우 applies-to include에 대한 Markdown을 복사할 수 있습니다(제출하지 않고 편집을 취소할 수 있음).
  • 텍스트 applies-to를 포함하는 파일에 대한 docs/includes 디렉터리를 검색합니다. github에서 찾기 버튼을 사용하여 신속하게 필터링할 수 있습니다. 파일을 선택하여 렌더링되는 방법을 확인합니다.
  • 명명 규칙에 유의하십시오. 이름의 문자열에 여러 x 문자가 포함된 경우 일반적으로 서비스 지원 부족을 나타내는 자리 표시자입니다. 예를 들어 appliesto-xx-xxxx-asdw-xxx-md.md는 asdw만 지정되고 다른 필드는 x로 표시되었기 때문에 Azure Synapse Analytics만 지원됨을 나타냅니다.
  • 일부 include는 버전 번호(예: tsql-appliesto-ss2017-xxxx-xxxx-xxx-md.md)를 지정합니다. 특정 버전의 SQL Server를 사용하여 도입된 기능을 아는 경우 이러한 include 파일을 사용합니다.

참가자 리소스

팁

설명서 피드백 외에 제품 피드백이 있는 경우 여기에서 SQL Server 제품에 대한 피드백을 제공합니다.

관련 콘텐츠

GitHub에서 sql-docs 리포지토리를 탐색합니다.

문서를 찾고, 변경 내용을 전송하고, SQL Server 커뮤니티에 도움을 주세요.

감사합니다.