저장소 정보

저장소 정보 (Repository information)

저장소의 설명, 개요, 카테고리를 추가·수정해 사용자들이 이미지를 찾고 이해하기 쉽게 만드는 방법을 배워볼게요.

출처: 문서

본문

각 저장소에는 설명(description), 개요(overview), 카테고리를 포함해 사용자가 그 목적과 용법을 이해하는 데 도움을 줄 수 있어요. 명확한 저장소 정보를 추가하면 다른 사람들이 내 이미지를 찾고 효과적으로 사용할 수 있게 돼요.

보관(archived)되지 않은 저장소의 정보만 수정할 수 있어요. 저장소가 보관되어 있다면 정보를 수정하려면 먼저 보관을 해제해야 해요. 자세한 내용은 Unarchive a repository 문서를 참고해요.

저장소 설명

설명은 docker search 명령을 사용할 때와 Docker Hub의 검색 결과에 나타나요. 다음과 같은 저장소 설명 모범 사례를 고려해보세요.

용도 요약: 이미지가 무엇을 하는지 간결하고 구체적으로 명확히 서술해요. 특정 애플리케이션, 도구, 플랫폼용인지 또는 뚜렷한 사용 사례가 있는지 분명히 해요.
주요 기능·장점 강조: 고성능, 사용 용이성, 가벼운 빌드, 특정 프레임워크·운영 체제와의 호환성처럼 이미지를 차별화하는 주요 장점이나 고유 기능을 간단히 언급해요.
관련 키워드 포함: 기술 스택, 사용 사례, 환경 등 사용자가 검색할 만한 키워드를 사용해 가시성을 높여요.
간결하게 유지: 설명은 최대 100자예요. 검색 결과에서 읽기 쉽도록 설명을 한두 문장으로 유지해요. 사용자가 이미지의 가치를 빠르게 이해할 수 있게 해요.
대상 독자에 집중: 대상 독자(개발자, 시스템 관리자 등)를 고려하고 그들의 니즈를 직접 다루는 설명을 작성해요.

이러한 모범 사례를 따르면 설명이 검색 결과에서 더 매력적이고 효과적이 되어 저장소로 더 관련성 높은 트래픽을 끌어올 수 있어요.

저장소 설명 추가 또는 업데이트

Docker Hub 에 로그인해요.
My Hub > Repositories 를 선택해요. 저장소 목록이 나타나요.
저장소를 선택해요. 저장소의 General 페이지가 나타나요.
설명 필드 아래의 연필 아이콘을 선택해요.
설명을 지정해요. 설명은 최대 100자까지 쓸 수 있어요.
Update 를 선택해요.

저장소 개요

개요(overview)는 이미지가 무엇을 하고 어떻게 실행하는지 설명해요. 저장소에 이미지가 하나 이상 있을 때 저장소의 공개 보기에 표시돼요. 자동 빌드가 활성화되어 있으면 성공적인 빌드마다 소스 코드 저장소의 README.md 파일에서 개요가 동기화돼요.

다음과 같은 저장소 개요 모범 사례를 고려해보세요.

이미지가 무엇인지, 제공하는 기능, 사용해야 하는 이유를 설명해요. 사용 예시나 프로젝트 뒤의 팀을 포함할 수 있어요.
이미지를 사용하는 컨테이너 실행을 시작하는 방법을 설명해요. Dockerfile에서 이미지 사용의 최소 예시를 포함할 수 있어요.
주요 이미지 변형(variants)과 사용할 태그, 그리고 변형의 사용 사례를 나열해요.
추가 리소스를 위해 문서·지원 사이트, 커뮤니티, 메일링 리스트로 연결해요.
이미지 관리자의 연락처 정보를 제공해요.
이미지의 라이선스를 포함하고 필요하면 세부 정보를 찾을 곳을 제시해요.

저장소 개요 추가 또는 업데이트

Docker Hub 에 로그인해요.
My Hub > Repositories 를 선택해요. 저장소 목록이 나타나요.
저장소를 선택해요. 저장소의 General 페이지가 나타나요.
Repository overview 아래에서 Edit 또는 Add overview 를 선택해요. Write 및 Preview 탭이 나타나요.
Write 아래에서 저장소 개요를 지정해요. 기본적인 Markdown을 사용할 수 있고, Preview 탭으로 서식을 미리 볼 수 있어요.
Update 를 선택해요.

