Wiki, 추가 정보, Markdown 정보

  • 아티클

Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019

프로젝트에 대한 팀 또는 기여자 지원하려면 Markdown을 사용하여 팀 프로젝트에 서식, 테이블 및 이미지를 추가합니다. 팀 프로젝트 wiki, 대시보드에 추가하는 콘텐츠, 팀 프로젝트 추가 정보 파일 또는 기타 리포지토리 추가 정보 파일 내에서 Markdown 형식을 사용할 수 있습니다.

Wiki

팀 프로젝트 Wiki를 사용하여 다른 팀원과 정보를 공유합니다. Wiki를 처음부터 프로비전하면 새 Git 리포지토리에 Markdown 파일, 이미지, 첨부 파일 및 일련의 페이지가 저장됩니다. 이 Wiki는 콘텐츠와 구조의 공동 편집을 지원합니다.

팀 프로젝트 wiki에 대해 지원되는 기능은 다음과 같습니다.

wiki 프로비전 또는 만들기

위키 콘텐츠 작업

참고 항목

Firefox 웹 브라우저에서 인쇄 기능을 사용할 수 없습니다.

위키 콘텐츠 서식 지정

Wiki에 기존 Git 리포지토리 게시

많은 팀에서 Markdown을 사용하여 코드를 문서화하고 코드와 함께 이러한 파일에 검사. Git은 표준 끌어오기 요청과 함께 이러한 설명서의 기본 테넌트 및 검토를 지원하지만, 이러한 파일은 콘텐츠 소비자에게 몇 가지 문제를 제시합니다.

  • 독자는 종종 관심 있는 콘텐츠를 찾기 위해 많은 파일 및 폴더를 검색해야 합니다.
  • 콘텐츠에는 조직과 구조가 부족합니다. 독자를 지원하는 고유 페이지 계층 구조는 없습니다.
  • 콘텐츠 버전 관리가 지원되지 않습니다.
  • 콘텐츠를 검색하는 것은 콘텐츠 검색에 최적화된 검색 환경이 아닌 코드를 검색하는 데 의존합니다.

코드를 위키 기능으로 게시하면 팀 프로젝트에 정의된 하나 이상의 Git 리포지토리를 wiki에 게시할 수 있습니다. 이 기능은 코드 베이스와 함께 콘텐츠를 기본 파악하는 방법을 제공하며, 콘텐츠를 선택적으로 게시하고 위키로 업데이트할 수 있습니다.

팀 프로젝트에 대해 프로비전하는 Wiki의 콘텐츠를 관리하는 방법과 Git 리포지토리에서 게시하는 위키 페이지 간에는 상당한 차이가 있습니다. 자세한 내용은 Wiki에 Git 리포지토리 게시를 참조 하세요.

Markdown

Markdown을 사용하면 텍스트 서식을 쉽게 지정하고 이미지를 포함할 수 있습니다. 프로젝트 페이지, 추가 정보 파일, 대시보드 및 끌어오기 요청 내의 문서에 연결할 수도 있습니다. Markdown을 사용하여 다음 위치에서 팀에 지침을 제공할 수 있습니다.

지원되는 구문은 Azure DevOps에서 Markdown 사용을 참조 하세요.

README

각 리포지토리 또는 팀 프로젝트에 대한 추가 정보 파일 또는 여러 파일을 정의할 수 있습니다. 일반 텍스트 대신 Markdown에 추가 정보 작성

추가 정보 페이지를 사용하여 기여자가 프로젝트 내에서 작업하도록 안내합니다. 다음 지침을 추가하는 것이 좋습니다.

  • 프로젝트 포커스
  • 필수 조건
  • 환경 설정
  • 프로젝트 내에서 작업을 수행하기 위한 팁
  • 특정 파일의 용도 또는 사용
  • 프로젝트별 용어 및 약어
  • 변경 내용 커밋 또는 업로드 및 분기 추가에 대한 워크플로 지침
  • 프로젝트 스폰서 또는 연락처

다음은 이 형식을 사용하고 모든 대상에게 참조 및 영감을 제공하는 훌륭한 README입니다.