Red Hat Summit8.6. 역할 컬렉션에 대한 문서 추가
다른 사용자가 자신의 역할의 기능과 사용 방법을 이해할 수 있도록 역할에 대한 문서를 제공하는 것이 중요합니다.
8.6.1. 역할 기록
컬렉션 디렉터리를 스캐폴드하면 README.md 파일이 역할 디렉터리에 추가되었습니다. 이 파일에서 역할에 대한 문서를 추가합니다. 컬렉션의 모든 역할에 대한 README.md 파일에 다음 정보를 제공합니다.
- 역할 설명: 역할이 수행하는 사항에 대한 간략한 요약
- 요구 사항: 컬렉션, 라이브러리 및 필수 설치 나열
- 종속 항목
역할 변수: 역할이 사용하는 변수에 대한 다음 정보를 제공합니다.
- 설명
- 기본값
- 값 예
- 필수 변수
- 예제 플레이북: 역할을 사용하는 플레이북의 예를 표시합니다. 플레이북에서 주석을 사용하여 사용자가 변수 설정 위치를 이해하는 데 도움이 됩니다.
controller_configuration.ad_hoc_command_cancel 의 README.md 파일은 표준 문서가 있는 역할의 예입니다.
8.6.2. 컬렉션 기록
컬렉션의 README.md 파일에서 다음 정보를 제공합니다.
- 컬렉션 설명: 컬렉션의 기능에 대해 설명합니다.
- 요구 사항: 필요한 컬렉션을 나열합니다.
- 역할을 컬렉션의 구성 요소로 나열합니다.
- 컬렉션 사용: 컬렉션의 구성 요소를 실행하는 방법을 설명합니다.
- 문제 해결 섹션을 추가합니다.
- 버전 관리: 컬렉션의 릴리스 사이클을 설명합니다.
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}