mirror of
https://github.com/mintlify/docs.git
synced 2026-09-14 13:35:46 +08:00
mintlify[bot]
4daf91ff69
* docs: document shareable changelog filter URLs * docs: translate changelog filter URL note to es, fr, zh --------- Co-authored-by: mintlify[bot] <109931778+mintlify[bot]@users.noreply.github.com>
154 lines
7.6 KiB
Plaintext
154 lines
7.6 KiB
Plaintext
---
|
||
title: "Journal des modifications"
|
||
description: "Créez des journaux des modifications produit avec entrées datées, prise en charge des flux RSS et notifications aux abonnés pour communiquer les mises à jour."
|
||
keywords: ["mises à jour produit", "notes de version", "RSS"]
|
||
boost: 3
|
||
---
|
||
|
||
Créez un journal des modifications pour votre documentation en ajoutant des [composants Update](/fr/components/update) à une page.
|
||
|
||
Consultez le [journal des modifications de Mintlify](/fr/changelog) comme exemple : vous pouvez inclure des liens, des images, du texte et des démos de vos nouvelles fonctionnalités dans chaque mise à jour.
|
||
|
||
<div id="setting-up-your-changelog">
|
||
## Configuration de votre journal des modifications
|
||
</div>
|
||
|
||
<Steps>
|
||
<Step title="Créer une page pour votre journal des modifications">
|
||
1. Créez une nouvelle page dans votre documentation, par exemple `changelog.mdx` ou `updates.mdx`.
|
||
2. Ajoutez la page de votre journal des modifications à votre schéma de navigation dans votre `docs.json`.
|
||
</Step>
|
||
|
||
<Step title="Ajouter des composants Update à votre journal des modifications">
|
||
Ajoutez un `Update` pour chaque entrée du journal des modifications.
|
||
|
||
Incluez des informations pertinentes comme des sorties de nouvelles fonctionnalités, des correctifs de bugs ou d'autres annonces.
|
||
</Step>
|
||
</Steps>
|
||
|
||
```mdx Example changelog.mdx
|
||
---
|
||
title: "Journal des modifications"
|
||
description: "Mises à jour produit et annonces"
|
||
---
|
||
<Update label="March 2025" description="v0.0.10">
|
||
Ajout d'une nouvelle saveur Wintergreen.
|
||
|
||
Publication d'une nouvelle version de la saveur Spearmint, maintenant avec 10 % de menthe en plus.
|
||
</Update>
|
||
|
||
<Update label="February 2025" description="v0.0.09">
|
||
Publication d'une nouvelle version de la saveur Spearmint.
|
||
</Update>
|
||
```
|
||
|
||
<div id="customizing-your-changelog">
|
||
## Personnaliser votre journal des modifications
|
||
</div>
|
||
|
||
Maîtrisez la manière dont les utilisateurs parcourent votre journal des modifications et restent à jour sur les informations de votre produit.
|
||
|
||
<div id="table-of-contents">
|
||
### Table des matières
|
||
</div>
|
||
|
||
Chaque propriété `label` d’un `Update` crée automatiquement une entrée dans la table des matières de la barre latérale droite. C’est la navigation par défaut de votre journal des modifications.
|
||
|
||
<Frame>
|
||
<img src="/images/changelog-toc-light.png" alt="Journal des modifications avec la table des matières affichée en mode clair." className="block dark:hidden" />
|
||
|
||
<img src="/images/changelog-toc-dark.png" alt="Journal des modifications avec la table des matières affichée en mode sombre." className="hidden dark:block" />
|
||
</Frame>
|
||
|
||
<div id="tag-filters">
|
||
### Filtres de tags
|
||
</div>
|
||
|
||
Ajoutez `tags` à vos composants `Update` pour remplacer la table des matières par des filtres de tags. Les utilisateurs peuvent filtrer le journal des modifications en sélectionnant un ou plusieurs tags.
|
||
|
||
Lorsqu'un utilisateur sélectionne plusieurs tags, le journal n'affiche que les mises à jour qui incluent l'ensemble des tags sélectionnés. Le journal des modifications masque les mises à jour sans tags dès qu'un filtre est actif.
|
||
|
||
Les tags sélectionnés sont reflétés dans l'URL de la page sous forme de paramètre de requête `?tags=`, ce qui permet aux utilisateurs de partager des liens directs vers une vue filtrée du journal des modifications. Ouvrir un lien tel que `/fr/changelog?tags=Spearmint` active les filtres correspondants dans la barre latérale au chargement, et la mise à jour des filtres maintient l'URL synchronisée. Séparez plusieurs tags par des virgules, par exemple `/fr/changelog?tags=Spearmint,Peppermint`.
|
||
|
||
```mdx Tag filters example wrap
|
||
<Update label="Mars 2025" description="v0.0.10" tags={["Wintergreen", "Spearmint"]}>
|
||
Ajout d'une nouvelle saveur Wintergreen.
|
||
|
||
Sortie d'une nouvelle version de la saveur Spearmint, maintenant avec 10 % de menthe en plus.
|
||
</Update>
|
||
|
||
<Update label="Février 2025" description="v0.0.09" tags={["Spearmint"]}>
|
||
Sortie d'une nouvelle version de la saveur Spearmint.
|
||
</Update>
|
||
|
||
<Update label="Janvier 2025" description="v0.0.08" tags={["Peppermint", "Spearmint"]}>
|
||
La saveur Peppermint est désormais obsolète.
|
||
|
||
Sortie d'une nouvelle version de la saveur Spearmint.
|
||
</Update>
|
||
```
|
||
|
||
<Frame>
|
||
<img src="/images/changelog-filters-light.png" alt="Journal des modifications en mode clair avec le filtre de tag Peppermint sélectionné." className="block dark:hidden" />
|
||
|
||
<img src="/images/changelog-filters-dark.png" alt="Journal des modifications en mode sombre avec le filtre de tag Peppermint sélectionné." className="hidden dark:block" />
|
||
</Frame>
|
||
|
||
<Tip>
|
||
L'utilisation des modes de page `custom`, `center` ou `wide` masque la table des matières et les filtres du journal des modifications. En savoir plus sur les [modes de page](/fr/organize/pages#page-mode).
|
||
</Tip>
|
||
|
||
<div id="subscribable-changelogs">
|
||
### Flux de modifications abonnables
|
||
</div>
|
||
|
||
<Note>Les flux RSS sont uniquement disponibles pour la documentation publique.</Note>
|
||
|
||
Utilisez les composants `Update` pour créer un flux RSS auquel il est possible de s’abonner à l’URL de votre page avec `/rss.xml` ajouté. Par exemple : `mintlify.com/docs/changelog/rss.xml`.
|
||
|
||
Le flux RSS publie des entrées lorsque vous ajoutez de nouveaux composants `Update` et lorsque vous modifiez les intertitres à l’intérieur des composants `Update` existants.
|
||
|
||
Les entrées du flux RSS contiennent uniquement du Markdown. Elles excluent les composants, le code et les éléments HTML. Utilisez la propriété `rss` pour fournir des descriptions textuelles alternatives aux abonnés RSS lorsque vos mises à jour contiennent du contenu exclu.
|
||
|
||
```xml Example RSS feed
|
||
<?xml version="1.0" encoding="UTF-8"?>
|
||
<rss xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:content="http://purl.org/rss/1.0/modules/content/" xmlns:atom="http://www.w3.org/2005/Atom" version="2.0">
|
||
<channel>
|
||
<title><![CDATA[Product updates]]></title>
|
||
<description><![CDATA[Nouvelles mises à jour et améliorations]]></description>
|
||
<link>https://mintlify.com/docs</link>
|
||
<generator>RSS for Node</generator>
|
||
<lastBuildDate>Mon, 21 Jul 2025 21:21:47 GMT</lastBuildDate>
|
||
<atom:link href="https://mintlify.com/docs/changelog/rss.xml" rel="self" type="application/rss+xml"/>
|
||
<copyright><![CDATA[Mintlify]]></copyright>
|
||
<docs>https://mintlify.com/docs</docs>
|
||
<item>
|
||
<title><![CDATA[June 2025]]></title>
|
||
<link>https://mintlify.com/docs/changelog#june-2025</link>
|
||
<guid isPermaLink="true">https://mintlify.com/docs/changelog#june-2025</guid>
|
||
<pubDate>Mon, 23 Jun 2025 16:54:22 GMT</pubDate>
|
||
</item>
|
||
</channel>
|
||
</rss>
|
||
```
|
||
|
||
Les flux RSS peuvent s’intégrer à Slack, à l’e-mail ou à d’autres outils d’abonnement pour informer les utilisateurs des modifications du produit. Parmi les options :
|
||
|
||
* [Slack](https://slack.com/help/articles/218688467-Add-RSS-feeds-to-Slack)
|
||
* [E-mail](https://zapier.com/apps/email/integrations/rss/1441/send-new-rss-feed-entries-via-email) via Zapier
|
||
* Des bots Discord comme [Readybot](https://readybot.io) ou [RSS Feeds to Discord Bot](https://rss.app/en/bots/rssfeeds-discord-bot)
|
||
|
||
Pour rendre le flux RSS découvrable, vous pouvez afficher un bouton avec l’icône RSS qui renvoie vers le flux en haut de la page. Ajoutez `rss: true` au frontmatter de la page :
|
||
|
||
```mdx
|
||
---
|
||
rss: true
|
||
---
|
||
```
|
||
|
||
<Frame>
|
||
<img src="/images/changelog-rss-button-light.png" alt="Page du journal des modifications en mode clair avec le bouton du flux RSS activé." className="block dark:hidden" />
|
||
|
||
<img src="/images/changelog-rss-button-dark.png" alt="Page du journal des modifications en mode sombre avec le bouton du flux RSS activé." className="hidden dark:block" />
|
||
</Frame>
|