Se documenter sur WordPress

et contribuer à sa documentation.

WordPress est gratuit

... et hors de prix !

Pourquoi ?

C'est possible ! Open Source & GPL

C'est "fun" !?

donner en retour

monter en compétence

Reconnaissance et réputation

...

Comment gagner plus ?

  • Devenir plus compétent·e
  • Etre reconnu·e comme compétent·e

Pourquoi contribuer ?

  • Devenir plus compétent·e
  • Etre reconnu·e comme compétent·e

🤨

La documentation

🗺 

il était une fois...

Décembre 2003, le wiki WordPress

Juillet 2004, le "codex"

Le Codex (en français)

Le codex reste à ce jour la seule documentation disponible en français

Sur https://fr.wordpress.org/about/requirements/ :

 

PHP >= 7.3 / MySQL >= 5.6 / MariaDB >= 10.0 et support HTTPS conseillés.

Petit problème : ses informations ne sont plus fiables..

WordPress évolue mais tout le monde n'utilise pas la dernière version.

 

Le besoin de documentation est différent selon les publics.

 

Une fonctionnalité de recherche dans la documentation performante est essentielle

Bonne nouvelle..

it's moving &

ça va bouger !

"HelpHub"

Le centre d'aide à l'utilisation de WordPress.

Les types de docs

Le manuel d'utilisation

Les manuels de développement

La documentation du (dans le) code

Les manuels de contribution

/**
 * Attempts activation of plugin in a "sandbox" and redirects on success.
 *
 * A plugin that is already activated will not attempt to be activated again.
 *
 * The way it works is by setting the redirection to the error before trying to
 * include the plugin file. If the plugin fails, then the redirection will not
 * be overwritten with the success message. Also, the options will not be
 * updated and the activation hook will not be called on plugin error.
 *
 * It should be noted that in no way the below code will actually prevent errors
 * within the file. The code should not be used elsewhere to replicate the
 * "sandbox", which uses redirection to work.
 * {@source 13 1}
 *
 * If any errors are found or text is outputted, then it will be captured to
 * ensure that the success redirection will update the error redirection.
 *
 * @since 2.5.0
 *
 * @param string $plugin       Path to the plugin file relative to the plugins directory.
 * @param string $redirect     Optional. URL to redirect to.
 * @param bool   $network_wide Optional. Whether to enable the plugin for all sites in the network
 *                             or just the current site. Multisite only. Default false.
 * @param bool   $silent       Optional. Whether to prevent calling activation hooks. Default false.
 * @return WP_Error|null WP_Error on invalid file or null on success.
 */
function activate_plugin( $plugin, $redirect = '', $network_wide = false, $silent = false ) {

Pensons à celles ou à ceux qui nous succèderont...

Contribuer ?

Traduire - Migrer

Documenter ses propres projets

Atelier de contribution #8

By Mathieu Viet

Atelier de contribution #8

Supports utilisés lors du 8ème atelier de préparation à la journée de contribution du WordCamp Paris 2019 dont l'objectif est de présenter la documentation de WordPress et la manière d'y contribuer.

  • 886