Informations du dépôt

Table des matières

Chaque dépôt peut inclure une description, un aperçu, et des catégories pour aider les utilisateurs à comprendre son objectif et son usage. Ajouter des informations de dépôt claires assure que d'autres peuvent trouver vos images et les utiliser efficacement.

Vous ne pouvez modifier les informations du dépôt que pour les dépôts qui ne sont pas archivés. Si un dépôt est archivé, vous devez le désarchiver pour modifier les informations. Pour plus de détails, voir Désarchiver un dépôt.

Description du dépôt

La description apparaît dans les résultats de recherche lors de l'utilisation de la commande docker search et dans les résultats de recherche sur Docker Hub.

Considérez les meilleures pratiques suivantes pour la description du dépôt.

Résumez l'objectif. Énoncez clairement ce que fait l'image de manière concise et spécifique. Clarifiez si c'est pour une application, outil, ou plateforme particulière, ou a un cas d'usage distinct.
Mettez en évidence les fonctionnalités clés ou bénéfices. Mentionnez brièvement les bénéfices principaux ou fonctionnalités uniques qui différencient l'image. Les exemples incluent les hautes performances, facilité d'usage, construction légère, ou compatibilité avec des frameworks ou systèmes d'exploitation spécifiques.
Incluez des mots-clés pertinents. Utilisez des mots-clés que les utilisateurs peuvent rechercher pour augmenter la visibilité, comme les piles technologiques, cas d'usage, ou environnements.
Restez concis. La description peut faire un maximum de 100 caractères. Visez à rester dans une ou deux phrases pour la description pour assurer qu'elle soit facile à lire dans les résultats de recherche. Les utilisateurs devraient rapidement comprendre la valeur de l'image.
Concentrez-vous sur l'audience. Considérez votre audience cible (développeurs, administrateurs système, etc.) et écrivez la description pour répondre à leurs besoins directement.

Suivre ces pratiques peut aider à rendre la description plus engageante et efficace dans les résultats de recherche, dirigeant plus de trafic pertinent vers votre dépôt.

Ajouter ou mettre à jour une description de dépôt

Connectez-vous à Docker Hub.
Sélectionnez Mon Hub > Dépôts.

Une liste de vos dépôts apparaît.
Sélectionnez un dépôt.

La page Général pour le dépôt apparaît.
Sélectionnez l'icône crayon sous le champ description.
Spécifiez une description.

La description peut faire jusqu'à 100 caractères de long.
Sélectionnez Mettre à jour.

Aperçu du dépôt

Un aperçu décrit ce que fait votre image et comment l'exécuter. Il s'affiche dans la vue publique de votre dépôt quand le dépôt a au moins une image. Si les constructions automatisées sont activées, l'aperçu sera synchronisé depuis le fichier README.md du dépôt de code source à chaque construction réussie.

Considérez les meilleures pratiques suivantes pour l'aperçu du dépôt.

Décrivez ce qu'est l'image, les fonctionnalités qu'elle offre, et pourquoi elle devrait être utilisée. Peut inclure des exemples d'usage ou l'équipe derrière le projet.
Expliquez comment commencer avec l'exécution d'un conteneur utilisant l'image. Vous pouvez inclure un exemple minimal de comment utiliser l'image dans un Dockerfile.
Listez les variantes d'images clés et étiquettes pour les utiliser, ainsi que les cas d'usage pour les variantes.
Liez vers la documentation ou sites de support, communautés, ou listes de diffusion pour des ressources supplémentaires.
Fournissez des informations de contact pour les mainteneurs de l'image.
Incluez la licence pour l'image et où trouver plus de détails si nécessaire.

Ajouter ou mettre à jour un aperçu de dépôt

Connectez-vous à Docker Hub.
Sélectionnez Mon Hub > Dépôts.

Une liste de vos dépôts apparaît.
Sélectionnez un dépôt.

La page Général pour le dépôt apparaît.
Sous Aperçu du dépôt, sélectionnez Modifier ou Ajouter un aperçu.

Les onglets Écrire et Aperçu apparaissent.
Sous Écrire, spécifiez votre aperçu de dépôt.

