docs: restructure help pages into bundles and add new reference pages
Convert several pages to leaf bundles with WebP screenshots, add api-keys, domain-availability, notifications, provider-features, quotas, services, settings, signup and subdomains pages, and refresh existing content.
This commit is contained in:
parent
6b6a8c847f
commit
c372f8409a
81 changed files with 1957 additions and 155 deletions
BIN
content/pages/publish-changes/happydomain-modal-diff-view.webp
Normal file
BIN
content/pages/publish-changes/happydomain-modal-diff-view.webp
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 38 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 1.8 KiB |
68
content/pages/publish-changes/index.en.md
Normal file
68
content/pages/publish-changes/index.en.md
Normal file
|
|
@ -0,0 +1,68 @@
|
|||
---
|
||||
date: 2026-06-10T12:00:00+02:00
|
||||
title: "Publishing changes"
|
||||
author: nemunaire
|
||||
weight: 1300
|
||||
description: "Review the diff of your pending changes, choose exactly which ones to apply, and publish them to your provider"
|
||||
---
|
||||
|
||||
When you make a change in happyDomain, it is not sent to your hosting provider straight away. Your edits accumulate in a working copy, and nothing reaches your provider until you decide to publish. Before that happens, happyDomain lets you review the exact list of changes that your edits produce, fine-tune what will be applied, and record a message for your history.
|
||||
|
||||
## Opening the diff
|
||||
|
||||
In the zone editor, the **Publish my changes** button shows a small counter with the number of pending changes detected for your zone. Click it to open the review window.
|
||||
|
||||

|
||||
|
||||
happyDomain computes the difference between the zone as it currently lives at your provider and the working copy you have been editing. If everything is already in sync, you will simply see a message telling you there is nothing to apply.
|
||||
|
||||
## Understanding the diff
|
||||
|
||||
Each line of the diff describes one concrete correction, written in a human-readable form and colour-coded by its nature:
|
||||
|
||||
| Colour | Meaning |
|
||||
|--------|---------|
|
||||
| **Green** | An addition (a record being created) |
|
||||
| **Red** | A deletion (a record being removed) |
|
||||
| **Yellow** | A modification (an existing record being changed) |
|
||||
| **Blue** | Another kind of change (for example a reordering or provider-specific operation) |
|
||||
|
||||
At the bottom of the window, a **summary** recaps how many additions, deletions and modifications are currently selected.
|
||||
|
||||

|
||||
|
||||
## Selecting which changes to apply
|
||||
|
||||
Every line in the diff has a checkbox. By default the changes are listed for your review, and you decide which ones to keep:
|
||||
|
||||
- **Uncheck** any change you do not want to apply right now. It stays in your working copy and will reappear next time.
|
||||
- Keep checked only the changes you are confident about.
|
||||
|
||||
This is useful when you have made several unrelated edits but only want to publish some of them, or when you want to roll out a sensitive change separately.
|
||||
|
||||
The summary and the apply button update live to reflect your current selection. If nothing is selected, the apply button stays disabled.
|
||||
|
||||
## Writing a commit message
|
||||
|
||||
Before applying, enter a message in the **What's changed?** field. This message is recorded in your history alongside the changes.
|
||||
|
||||
{{% notice style="tip" title="Describe the intent, not the IPs" icon="lightbulb" %}}
|
||||
The diff describes the technical operations, but your message is what makes your history readable later on. When you need to look back at what you did, "Move mail to a new provider" is far easier to understand than re-deriving meaning from a list of IP changes.
|
||||
{{% /notice %}}
|
||||
|
||||
## A confirmation step for safety
|
||||
|
||||
Depending on your [account preferences]({{% relref "settings" %}}), happyDomain may show an extra confirmation screen after you choose to apply:
|
||||
|
||||
- It asks your provider to **prepare** the corrections, then shows you exactly how many operations the provider will actually run for your selection.
|
||||
- If that number differs from what you selected (for instance because a change was already applied, or the provider expands one change into several), a warning is displayed so you can double-check before confirming.
|
||||
|
||||
You can configure whether this confirmation appears always, never, or only when the prepared corrections do not match your selection.
|
||||
|
||||
<!-- TODO: screenshot of the confirmation screen showing prepared corrections -->
|
||||
|
||||
## After publishing
|
||||
|
||||
Once you confirm, happyDomain sends the selected changes to your provider and records the operation, with your message, in the domain's log. From there you can review past deployments at any time, and roll back to an earlier state if needed; see {{% relref "domain-history" %}}.
|
||||
|
||||
To inspect the resulting zone itself rather than the diff, or to keep a copy as a standard zone file, see {{% relref "import-export" %}}.
|
||||
68
content/pages/publish-changes/index.fr.md
Normal file
68
content/pages/publish-changes/index.fr.md
Normal file
|
|
@ -0,0 +1,68 @@
|
|||
---
|
||||
date: 2026-06-10T12:00:00+02:00
|
||||
title: "Publier des modifications"
|
||||
author: nemunaire
|
||||
weight: 1300
|
||||
description: "Examiner le différentiel de vos changements en attente, choisir précisément ceux à appliquer, et les publier chez votre hébergeur"
|
||||
---
|
||||
|
||||
Lorsque vous effectuez un changement dans happyDomain, celui-ci n'est pas immédiatement répercuté auprès de votre hébergeur. Vos modifications s'accumulent dans une copie de travail, et rien n'est transmis à votre hébergeur tant que vous n'avez pas décidé de publier. Avant cela, happyDomain vous permet d'examiner la liste exacte des changements produits par vos modifications, d'ajuster finement ce qui sera appliqué, et de consigner un message dans votre historique.
|
||||
|
||||
## Ouvrir le différentiel
|
||||
|
||||
Dans l'éditeur de zone, le bouton « Diffuser mes changements » affiche un petit compteur indiquant le nombre de changements en attente détectés pour votre zone. Cliquez dessus pour ouvrir la fenêtre de relecture.
|
||||
|
||||

