Créer une documentation utilisateur pour votre extension

Chaque extension doit être accompagnée d'une documentation qui explique aux utilisateurs ce qu'elle fait et comment l'utiliser.

La documentation minimale requise est cet ensemble de trois fichiers Markdown :

• PREINSTALL.md
• POSTINSTALL.md
• CHANGELOG.md

En outre, vous devriez également envisager de produire :

• Un fichier README pour le dépôt public de l'extension.
• Tutoriels, guides et références plus longs publiés sur votre propre site Web et associés à votre PREINSTALL.md.

Pour découvrir les bonnes pratiques, ainsi que les formulations et structures courantes, nous vous recommandons de consulter les fichiers disponibles avec les extensions Firebase officielles.

Créer un fichier README

Votre répertoire d'extensions peut éventuellement contenir un fichier README. Notez que la commande firebase ext:dev:init ne génère pas automatiquement de fichier de configuration.

Toutefois, la CLI Firebase accepte la commande pratique suivante pour générer automatiquement un fichier README contenant le contenu extrait de votre fichier extension.yaml et de votre fichier PREINSTALL.md :

firebase ext:info ./path/to/extension --markdown > README.md

Tous les fichiers README des extensions Firebase officielles sont générés à l'aide de cette commande.

Ajouter des informations sur l'installation

Après avoir écrit ou généré un fichier README, ajoutez-y des informations d'installation. Vous pouvez utiliser l'extrait suivant comme modèle :

---

## 🧩 Install this extension

### Console

