Azure DevOps Services | Azure DevOps Server 2022 - Azure DevOps Server 2019
Markdown을 사용하여 팀 프로젝트에 서식, 테이블 및 이미지를 추가하여 팀 및 프로젝트 참가자를 지원할 수 있습니다. Markdown 형식은 팀 프로젝트 위키 페이지, 대시보드에 추가하는 콘텐츠, 팀 프로젝트 추가 정보 파일 또는 기타 리포지토리 추가 정보 파일을 향상시킵니다.
프로젝트 위키 설정
팀 프로젝트 위키를 사용하면 프로젝트에 대한 정보를 다른 팀 구성원과 공유할 수 있습니다. 위키를 처음부터 설정하면 새 Git 리포지토리가 Markdown(.md) 파일, 이미지, 첨부 파일 및 페이지 시퀀스를 저장합니다. Wiki는 콘텐츠 및 구조의 공동 편집을 지원합니다.
다음 링크에서는 팀 프로젝트 wiki에 지원되는 기능을 설명합니다.
새 wiki 만들기
위키 콘텐츠 작업
- 페이지 추가 및 편집
- 페이지 기록 보기 또는 되돌리기
- 오프라인에서 복제 및 업데이트
- 바로 가기 키 사용
-
콘텐츠 필터링 또는 인쇄
(Firefox 브라우저에서 인쇄 기능을 사용할 수 없음)
Wiki에 Git 리포지토리 게시
많은 팀에서 Markdown 파일을 사용하여 코드를 문서화합니다. 이 파일은 코드와 함께 리포지토리에 체크 인합니다. Git은 표준 끌어오기 요청 프로세스를 사용하여 코드 설명서 파일의 유지 관리 및 검토를 지원하지만 이러한 파일은 콘텐츠 소비자에게 문제를 제기할 수 있습니다.
- 사용자는 종종 관심 있는 콘텐츠를 찾기 위해 많은 파일 및 폴더를 검색해야 합니다.
- 콘텐츠에는 조직과 구조가 부족합니다. 독자를 지원하는 고유 페이지 계층 구조는 없습니다.
- 콘텐츠 버전 관리가 지원되지 않습니다.
- 콘텐츠를 검색하는 것은 콘텐츠 검색에 최적화된 검색 환경이 아닌 코드 검색에 의존합니다.
코드를 Wiki 기능으로 게시하면 팀 프로젝트에 정의된 하나 이상의 Git 리포지토리를 wiki에 게시할 수 있습니다. 이 기능은 코드 베이스와 동기적으로 코드 설명서를 유지 관리하는 방법을 제공하며, 설명서를 선택적으로 게시하고 위키로 업데이트할 수 있습니다.
팀 프로젝트의 위키 콘텐츠를 관리하는 방법과 Git 리포지토리에서 게시하는 위키 페이지 간에는 상당한 차이가 있습니다. 자세한 내용은 Wiki에 Git 리포지토리 게시를 참조 하세요.
Markdown을 사용하여 프로젝트 콘텐츠 향상
Markdown 형식을 사용하면 텍스트 서식을 쉽게 지정하고 이미지를 포함할 수 있습니다. 프로젝트 페이지, 추가 정보 파일, 대시보드 및 끌어오기 요청 내의 문서에 연결할 수도 있습니다.
Markdown을 사용하여 다음과 같은 방법으로 팀에 지침을 제공할 수 있습니다.
지원되는 구문은 Azure DevOps에서 Markdown 사용을 참조 하세요.
프로젝트 추가 정보 파일 추가
각 리포지토리 또는 팀 프로젝트에 대한 추가 정보 파일 또는 여러 파일을 정의할 수 있습니다. 일반 텍스트 대신 Markdown으로 README를 작성하세요. 추가 정보 페이지를 사용하여 참가자를 프로젝트 내의 특정 정보 또는 위치로 향하게 합니다.
다음 지침을 추가하는 것이 좋습니다.
- 프로젝트 포커스
- 필수 조건
- 환경 설정
- 프로젝트 내에서 작업을 수행하기 위한 팁
- 특정 파일의 용도 또는 사용
- 프로젝트별 용어 및 약어
- 변경 내용 커밋 또는 업로드 및 분기 추가에 대한 워크플로 지침
- 프로젝트 스폰서 또는 연락처
README 예제
다음은 참조 및 영감을 얻기 위해 모든 대상 그룹을 지원하는 GitHub의 프로젝트 README의 몇 가지 예입니다.