Readme.MD

Comment écrire un article de blog ?

Introduction

La création d'un Article peut être realisée de deux manières:

1. En créant un fichier Markdown sur le github Cdiscount IT-Blog
2. Directement en Markdown sur le Wordpress.

Le format Markdown choisi correspond à celui de GitHub et plus précisemment au format étendu Parsedown Extra

1. Création via markdown sur GitHub

L'interface WordPress étant lourde, la solution de rédiger des fichier MarkDown sur GitHub semble la plus simple.

Le principe est de créer pour chaque article un fichier Markdown qui sera ensuite synchronisé avec WordPress. Toute modification du fichier Markdown pourra être soit automatiquement répercuté sur le Wordpress, soit à la demande.

/// <summary>
        /// Retrieves the boolean value contained in the key.
        /// </summary>
        /// <param name="key">The appSettings key.</param>
        /// <param name="siteId">The site identifier.</param>
        /// <param name="defaultReturnValue">Nullable default value returned if :
        /// - the key does not exist
        /// - the cast does not work.</param>
        /// <returns>The nullable boolean value contained in the key;
        /// default value returned if :
        /// - the key does not exist
        /// - the cast does not work.</returns>
        public static bool? GetAppSettingsToBool(string key, string siteId, bool? defaultReturnValue)
        {
            if (!string.IsNullOrEmpty(key))
            {
                string value = _internalConfigurationManager.AppSettings[key, siteId];
                if (!string.IsNullOrEmpty(value))
                {
                    bool returnValue;
                    if (bool.TryParse(value, out returnValue))
                    {
                        return returnValue;
                    }
                }
            }

            return defaultReturnValue;
        }

        /// <summary>
        /// Retrieves the integer value contained in the key.
        /// </summary>
        /// <param name="key">The appSettings key.</param>
        /// <param name="defaultReturnValue">Nullable default value returned if :
        /// - the key does not exist
        /// - the cast does not work.</param>
        /// <returns>The nullable integer value contained in the key;
        /// default value returned if :
        /// - the key does not exist
        /// - the cast does not work.</returns>
        public static int? GetAppSettingsToInt(string key, int? defaultReturnValue)
        {
            if (!string.IsNullOrEmpty(key))
            {
                string value = _internalConfigurationManager.AppSettings[key];
                if (!string.IsNullOrEmpty(value))
                {
                    int returnValue;
                    if (int.TryParse(value, out returnValue))
                    {
                        return returnValue;
                    }
                }
            }

            return defaultReturnValue;
        }

1.1 Récupérer le repo Git en local

La première étape est de cloner le repos Git sur votre poste via Git Bash pour les poste Linux ou via la commande Git pour les linuxiens.

git clone https://github.com/Cdiscount/IT-Blog.git

ou

git clone [email protected]:Cdiscount/IT-Blog.git

1.2 Créer un fichier Markdown

La première étape est de créer un fichier Markdown dans le repo git. Le fichier devra être nommé comme L'url de l'article pour faciliter la recherche du fichier Markdown par la suite.

Si l'url de votre article est https://dev.cdiscount.com/blog/vive_docker/ le fichier devra se nommer "vive_docker.md".

Afin de catégoriser les article, il est souhaitable de ranger un article dans un répertoire correspondant à sa catégorie.

Par example l'article suivant est dans la "DevOps/Containerization" viouios devrez créer un répertoire "Docker" contenant un répertoire "Containerization"

Une fois votre article écrit il vous faudra faire un commit local de vos modifications

git add .
git commit -m "<Your commit message>"

Une fois le Commit fait, il ne faudra pas oublier de pousser vos modifications sur le repos distant :

git push

1.3 Référencer le fichier MarkDown dans Wordpress

####### TODO --> Captures écrans WordPress

• Se Connecter sur le site le blog avec votre identifiant de domaine,

• Ajouter un article via le menu d'administration en haut de Page,

• Ajouter un titre à votre article et pensez à modifier le permalink pour faciliter le référencement.

• Selectionner la/les catégorie(s) de l'article,
  • 1 catégorie est obligatoire pour avoir une image sur l'article.

• Ajouter une image personalisée à l'article,
  • Par défaut l'image de la catégorie sera utilisée.

• En bas de formulaire dans la zone "Markdown File Path" saisir le lien vers le fichier Markdown de l'article,
  • A chaque commit, sous GitHub l'article sera modifié sur le Blog (via une gestion d'ETAg).

• Publier votre Article en mode Draft,
• Faite relire votre article par un autre redacteur du blog,

NB: Afin d'alimenter le blog régulièrement il est préférable d'échelonner la publication des articles. Si vous avez 2 articles à publier, veuillez espacer la publication d'au moins 1 jour.

2. Création via WordPress

Bon vous écrivez pour un blog IT, ce qui veux dire que vous êtes un IT!

Donc, vous devez retourner au chapitre 1 !