Contribuez au contenu technique de NetApp sur GitHub
Suggérer des modifications
PDF
La documentation des produits et services NetApp est open source. Vous pouvez ainsi contribuer au contenu en améliorant, rectifications et suggestions. Il vous suffit de disposer d'un compte GitHub et d'une petite initiative.
Présentation
Vous pouvez contribuer à notre documentation à l'aide des options suivantes :
-
Sélectionnez demander des modifications au document pour soumettre des commentaires généraux ou pour poser une question sur le contenu. Le contenu NetApp examine ensuite votre demande afin de déterminer les modifications nécessaires aux documents. Il s'agit de l'option la plus courante.
-
Sélectionnez Modifier cette page pour modifier directement le contenu vous-même. La direction du contenu NetApp examine ensuite vos modifications et les fusionne.
La vidéo suivante présente brièvement ces deux options.
Les sections ci-dessous fournissent des instructions détaillées.
Demander des modifications du document
L'envoi d'une demande de modification de document constitue la manière la plus courante de contribuer aux documents NetApp. Une fois la demande envoyée, le responsable du contenu confirme qu'il a reçu vos commentaires. Vous recevez une notification de GitHub par e-mail.
Si le responsable du contenu convient que votre suggestion peut améliorer le contenu, il s'engage la modification peu de temps après. Vous recevrez une autre notification indiquant que vos commentaires ont été intégrés.
|
Tous les commentaires que vous fournissez sont accessibles au public. Toute personne qui navigue vers les problèmes dans GitHub repo peut voir vos commentaires. |
-
Si vous ne disposez pas déjà d'un compte GitHub : "créez-en un à partir de github.com"
-
Connectez-vous à votre compte GitHub.
-
À l'aide de votre navigateur Web, ouvrez la page "docs.netapp.com" sur la base de vos commentaires.
-
En haut de la page, sélectionnez Suggérer les modifications > demander les modifications du document.
Un nouvel onglet de navigateur s'ouvre avec un formulaire GitHub que vous pouvez utiliser pour fournir des détails à notre équipe doc.
-
Entrez un titre, un résumé et reconnaissez que le problème ne contient aucune information sensible.
Le formulaire est prérempli avec l'URL et le titre de la page. Ne supprimez pas ces informations car nous en avons besoin pour comprendre votre demande.
-
Sélectionnez soumettre un nouveau problème pour créer un problème pour votre demande.
L'ouverture d'un problème permet la collaboration via les commentaires GitHub. Vous recevrez des notifications par e-mail en fonction des préférences indiquées dans les paramètres de votre compte GitHub.
Vous pouvez également afficher l'état de la demande en sélectionnant issues dans la bannière GitHub :
Envoyez les modifications apportées aux documents
Si vous êtes à l'aise de modifier vous-même le contenu, vous pouvez soumettre les modifications exactes que vous souhaitez voir en modifiant directement le fichier source.
En tant que contributeur externe, vous ne pourrez pas publier le changement directement. L'objet du contenu examine les modifications, apporte les modifications requises et les fusionne ensuite. Vous recevez une notification de GitHub par e-mail.
Si vous avez besoin d'aide avec notre style d'écriture ou la syntaxe de la source, vous pouvez utiliser les ressources suivantes :
-
Si vous ne disposez pas déjà d'un compte GitHub : "créez-en un à partir de github.com"
-
Connectez-vous à votre compte GitHub.
-
À l'aide de votre navigateur Web, ouvrez la page "docs.netapp.com" que vous souhaitez modifier.
-
En haut de la page, sélectionnez Suggérer les modifications > Modifier cette page.
Un nouvel onglet de navigateur s'ouvre et vous amène au fichier du référentiel GitHub pour le site de documentation.
-
Sélectionnez l'icône crayon.
-
Si vous êtes invité à créer une fourchette du référentiel, sélectionnez Fork this repository.
-
Modifiez le contenu.
Le contenu est écrit dans AsciiDoc, un langage de balisage léger. "En savoir plus sur la syntaxe AsciiDoc".
-
Pour valider vos modifications, sélectionnez valider les modifications et remplissez le formulaire :
-
Modifiez éventuellement le message de validation par défaut.
-
Ajoutez une description facultative.
-
Sélectionnez proposer des modifications.
-
-
Sélectionnez Créer une demande de collecte.
Après avoir proposé les modifications, nous les examinerons, procèderons aux modifications nécessaires, puis fusionnons les modifications dans le référentiel GitHub.
Vous pouvez afficher l'état de la requête Pull en sélectionnant Pull Requests dans la bannière GitHub :
