README-fr.md

Documentation pour le projet Litmus

Une description détaillée de projet Docusaurus est disponible ici.

Pour les développeurs

Cloner le répertoire litmus-docs

git clone https://github.com/litmuschaos/litmus-docs.git
cd litmus-docs

Le serveur de site web documentaire peut être configuré manuellement ou en utilisant docker compose

Utiliser les commandes embedmd avant de commiter les changements

Le code incorporé sera extrait du fichier à URL, qui peut être un chemin relatif vers un autre dans le fichier de système local( en utilisant les barres obliques comme spérateur de répertoire) ou une URL commençant par http:// ou https://.

Installation:

• Il faut bien vérfier que golang est installé. On a juste besoin d'exécuter la commande ci-dessous pour installer embedmd.

go get github.com/campoy/embedmd

Exécution embedmd (doît être faite avant de commiter les modifications):

• Suivez les étapes ci-dessous(à partir de répertoire root) pour exécuter embedmd:

cd docs
embedmd -w $(find *.md)

Vérifier la différence:

• L'exécution de cette commmande embedmd -d docs-name.md révelera la différence entre le contenu de docs-name.md et le résultat de embedmd docs-name.md.

La configuration manuelle

Installer Node.js

sudo apt-get install software-properties-common
curl -sL https://deb.nodesource.com/setup_9.x | sudo -E bash -

Télécharger la dérniére version Node.js

sudo apt-get install -y nodejs

Installer Yarn

npm install -g yarn

Démarrer le serveur

cd website
yarn install
yarn start

La configuration via Docker compose

Installer docker compose

sudo curl -L "https://github.com/docker/compose/releases/download/1.24.1/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose

Démarrer le serveur

docker-compose up

Parcourir la documentation locale

http://localhost:3000/docs/next/getstarted.html

License