지원콘솔개발자평가판 시작연락처

3장. Using TechDocs

The TechDocs plugin is installed and enabled on your Red Hat Developer Hub instance by default. After an administrator configures the TechDocs plugin, an authorized developer can use the TechDocs plugin to add, view, or manage documentation.

3.1. Adding documentation to TechDocs
링크 복사

After an administrator configures the TechDocs plugin, a developer can add documentation to TechDocs by importing it from a remote repository. Any authorized user or group can access the documentation that is imported into the TechDocs plugin.

3.1.1. Importing documentation into TechDocs from a remote repository
링크 복사

Teams can store their documentation files in the same remote repository where they store their code files. You can import documentation into your TechDocs plugin from a remote repository that contains the documentation files that your team uses.

Prerequisites

  • Your organization has documentation files stored in a remote repository.
  • You have a mkdocs.yaml file in the root directory of your repository.
  • You have the catalog.entity.create and catalog.location.create permissions to import documentation into TechDocs from a remote repository.

Procedure

  1. In your Red Hat Developer Hub instance, click Catalog > Self-service > Register Existing Component.

  2. In the Select URL box, enter the URL to the catalog-info.yaml file that you want to import from your repository using the following format:

    https://github.com/<project_name>/<repo_name>/blob/<branch_name>/<file_directory>/catalog-info.yaml

  3. Click Analyze
  4. Click Finish

Verification

  1. In the Red Hat Developer Hub navigation menu, click Docs.
  2. Verify that the documentation that you imported is listed in the table on the Documentation page.
Red Hat logoGithubredditYoutubeTwitter

자세한 정보

평가판, 구매 및 판매

커뮤니티

Red Hat 소개

Red Hat은 기업이 핵심 데이터 센터에서 네트워크 에지에 이르기까지 플랫폼과 환경 전반에서 더 쉽게 작업할 수 있도록 강화된 솔루션을 제공합니다.

보다 포괄적 수용을 위한 오픈 소스 용어 교체

Red Hat은 코드, 문서, 웹 속성에서 문제가 있는 언어를 교체하기 위해 최선을 다하고 있습니다. 자세한 내용은 다음을 참조하세요.Red Hat 블로그.

Red Hat 문서 정보

Red Hat을 사용하는 고객은 신뢰할 수 있는 콘텐츠가 포함된 제품과 서비스를 통해 혁신하고 목표를 달성할 수 있습니다. 최신 업데이트를 확인하세요.

Legal Notice

Theme

© 2026 Red Hat맨 위로 이동