This repository has been archived by the owner on Nov 19, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 68
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
(chore)readme: add translations folder (#404)
Signed-off-by: ksatchit <[email protected]>
- Loading branch information
Karthik Satchitanand
authored
Oct 26, 2020
1 parent
f0c4c98
commit b1acf2a
Showing
4 changed files
with
139 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
|
|
||
| Documentation pour le projet Litmus | ||
|
|
||
| [](https://app.fossa.com/projects/git%2Bgithub.com%2Flitmuschaos%2Flitmus-docs?ref=badge_shield) | ||
| [](https://slack.litmuschaos.io) | ||
| [](https://hub.docker.com/r/litmuschaos/ansible-runner) | ||
| [](https://github.com/litmuschaos/litmus-docs/stargazers) | ||
| [](https://github.com/litmuschaos/litmus-docs/issues) | ||
| [](https://github.com/litmuschaos/litmus-docs/pulls) | ||
| [](https://twitter.com/LitmusChaos) | ||
| [](https://www.youtube.com/channel/UCa57PMqmz_j0wnteRa9nCaw) | ||
| [](https://github.com/litmuschaos/litmus-docs/pulls) | ||
| [](https://github.com/litmuschaos/litmus-docs) | ||
|  | ||
|
|
||
|
|
||
| Une description détaillée de projet Docusaurus est disponible | ||
| [ici](https://docusaurus.io/docs/en/installation.html). | ||
|
|
||
| ## Pour les développeurs | ||
|
|
||
| ### Cloner le répertoire litmus-docs | ||
|
|
||
| ```bash | ||
| 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](https://github.com/golang/go) est installé. On a juste besoin d'exécuter la commande ci-dessous pour installer embedmd. | ||
|
|
||
| ```bash | ||
| 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: | ||
|
|
||
| ```bash | ||
| 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 | ||
|
|
||
| ```bash | ||
| 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 | ||
|
|
||
| ```bash | ||
| sudo apt-get install -y nodejs | ||
| ``` | ||
|
|
||
| ### Installer Yarn | ||
|
|
||
| ```bash | ||
| npm install -g yarn | ||
| ``` | ||
|
|
||
| ### Démarrer le serveur | ||
|
|
||
| ```bash | ||
| cd website | ||
| yarn install | ||
| yarn start | ||
| ``` | ||
|
|
||
| ## La configuration via Docker compose | ||
|
|
||
| ### Installer docker compose | ||
|
|
||
| ```bash | ||
| 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 | ||
|
|
||
| ```bash | ||
| docker-compose up | ||
| ``` | ||
|
|
||
|
|
||
| ## Parcourir la documentation locale | ||
| http://localhost:3000/docs/next/getstarted.html | ||
|
|
||
|
|
||
| ## License | ||
|
|
||
| [](https://app.fossa.com/projects/git%2Bgithub.com%2Flitmuschaos%2Flitmus-docs?ref=badge_large) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| # Translations | ||
|
|
||
| | | Translated Link | | ||
| | --- | --- | | ||
| | GB | [English](../README.md) | | ||
| | FR | [French](README-fr.md) | |