Vous pouvez utiliser du Markdown de base et utiliser l'onglet Aperçu pour prévisualiser le formatage.
Sélectionnez Mettre à jour.

Catégories de dépôt

Vous pouvez étiqueter les dépôts Docker Hub avec des catégories, représentant les cas d'usage principaux prévus pour vos images. Cela permet aux utilisateurs de trouver et explorer plus facilement le contenu pour le domaine de problème qui les intéresse.

Catégories disponibles

L'équipe de contenu Docker Hub maintient une liste organisée de catégories.

Les catégories comprennent :

Gestion des API: Outils pour créer, publier, analyser et sécuriser les API.
Système de gestion de contenu : Applications logicielles pour créer et gérer du contenu numérique via des modèles, des procédures et des formats standard.
Science des données : Outils et logiciels pour prendre en charge l'analyse des données et générer des informations exploitables.
Bases de données et stockage : Systèmes de stockage, de récupération et de gestion des données.
Langages et frameworks : Runtimes et frameworks de langages de programmation.
Intégrations et livraison : Outils pour l'intégration continue (CI) et la livraison continue (CD).
Internet des objets : Outils prenant en charge les applications de l'Internet des objets (IoT).
Apprentissage automatique et IA : Outils et frameworks optimisés pour les projets d'intelligence artificielle et d'apprentissage automatique, tels que les bibliothèques et les frameworks préinstallés pour l'analyse des données, la formation des modèles et le déploiement.
Files d'attente de messages : Systèmes de file d'attente de messages optimisés pour une gestion fiable, évolutive et efficace des messages.
Surveillance et observabilité : Outils pour suivre les performances des logiciels et des systèmes grâce à des métriques, des journaux et des traces, ainsi que l'observabilité pour explorer l'état du système et diagnostiquer les problèmes.
Réseau : Dépôts qui prennent en charge l'échange de données et la connexion d'ordinateurs et d'autres appareils pour partager des ressources.
Systèmes d'exploitation : Logiciel qui gère tous les autres programmes d'un ordinateur et sert d'intermédiaire entre les utilisateurs et le matériel informatique, tout en supervisant les applications et les ressources du système.
Sécurité : Outils pour protéger un système informatique ou un réseau contre le vol, l'accès non autorisé ou les dommages à leur matériel, logiciels ou données électroniques, ainsi que contre l'interruption de service.
Serveurs Web : Logiciel pour servir des pages Web, des fichiers HTML et d'autres actifs aux utilisateurs ou à d'autres systèmes.
Analyse Web : Outils pour collecter, mesurer, analyser et rapporter les données Web et l'engagement des visiteurs du site Web.

Catégories auto-générées

Note

Les catégories auto-générées s'appliquent seulement aux Éditeurs Vérifiés Docker et aux participants du programme Open Source Sponsorisé par Docker.

Pour les dépôts qui précèdent la fonctionnalité Catégories dans Docker Hub, les catégories ont été automatiquement générées et appliquées, utilisant OpenAI, basées sur le titre et la description du dépôt.

En tant que propriétaire d'un dépôt qui a été auto-catégorisé, vous pouvez manuellement modifier les catégories si vous pensez qu'elles sont inexactes. Voir Gérer les catégories pour un dépôt.

La catégorisation auto-générée était un effort ponctuel pour aider à amorcer les catégories sur les dépôts créés avant que la fonctionnalité existe. Les catégories ne sont pas assignées aux nouveaux dépôts automatiquement.

Gérer les catégories pour un dépôt

Vous pouvez étiqueter un dépôt avec jusqu'à trois catégories.

Pour modifier les catégories d'un dépôt :

Connectez-vous à Docker Hub.
Sélectionnez Mon Hub > Dépôts.

Une liste de vos dépôts apparaît.
Sélectionnez un dépôt.

La page Général pour le dépôt apparaît.
Sélectionnez l'icône crayon sous le champ description.
Sélectionnez les catégories que vous voulez appliquer.
Sélectionnez Mettre à jour.

Si une catégorie vous manque, utilisez le lien Donner des commentaires pour nous faire savoir quelles catégories vous aimeriez voir.