Mise à disposition d’une documentation utilisateur pour votre connecteur personnalisé

Une fois que vous avez fini de concevoir votre connecteur Data Factory, vous devez envoyer un article qui fournit des instructions sur l’utilisation de votre connecteur pour la publication sur Microsoft Learn. Cet article décrit la disposition d’un tel article et explique comment mettre en forme le texte de votre article.

Disposition de l’article

Cette section décrit la disposition générale des articles du connecteur. Votre article de connecteur doit suivre cette disposition générale.

Note de support

Juste après le titre de l’article, insérez la note suivante.

Remplacez <nom de l’entreprise> par le nom de votre entreprise.

Tableau récapitulatif

Après la note de support, fournissez un tableau récapitulatif contenant les informations suivantes :

• État de la version : indique si le connecteur est en préversion ou en disponibilité générale. Utilisez « Préversion » ou « Disponibilité générale ».
• Produits pris en charge : liste les produits pouvant utiliser votre connecteur personnalisé.
• Types d’authentification pris en charge : liste les types d’authentification pris en charge par votre connecteur personnalisé.
• Documentation de référence des fonctions : répertorie toute documentation de langage de formule M associée à votre connecteur personnalisé.

Si votre connecteur personnalisé est implémenté sur différents produits avec des fonctionnalités, incluez la note suivante ou une note similaire dans votre article après le tableau récapitulatif.

Prérequis

Si votre connecteur personnalisé nécessite que d’autres applications soient installées sur le système exécutant votre connecteur ou qu’une procédure de configuration soit effectuée avant son utilisation, vous devez inclure une section Prérequis qui décrit ces procédures d’installation et de configuration. Cette section doit également inclure des informations sur la configuration de différentes versions de votre connecteur (le cas échéant).

Fonctionnalités prises en charge

Cette section doit contenir une liste des fonctionnalités prises en charge par votre connecteur personnalisé. Il s’agit généralement d’une liste à puces qui indique si le connecteur prend en charge les modes Importer et DirectQuery, ainsi que toutes les options avancées disponibles dans la boîte de dialogue initiale qui s’affiche quand l’utilisateur sélectionne votre connecteur dans Obtenir des données.

Instructions de connexion

Cette section contient les procédures requises pour se connecter aux données. Si l’utilisation de votre connecteur personnalisé est limitée à Power Query Desktop, une seule procédure est requise. Toutefois, si votre connecteur personnalisé peut être utilisé dans Power Query Desktop et dans Power Query Online, vous devez fournir une procédure distincte dans des sections distinctes pour chaque instance. Autrement dit, si votre connecteur personnalisé n’est utilisé que par Power Query Desktop, vous disposez d’une procédure commençant par un deuxième titre de commande et une seule procédure pas à pas. Si votre connecteur personnalisé est utilisé par Power Query Desktop et Power Query Online, vous avez deux procédures. Chaque procédure commence par un titre de deuxième ordre et contient une procédure pas à pas distincte sous chaque titre. Pour obtenir des exemples de chaque type de procédure, accédez à Exemples d’articles de connecteur.

La procédure est constituée d’une liste numérotée qui comprend chaque étape nécessaire pour renseigner les informations requises afin d’établir une connexion normale (sans nécessiter d’options avancées) aux données.

Se connecter avec des options avancées (facultatif)

Si votre connecteur personnalisé contient des options avancées qui peuvent être utilisées pour se connecter aux données, ces informations doivent être traitées dans une section distincte de la documentation. Chacune des options avancées doit être documentée et l’objectif de chaque option avancée doit être expliqué dans cette section.

Résolution des problèmes (facultatif)

Si vous connaissez des erreurs courantes qui peuvent se produire avec votre connecteur personnalisé, vous pouvez ajouter une section de résolution des problèmes pour décrire les façons de corriger l’erreur ou de contourner l’erreur. Cette section peut également inclure des informations sur les limitations connues de votre connecteur ou sur la récupération des données. Vous pouvez également inclure tous les problèmes connus liés à l’utilisation de votre connecteur pour se connecter aux données.

Instructions supplémentaires (facultatif)

Incluez dans cette section toute autre instruction ou information sur votre connecteur qui n’a pas été abordée dans les sections précédentes.

Emplacement et format de l’article

Le format de nom de fichier de votre article de connecteur doit contenir uniquement des lettres minuscules, avec un trait d’union entre les mots. Par exemple, le nom de fichier du connecteur Stockage Blob Azure est azure-blob-storage.md. Si votre nom de connecteur utilise des acronymes, l’acronyme entier compte comme un mot. Par exemple, le nom de fichier du connecteur Hive LLAP est hive-llap.md.

Votre article doit être disponible sur GitHub sous le dossier connecteurs dans le référentiel de documentation Power Query : https://github.com/MicrosoftDocs/powerquery-docs/tree/master/powerquery-docs/connectors. Assurez-vous d’ajouter également un lien vers votre article dans la liste des connecteurs référençant l’image de logo correcte téléchargée dans le /connectors/media/index dossier. Enfin, veillez à ajouter un lien à votre article dans le fichier de table des matières (toc.yml). Les connecteurs certifiés sont disponibles uniquement sous Power BI (modèles sémantiques).

Consultez notre guide du contributeur pour savoir comment contribuer à notre repo.

L’article doit être formaté et soumis au format de fichier Markdown. Il doit utiliser le style Microsoft pour décrire les procédures et la disposition de l’interface utilisateur.

Les articles suivants incluent des instructions sur la mise en forme de votre document dans Markdown et le style Microsoft à adopter lors de la création de votre article :

• Informations de référence sur Docs Markdown
• Le Guide de style d'écriture de Microsoft

Exemples d’articles de connecteur

Voici quelques exemples d’articles de connecteur Power Query que vous pouvez utiliser comme point de départ :

• Adobe Analytics (Power Query Desktop uniquement)
• Azure SQL database (Power Query Desktop et Power Query Online)