저장소 카테고리

Docker Hub 저장소에 카테고리를 태그해 이미지의 주요 의도된 사용 사례를 나타낼 수 있어요. 이렇게 하면 사용자가 관심 있는 문제 영역의 콘텐츠를 더 쉽게 찾고 탐색할 수 있어요.

사용 가능한 카테고리

Docker Hub 콘텐츠 팀이 정리된 카테고리 목록을 유지 관리해요. 카테고리는 다음과 같아요:

API management: API를 생성, 게시, 분석, 보호하는 도구.
Content management system: 템플릿, 절차, 표준 형식을 통해 디지털 콘텐츠를 만들고 관리하는 소프트웨어 애플리케이션.
Data science: 데이터 분석과 실행 가능한 인사이트 생성 지원 도구·소프트웨어.
Developer tools: 개발자가 애플리케이션과 시스템을 만들고, 디버깅하고, 유지·지원하는 데 돕는 소프트웨어·유틸리티.
Databases & storage: 데이터를 저장, 검색, 관리하는 시스템.
Languages & frameworks: 프로그래밍 언어 런타임과 프레임워크.
Integration & delivery: CI(Continuous Integration)와 CD(Continuous Delivery) 도구.
Internet of things: IoT(사물 인터넷) 애플리케이션을 지원하는 도구.
Machine learning & AI: 데이터 분석, 모델 훈련, 배포를 위한 사전 설치 라이브러리·프레임워크 등 AI·머신러닝 프로젝트에 최적화된 도구·프레임워크.
Message queues: 안정적이고 확장 가능하며 효율적인 메시지 처리를 위한 메시지 큐 시스템.
Monitoring & Observability: 메트릭, 로그, 트레이스를 통해 소프트웨어·시스템 성능을 추적하고 시스템 상태를 탐색·진단하는 관측성 도구.
Networking: 데이터 교환을 지원하고 컴퓨터·기타 장치를 연결해 리소스를 공유하는 저장소.
Operating systems: 컴퓨터의 다른 모든 프로그램을 관리하고 사용자와 하드웨어 사이의 중개자 역할을 하며 애플리케이션·시스템 리소스를 감독하는 소프트웨어.
Security: 컴퓨터 시스템·네트워크를 도난, 무단 접근, 하드웨어·소프트웨어·전자 데이터 손상, 서비스 중단으로부터 보호하는 도구.
Web servers: 웹 페이지, HTML 파일, 기타 자산을 사용자나 다른 시스템에 제공하는 소프트웨어.
Web analytics: 웹 데이터와 웹사이트 방문자 참여를 수집, 측정, 분석, 보고하는 도구.

자동 생성 카테고리

참고: 자동 생성 카테고리는 Docker Verified Publishers와 Docker-Sponsored Open Source 프로그램 참가자에게만 적용돼요.

Docker Hub에서 Categories 기능이 생기기 전에 만들어진 저장소에는 저장소 제목과 설명을 바탕으로 OpenAI를 사용해 카테고리가 자동 생성·적용됐어요. 자동 분류된 저장소의 소유자는 카테고리가 부정확하다고 생각하면 수동으로 편집할 수 있어요. 자동 분류는 기능이 생기기 전에 만들어진 저장소에 카테고리를 시드하려는 일회성 노력이었어요. 새 저장소에는 카테고리가 자동으로 할당되지 않아요.

저장소 카테고리 관리

저장소에 최대 3개의 카테고리를 태그할 수 있어요. 저장소의 카테고리를 편집하려면:

Docker Hub 에 로그인해요.
My Hub > Repositories 를 선택해요. 저장소 목록이 나타나요.
저장소를 선택해요. 저장소의 General 페이지가 나타나요.
설명 필드 아래의 연필 아이콘을 선택해요.
적용하려는 카테고리를 선택해요.
Update 를 선택해요.

원하는 카테고리가 없다면 Give feedback 링크를 사용해 보고 싶은 카테고리를 알려줘요.

저장소 정보