|
||||
|
||||
happyDomain calcule la différence entre la zone telle qu'elle existe actuellement chez votre hébergeur et la copie de travail que vous avez éditée. Si tout est déjà synchronisé, un message vous indiquera simplement qu'il n'y a rien à appliquer.
|
||||
|
||||
## Comprendre le différentiel
|
||||
|
||||
Chaque ligne du différentiel décrit une correction concrète, formulée de façon lisible et colorée selon sa nature :
|
||||
|
||||
| Couleur | Signification |
|
||||
|---------|---------------|
|
||||
| **Vert** | Un ajout (un enregistrement créé) |
|
||||
| **Rouge** | Une suppression (un enregistrement retiré) |
|
||||
| **Jaune** | Une modification (un enregistrement existant modifié) |
|
||||
| **Bleu** | Un autre type de changement (par exemple un réordonnancement ou une opération propre à l'hébergeur) |
|
||||
|
||||
En bas de la fenêtre, un **résumé** récapitule le nombre d'ajouts, de suppressions et de modifications actuellement sélectionnés.
|
||||
|
||||

|
||||
|
||||
## Choisir les changements à appliquer
|
||||
|
||||
Chaque ligne du différentiel comporte une case à cocher. Par défaut, les changements sont listés pour votre relecture, et c'est vous qui décidez lesquels conserver :
|
||||
|
||||
- **Décochez** tout changement que vous ne souhaitez pas appliquer maintenant. Il reste dans votre copie de travail et réapparaîtra la prochaine fois.
|
||||
- Ne laissez cochés que les changements dont vous êtes sûr.
|
||||
|
||||
C'est utile lorsque vous avez fait plusieurs modifications sans rapport entre elles mais ne voulez en publier qu'une partie, ou lorsque vous souhaitez déployer un changement sensible séparément.
|
||||
|
||||
Le résumé et le bouton d'application se mettent à jour en direct selon votre sélection. Si rien n'est sélectionné, le bouton d'application reste désactivé.
|
||||
|
||||
## Rédiger un message de validation
|
||||
|
||||
Avant d'appliquer, saisissez un message dans le champ « Qu'est-ce qui a changé ? ». Ce message est consigné dans votre historique aux côtés des changements.
|
||||
|
||||
{{% notice style="tip" title="Décrivez l'intention, pas les adresses IP" icon="lightbulb" %}}
|
||||
Le différentiel décrit les opérations techniques, mais c'est votre message qui rendra votre historique lisible plus tard. Lorsque vous aurez besoin de revoir ce que vous avez fait, « Déplacement du courrier vers un nouvel hébergeur » est bien plus facile à comprendre que de reconstituer le sens à partir d'une liste de changements d'IP.
|
||||
{{% /notice %}}
|
||||
|
||||
## Une étape de confirmation par sécurité
|
||||
|
||||
Selon les [préférences de votre compte]({{% relref "settings" %}}), happyDomain peut afficher un écran de confirmation supplémentaire après que vous avez choisi d'appliquer :
|
||||
|
||||
- Il demande à votre hébergeur de **préparer** les corrections, puis vous montre exactement combien d'opérations l'hébergeur exécutera réellement pour votre sélection.
|
||||
- Si ce nombre diffère de ce que vous avez sélectionné (par exemple parce qu'un changement était déjà appliqué, ou parce que l'hébergeur décompose un changement en plusieurs), un avertissement s'affiche pour que vous puissiez vérifier avant de confirmer.
|
||||
|
||||
Vous pouvez configurer si cette confirmation apparaît toujours, jamais, ou uniquement lorsque les corrections préparées ne correspondent pas à votre sélection.
|
||||
|
||||
<!-- TODO: screenshot de l'écran de confirmation montrant les corrections préparées -->
|
||||
|
||||
## Après la publication
|
||||
|
||||
Une fois que vous confirmez, happyDomain envoie les changements sélectionnés à votre hébergeur et consigne l'opération, avec votre message, dans le journal du domaine. Vous pouvez ensuite consulter les déploiements passés à tout moment, et [revenir à un état antérieur]({{% relref "domain-history" %}}) si besoin.
|
||||
|
||||
Pour inspecter la zone résultante elle-même plutôt que le différentiel, ou pour en conserver une copie sous forme de fichier de zone standard, consultez la page [Importer et exporter]({{% relref "import-export" %}}).
|
||||
Loading…
Add table
Add a link
Reference in a new issue