WordPress.org

Les efforts actuels de documentation en ligne de WordPress ont vraiment débuté à partir du cycle de publication 3.7 et ont pris de l’ampleur à mesure que l’initiative hook docs progressait. La documentation en ligne, ou initiative “inline docs” est un projet hybride, les rapports au noyau CoreCore sont l’ensemble des logiciels requis pour exécuter WordPress. L’Équipe de développement de Base construit WordPress., les équipes de documentation et de Hub de développeurs.

Qu’est-ce que la documentation en ligne ? # Qu’est-ce que la documentation en ligne ?

La documentation en ligne fournit des informations à la fois nécessaires et utiles sous forme de commentaires en ligne, de blocs de documents, etc. dans le code source de WordPress lui-même.

La documentation en ligne est analysée avec chaque version, et cette documentation est affichée dans la Référence de code à developer.wordpress.orgWordPress.org Le site communautaire où le code WordPress est créé et partagé par les utilisateurs. C’est là que vous pouvez télécharger le code source du noyau, des plugins et des thèmes WordPress ainsi que l’emplacement central pour les conversations et l’organisation de la communauté. https://wordpress.org/.

Top

Comment s’impliquer # Comment s’impliquer

La documentation en ligne est considérée comme une documentation “technique”, donc une certaine familiarité avec la base de code WordPress sera nécessaire – vous devez comprendre le code pour écrire à ce sujet.

1. Familiarisez-vous avec la norme de documentation PHP, ainsi que les directives de mise en forme et les conseils de documentation.

2. Configurez une copie locale de la version développeur de la base de code WordPress à l’aide de Vagrant Vagrant Variable (VVV). WordPress gère les versions à l’aide de SVNSVN Apache Subversion (souvent abrégé SVN, d’après son nom de commande svn) est un système de contrôle des versions et des révisions de logiciels. Les développeurs de logiciels utilisent Subversion pour gérer les versions actuelles et historiques de fichiers tels que le code source, les pages Web et la documentation. Son objectif est d’être un successeur principalement compatible au système de versions simultanées (CVS) largement utilisé. Noyau WordPress et le wordpress.org les codes publiés sont tous gérés de manière centralisée via SVN. https://subversion.apache.org/., mais vous pouvez également utiliser GitGit Git est un système de contrôle de version distribué gratuit et open source conçu pour gérer tout, des petits aux très grands projets avec rapidité et efficacité. Git est facile à apprendre et a une petite empreinte avec des performances rapides comme l’éclair. Le développement de plugins et de thèmes les plus modernes se fait avec ce système de contrôle de version. https://git-scm.com/. (le lien VVV pour savoir comment faire cela).

3. Lire Ouvrir un ticket pour apprendre à créer un TracTrac Trac est l’endroit où les contributeurs créent des problèmes pour des bogues ou des demandes de fonctionnalités, un peu comme GitHub.https://core.trac.wordpress.org/. billet.

4. Création de correctifs:

• Mettez toujours à jour votre copie locale du tronc WordPress avant de modifier le fichier et de créer des correctifs. Utilisez svn up ou git pull, selon le cas.
• Générez le correctif à partir du répertoire racine de votre commande WordPress SVN ou Git. Par exemple, svn diff dir/filename.php > function_name.diff.

5. Comment soumettre un correctif

Il existe un correctif pour signaler les échecs de documentation en ligne et
Par exemple, #48303 est un tel correctif pour WordPress 5.4.

• Ajoutez un commentaire et joignez un fichier de correctif.

6. Vous pouvez également contribuer à des tickets Trac liés à la documentation en ligne qui nécessitent une itération.

• Si un ticket est marqué needs-patch ou needs-refresh, il est possible que le ou les correctifs existants aient juste besoin d’une retouche ou soient actualisés par rapport au dernier joncteur réseau. Chaque petit morceau aide!

Top

Points de contact # Points de contact

Pour toute question, passez par les canaux #docs ou #core-docs dans Slack.

Top

Ressources # Ressources

• Norme de documentation PHP
• Base de données Hooks d’Adam Brown (utile pour les conseils sur les versions @since de hooksHooks Dans le thème et le développement WordPress, les hooks sont des fonctions qui peuvent être appliquées à une action ou à un filtre dans WordPress. Les actions sont des fonctions exécutées lorsqu’un certain événement se produit dans WordPress. Les filtres vous permettent de modifier certaines fonctions. Les arguments utilisés pour accrocher les filtres et les actions se ressemblent.)

Top

Comment ouvrir un nouveau ticket de document # Comment ouvrir un nouveau ticket de document

Fondamentalement, il existe un ticket pour signaler les échecs et les améliorations de la documentation en ligne. Mais, si vous avez besoin de créer un nouveau ticket pour une raison quelconque, suivez les étapes ci-dessous:

1. Lisez Ouvrir un ticket pour apprendre à créer un ticket Trac.
2. Créer un nouveau ticket sur Core Trac pour le fichier:
   • Les formats de titre suggérés peuvent être “Correction PHPDoc pour le chemin /vers /fichier.php” ou “Améliorer la documentation pour le chemin /vers /fichier.php”.
   • Le type doit être un défaut (bug).
   • Attribuez le ticket au composant auquel le fichier est associé.
   • Laissez la version vide.
   • Ajoutez le focus docs en cliquant dessus.
3. Téléchargez votre correctif sur le ticket Trac que vous avez créé et ajoutez le mot clé has-patch.
4. Assurez-vous de laisser un commentaire décrivant votre correctif nouvellement téléchargé. Le simple téléchargement de correctifs ne déclenche pas de notification pour quiconque regarde le ticket.

Remarque : Les modifications de la documentation ne doivent pas se mélanger avec les modifications de code (même les espaces blancs) sauf si le ticket appelle spécifiquement les deux.

Dernière mise à jour : 26 octobre 2019