[ English | 한국어 (대한민국) | 中文 (简体, 中国) | Indonesia | English (United Kingdom) | español (México) | Deutsch ]

문서

이 섹션은 오픈스택 문서에 기여하기 위해 필요한 정보를 담고 있습니다.

프로젝트 저장소안의 문서들

모든 프로젝트 문서는 Project Guide Setup page 에 설명 된 것과 동일한 디렉토리 구조를 따라야합니다.

문서 디렉토리 구조는 다음과 같습니다.

└── source
    ├── admin
    ├── cli
    ├── configuration
    ├── contributor
    ├── install
    ├── reference
    └── user

설치 가이드

설치 가이드는 install 디렉토리에 있습니다. 가이드에는 데이터베이스 설치 및 구성과 같이 프로젝트 설치에 필요한 소프트웨어, 또는 프로젝트 구성 파일에서 설정해야 하는 매개 변수 등 패키지로부터 프로젝트를 설치하는 것과 관련된 모든 정보를 담고 있습니다. 만약 모든 것이 적절히 설정되었다면(아래 설명 참조), 프로젝트의 설치 가이드는 OpenStack Installation Guides 에 포함됩니다. 설치 가이드는 프로덕션 시스템에 설치하기 위해 사용할 목적으로 작성되지 않습니다.

컨트리뷰터 가이드

컨트리뷰터 가이드는 contributor 디렉토리에서 찾을 수 있습니다. 여기에는 프로젝트 기여 및 팀 관리에 대한 프로젝트 별 정보가 포함되어 있습니다. 이 가이드는 프로젝트 문서에만 나타납니다.

구성 참고서

configuration 디렉토리에는 자동으로 생성되거나 (프로젝트가 oslo.config 를 사용하는 경우) 수동으로 작성되는 (oslo.config 가 사용되지 않는 경우) 구성 참조 정보가 포함됩니다. 자세한 내용은 Sphinx Integration 을 참조하십시오.

CLI 참고서

cli 디렉토리에는 cliff’s sphinx integration으로 자동 생성되거나 자동 생성이 불가능할 때 수동으로 작성할 수있는 명령 도구 참조 문서가 포함되어 있습니다. 자세한 내용은 cliff Sphinx Integration 을 참조하세요.

관리자 가이드

관리자 가이드는 admin 디렉토리에서 찾을 수 있습니다. 여기에는 소프트웨어의 구성과 작동에 대한 정보가 포함되어 있습니다. 프로젝트 관리자 가이드는 OpenStack Administrator Guides 에 포함되어 있습니다.

사용자 가이드

user 디렉토리에는 개념 가이드, 튜토리얼, CLI 또는 프로젝트의 API 사용에 대한 단계별 지침 등 최종 사용자를 대상으로하는 정보가 포함되어 있습니다.

참조 문서

reference 디렉토리에는 다른 디렉토리에 포함되지 않은 참조 정보 (예 : 라이브러리 프로젝트에서 자동 생성 된 클래스 문서)가 포함되어 있습니다.

프로젝트 저장소에 문서 게시

프로젝트 문서를 OpenStack documentation portal 에 링크하려면 openstack-manuals 저장소의 www/project-data/latest.yaml 파일을 template generator 규칙에 따라 업데이트해야합니다.

  1. 파일에서 프로젝트를 찾으십시오.

  2. 적용되는 모든 문서 옵션을 ‘true’로 설정하십시오. 예를 들어 다음과 같습니다.

    has_install_guide: true
    has_api_ref: true
    has_admin_guide: true
    has_config_ref: true
    has_user_guide: true
    

위의 구조가 프로젝트 저장소에 존재하고 latest.yaml 파일이 업데이트되면 project-config 저장소의 publish-openstack-sphinx-docs 작업은 자동으로 공개된 문서에 포함됩니다. 자세한 설명은 Project guide setup 을 참조하세요.