[![Install this extension in your Firebase project](https://www.gstatic.com/mobilesdk/210513_mobilesdk/install-extension.png "Install this extension in your Firebase project")][install-link]

[install-link]: https://console.firebase.google.com/project/_/extensions/install?ref=publisher_id/extension_name

### Firebase CLI

```bash
firebase ext:install publisher_id/extension_name --project=[your-project-id]
```

> Learn more about installing extensions in the Firebase Extensions documentation:
> [console](https://firebase.google.com/docs/extensions/install-extensions?platform=console),
> [CLI](https://firebase.google.com/docs/extensions/install-extensions?platform=cli)

---

Écrire un fichier PREINSTALL

Le fichier PREINSTALL est la présentation de votre extension, une sorte de page "marketing".

Quel est le contenu de ce fichier ?

• Description complète des fonctionnalités de votre extension
• Liste des conditions préalables, telles que la configuration de la base de données ou l'accès à un service non Google (exemple)
• Brève description des tâches de préinstallation et instructions associées
• Brève description des tâches post-installation (exemple) (les instructions détaillées se trouvent dans POSTINSTALL)
• Brève description des conséquences sur la facturation (commencez par le texte récurrent)

Où ce contenu s'affiche-t-il pour l'utilisateur ?

console Firebase">

Préinstaller du contenu dans la console Firebase

Console Firebase">

• Sur la page de l'extension sur extensions.dev.
• Le dépôt de code source de votre extension (dans le répertoire de l'extension)
• Dans le fichier README de l'extension (si vous utilisez l'option --markdown > README.md de la FirebaseCLI )

Les fichiers PREINSTALL ne peuvent pas accéder aux valeurs des paramètres de l'extension. Vous ne devez donc pas vous attendre à ce que les références de paramètres s'affichent avec des valeurs réelles.

Quelles bonnes pratiques suivre ?

• Si possible, limitez le contenu du fichier PREINSTALL à une page.
• Fournissez le niveau de détail dont un utilisateur final a absolument besoin avant d'installer l'extension.
• Placez des instructions détaillées dans le fichier POSTINSTALL ou dans d'autres fichiers supplémentaires.
• Indiquez brièvement si vous fournissez d'autres outils ou scripts pour prendre en charge l'extension.

Texte récurrent PREINSTALL utile

Nous vous recommandons d'utiliser autant que possible le texte récurrent suivant, selon ce qui s'applique à votre extension. Nous avons fourni quelques exemples, mais le point le plus important est de s'assurer que tous les services facturés par Google et par des tiers sont listés.

Vous pouvez utiliser les ressources suivantes pour trouver les détails de tarification d'un produit :

• Liste des tarifs des produits Google Cloud
• Présentation des tarifs de Firebase

Pour toutes les extensions, incluez cette section pour aider vos utilisateurs à comprendre les implications de la facturation :

Billing

This extension uses other Firebase or Google Cloud services which may have
  associated charges:

*   <list Google services / products that your extension uses>
*   <list Firebase services that your extension uses>
*   Cloud Secret Manager <if the extension uses secret params>
*   Cloud Functions

When you use Firebase Extensions, you're only charged for the underlying
resources that you use. A paid-tier billing plan is only required if the
extension uses a service that requires a paid-tier plan, for example calling to
a Google Cloud API or making outbound network requests to non-Google services.
All Firebase services offer a no-cost tier of usage.
[Learn more about Firebase billing.](https://firebase.google.com/pricing)

<Applicable info about billing implications for non-Google services, such as:>
Usage of this extension also requires you to have a <non-Google-service> account.
You are responsible for any associated costs with your usage of <non-Google-service>.

Écrire un fichier POSTINSTALL

Le fichier POSTINSTALL est la page d'instructions détaillées de votre extension après l'installation.

Quel est le contenu de ce fichier ?

• Instructions détaillées pour toutes les tâches post-installation requises, comme la configuration des règles de sécurité Firebase ou l'ajout de code côté client (exemple)
• Instructions génériques pour essayer immédiatement l'extension installée (par exemple, "accédez à la console, puis effectuez cette action")
• Informations de base sur le déclenchement de l'extension, en particulier pour les extensions déclenchées par une requête HTTP
• Brèves instructions pour surveiller l'extension installée (commencez par le texte récurrent)

Où ce contenu s'affiche-t-il pour l'utilisateur ?

Console Firebase">

Contenu post-installation dans la console Firebase

Console Firebase">

• Dans la console Firebase après qu'un utilisateur a installé votre extension (dans la fiche d'informations de l'extension installée)

  • Assurez-vous de vérifier l'affichage du contenu POSTINSTALL en installant votre extension dans un projet réel.

• Le dépôt de code source de votre extension (dans le répertoire de l'extension)

Les fichiers POSTINSTALL peuvent accéder aux valeurs de paramètre et à plusieurs variables liées aux fonctions de l'extension. Lorsque le contenu POSTINSTALL est affiché dans la console Firebase, les valeurs réelles s'affichent à la place des références de paramètre ou de variable. Découvrez ci-dessous comment référencer des paramètres et des variables dans votre fichier POSTINSTALL.

Quelles bonnes pratiques suivre ?

• Le contenu complet du fichier POSTINSTALL doit être concis, mais descriptif.
• Divisez le contenu à l'aide de titres pour séparer les tâches ou les concepts distincts.
• Envisagez de publier des instructions détaillées pour un workflow ou une tâche spécifiques sur votre site Web (exemple) ou dans des fichiers Markdown supplémentaires dans le dépôt de l'extension (exemple).
• Référencez les paramètres et les variables liées aux fonctions pour que l'utilisateur voie les valeurs configurées dans le contexte des instructions.

Référencer des paramètres et des variables

Après l'installation, la console Firebase affiche le contenu du fichier POSTINSTALL de l'extension. Si vous référencez des paramètres et des variables liées aux fonctions (voir le tableau ci-dessous) dans votre fichier POSTINSTALL, la console remplit ces références avec les valeurs réelles de l'instance installée.

Conseil : Pour les valeurs qui peuvent être longues (comme un chemin d'accès à une base de données ou une URL de fonction), référencez le paramètre ou la variable à la fin des phrases et des sections. Cette bonne pratique facilite la lecture des phrases dans la console Firebase lorsque le contenu du fichier POSTINSTALL est affiché avec des valeurs réelles.

Accédez aux valeurs de paramètre configurées dans le fichier POSTINSTALL à l'aide de la syntaxe suivante : ${param:PARAMETER_NAME}.

Vous pouvez également référencer les variables suivantes liées aux fonctions uniquement dans votre fichier POSTINSTALL. Firebase accepte ces variables pour vous permettre de fournir plus facilement des conseils à vos utilisateurs après l'installation. Elles ne sont disponibles que dans le fichier POSTINSTALL, car les valeurs de ces variables ne sont disponibles qu'après l'installation.

Dans ce tableau, function-name est la valeur du champ name dans l'objet de ressource de la fonction dans extension.yaml.

Documentation de référence sur les variables liées aux fonctions	Description	Valeur de la variable (saisie automatiquement par Firebase après l'installation de l'extension)
${function:function-name.location}
	Emplacement où la fonction est déployée	Exemple de valeur : us-central1
${function:function-name.name}
	Nom de la fonction déployée finale, qui inclut l'ID d'instance de l'extension.	Format généralisé : ext-extension-instance-id-function-name Exemple de valeur : ext-my-awesome-extension-6m31-yourFunctionName
${function:function-name.url} (applicable uniquement aux fonctions HTTP)
	URL de la fonction déployée finale, à laquelle le code client peut envoyer des requêtes HTTP.	Format généralisé : https://deployment-location-project-id.cloudfunctions.net/name-of-final-deployed-function Exemple de valeur : https://us-central1-project-123.cloudfunctions.net/ext-my-awesome-extension-6m31-yourFunctionName

Texte récurrent POSTINSTALL utile

Nous vous recommandons d'utiliser autant que possible le texte récurrent suivant, selon ce qui s'applique à votre extension.

Pour toutes les extensions, incluez la section suivante pour aider vos utilisateurs à surveiller l'extension installée :

Monitoring

As a best practice, you can
[monitor the activity](https://firebase.google.com/docs/extensions/manage-installed-extensions_community#monitor)
of your installed extension, including checks on its health, usage, and logs.

Documenter comment déclencher une extension

Dans la documentation utilisateur de votre extension, vous devez indiquer aux utilisateurs comment la déclencher. Ces instructions peuvent être aussi détaillées que vous le jugez nécessaire, mais gardez à l'esprit les bonnes pratiques pour rédiger un fichier POSTINSTALL. Pour savoir comment fournir ces instructions, développez la section ci-dessous qui s'applique à votre extension.

Extensions déclenchées par un événement en arrière-plan

Vos utilisateurs peuvent déclencher une extension déclenchée par un événement en arrière-plan de différentes manières, en fonction des produits concernés.

Apporter des modifications directement dans la console

Vous pouvez demander à vos utilisateurs d'apporter des modifications qui déclenchent l'extension directement dans la console Firebase, en particulier pour les tests initiaux de votre extension. Par exemple, supposons que votre extension crée un document Cloud Firestore chaque fois qu'un utilisateur Firebase Authentication est créé. Vous pouvez demander à vos utilisateurs de tester une instance installée de votre extension en ajoutant manuellement un nouvel utilisateur Authentication dans la console. Ils peuvent ensuite observer le nouveau document créé dans la section Cloud Firestore de la console.

Ajouter du code côté client

Le cas échéant, vous pouvez également indiquer à vos utilisateurs comment ajouter du code côté client pour déclencher votre extension. Vous devez rediriger les utilisateurs vers la documentation officielle des API qu'ils devront utiliser. Vous pouvez également inclure des exemples d'applications ou des exemples de clients compilés pour aider vos utilisateurs à intégrer l'extension dans leur application (consultez l'extension Compteur distribué pour obtenir un exemple).

Extensions déclenchées par une requête HTTP

Pour que vos utilisateurs puissent déclencher une fonction déclenchée par une requête HTTP (et donc l'extension), vous devez leur fournir le nom ou l'URL de la fonction déployée.

Le nom de la fonction déployée finale n'est pas identique au name que vous avez spécifié dans l'objet de ressource de la fonction dans extension.yaml. Pour permettre l'installation de plusieurs instances de la même extension dans un projet, Firebase renomme la fonction au format suivant : ext-extension-instance-id-function-name.

Les puces suivantes sont des suggestions de texte standard à inclure dans le fichier POSTINSTALL de votre extension. Après l'installation, la console Firebase affiche le contenu du fichier POSTINSTALL et remplace ces références par les valeurs réelles configurées pour l'instance installée. Par exemple, si vous avez défini une fonction nommée yourFunction, vous pouvez inclure les éléments suivants (le cas échéant) :

• Pour les fonctions HTTP onRequest

  To trigger this extension, make a request to or visit the following URL:
  **`${function:yourFunction.url}`**.
  

• Pour les fonctions appelables HTTP (onCall)

  This extension is implemented as an HTTP callable function. To call it from your client app,
  follow the instructions in the
  [callable functions documentation](https://firebase.google.com/docs/functions/callable#call_the_function).
  The name of the function to call is **`${function:yourFunction.name}`**,
  and its region is **`${function:yourFunction.location}`**.
  

Important : Pour que vos utilisateurs puissent utiliser une extension déclenchée par une requête HTTP, ils doivent rendre les fonctions déployées pour l'extension accessibles au public. Les instructions détaillées à fournir à vos utilisateurs se trouvent dans les exemples de texte récurrent ci-dessus.

Écrire un fichier CHANGELOG

Quel est le contenu de ce fichier ?

Chaque extension doit comporter un fichier CHANGELOG.md qui documente les modifications incluses dans chaque nouvelle version de votre extension que vous publiez. Placez chaque version sous un en-tête de niveau 2 (##). Sinon, vous pouvez utiliser le formatage Markdown de votre choix.

L'exemple suivant est un extrait de l'une des extensions officielles :

## Version 0.1.3

feature - Support deletion of directories (issue #148).

## Version 0.1.2

feature - Add a new param for recursively deleting subcollections in Cloud
Firestore (issue #14).

fixed - Fixed "cold start" errors experienced when the extension runs after a
period of inactivity (issue #48).

## Version 0.1.1

Initial release of the _Delete User Data_ extension.

Où ce contenu s'affiche-t-il pour l'utilisateur ?

• Dans la console et la CLI Firebase, lorsque les utilisateurs passent à de nouvelles versions de votre extension. La console et la CLI Firebase n'affichent que les modifications qui prendraient effet si l'utilisateur effectuait la mise à niveau.
• Le dépôt du code source de votre extension (dans le répertoire de l'extension).