Avertissements
Nous prenons en charge ces grandes catégories d'avertissements :
- Alertes : Note, Conseil, Important, Avertissement, Attention
Nous prenons également en charge les barres de résumé, qui représentent l'abonnement, la version ou le rôle d'administrateur requis pour une fonctionnalité. Pour ajouter une barre de résumé :
Ajoutez le nom de la fonctionnalité au fichier /data/summary.yaml
. Utilisez les attributs suivants :
Attribut | Description | Valeurs possibles |
---|---|---|
subscription |
Note l'abonnement requis pour utiliser la fonctionnalité | Tous, Personnel, Pro, Équipe, Entreprise |
availability |
Note à quel stade de développement du produit se trouve la fonctionnalité | Expérimental, Bêta, Accès anticipé, GA, Retiré |
requires |
Note quelle version minimale est requise pour la fonctionnalité | Pas de valeur spécifique, utilisez une chaîne pour décrire la version et un lien vers les notes de version pertinentes |
for |
Note si la fonctionnalité est destinée aux administrateurs informatiques | Administrateurs |
Ensuite, ajoutez le shortcode summary-bar
sur la page à laquelle vous voulez ajouter la barre de résumé. Notez que le nom de la fonctionnalité est sensible à la casse. Les icônes qui apparaissent dans la barre de résumé sont automatiquement rendues.
Exemples
NoteNotez la façon dont la fonction
get_hit_count
est écrite. Cette boucle de relance de base nous permet de tenter notre requête plusieurs fois si le service redis n'est pas disponible. C'est utile au démarrage pendant que l'application se met en ligne, mais rend également notre application plus résiliente si le service Redis doit être redémarré à tout moment pendant la durée de vie de l'application. Dans un cluster, cela aide également à gérer les pertes de connexion momentanées entre les nœuds.
TipPour une image de base plus petite, utilisez
alpine
.
ImportantTraitez les jetons d'accès comme votre mot de passe et gardez-les secrets. Stockez vos jetons en toute sécurité (par exemple, dans un gestionnaire de mots de passe).
WarningSuppression des volumes
Par défaut, les volumes nommés dans votre fichier compose ne sont PAS supprimés lors de l'exécution de
docker compose down
. Si vous voulez supprimer les volumes, vous devrez ajouter l'indicateur--volumes
.Le tableau de bord de Docker Desktop ne supprime pas les volumes lorsque vous supprimez la pile d'applications.
CautionIci, il y a des dragons.
Pour les deux avertissements suivants, consultez le cycle de vie des versions de Docker pour plus d'informations sur quand les utiliser.
Formatage
{{< summary-bar feature_name="PKG installer" >}}
> [!NOTE]
>
> Notez la façon dont la fonction `get_hit_count` est écrite. Cette boucle de
> relance de base nous permet de tenter notre requête plusieurs fois si le service redis
> n'est pas disponible. C'est utile au démarrage pendant que l'application se met
> en ligne, mais rend également notre application plus résiliente si le service Redis
> doit être redémarré à tout moment pendant la durée de vie de l'application. Dans un
> cluster, cela aide également à gérer les pertes de connexion momentanées entre
> les nœuds.
> [!TIP]
>
> Pour une image de base plus petite, utilisez `alpine`.
> [!IMPORTANT]
>
> Traitez les jetons d'accès comme votre mot de passe et gardez-les secrets. Stockez vos
> jetons en toute sécurité (par exemple, dans un gestionnaire de mots de passe).
> [!WARNING]
>
> Suppression des volumes
>
> Par défaut, les volumes nommés dans votre fichier compose ne sont PAS supprimés lors de l'exécution
> de `docker compose down`. Si vous voulez supprimer les volumes, vous devrez ajouter
> l'indicateur `--volumes`.
>
> Le tableau de bord de Docker Desktop ne supprime pas les volumes lorsque vous supprimez la pile d'applications.
> [!CAUTION]
>
> Ici, il y a des dragons.