From 30821d6e5b0b49a436fe8734e9d1793f662bb0c4 Mon Sep 17 00:00:00 2001 From: Florian du Garage Num Date: Mon, 3 Aug 2020 16:48:27 +0000 Subject: [PATCH] use mkdocs --- .gitlab-ci.yml | 32 ++++++++-------------- README.md | 67 ++++------------------------------------------ liste-des-cours.md | 62 ++++++++++++++++++++++++++++++++++++++++++ mkdocs.yml | 4 +++ requirements.txt | 7 +++++ 5 files changed, 89 insertions(+), 83 deletions(-) create mode 100644 liste-des-cours.md create mode 100644 mkdocs.yml create mode 100644 requirements.txt diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 75741eb8..bfe27afd 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -1,34 +1,24 @@ -# requiring the environment of NodeJS 10 -image: node:10 - -# add 'node_modules' to cache for speeding up builds -cache: - paths: - - node_modules/ # Node modules and dependencies +image: python:3.8-buster before_script: - - npm install gitbook-cli -g # install gitbook - - gitbook fetch 3.2.3 # fetch final stable version - - gitbook install # add any requested plugins in book.json + - pip install -r requirements.txt test: stage: test script: - - gitbook build . public # build to public path - only: - - branches # this job will affect every branch except 'master' + - mkdocs build --strict --verbose --site-dir test + artifacts: + paths: + - test except: - - master - -# the 'pages' job will deploy and build your site to the 'public' path + - master + pages: stage: deploy script: - - gitbook build . public # build to public path + - mkdocs build --strict --verbose artifacts: paths: - - public - expire_in: 1 week + - public only: - - master # this job will affect only the 'master' branch - + - master diff --git a/README.md b/README.md index 0fe03cc6..d6966e03 100644 --- a/README.md +++ b/README.md @@ -1,64 +1,7 @@ -# courses +# Introduction -List of courses - -Headers level3 correspond to Sections in Course organisation - -[[_TOC_]] - - -## Qu'est-ce que le Garage Numérique - -desc: un cours accessible à tout le monde pour découvrir le Garage Numérique - -### Qu'est-ce qu'une association - -desc: comprendre le caractère non-lucratif d'une association - -### Histoire du Garage - - -### Organisation du Garage - -file: - -### Projets du Garage - - -## Les outils du Garage Numérique -### Clipperz -### Gitlab -### Nextcloud -### Mattermost -### Framaboard -## Travailler au Garage -### Assurer l'accueil -### Effectuer un diagnostic -### Sauvegarder les fichiers -## Passe Numérique Pro -### Installer Linux -#### Installation avec un Cd -#### Installation avec une clé usb -#### Installation par le réseau -### Utiliser Linux -#### Introduction à la ligne du commande -#### Fonctionnement du système -### Le réseau -#### Configurer un réseau -### Serveurs -#### SSH -#### SMB -#### Apache -#### Nginx -#### Wordpress stack -#### GLPI Stack -### Lua -### Python -### Scripting -#### Versioning -#### Script de diagnostic -## Bac+1 Devops -### Python -### Docker -### ... +Ce site répertorie la documentation du Garage Numérique, grâce au logiciel gitbook. +La documentation est divisée en deux parties: +- les cours +- les autres ressources \ No newline at end of file diff --git a/liste-des-cours.md b/liste-des-cours.md new file mode 100644 index 00000000..a133fb36 --- /dev/null +++ b/liste-des-cours.md @@ -0,0 +1,62 @@ +# courses + +List of courses + +Headers level3 correspond to Sections in Course organisation + +## Qu'est-ce que le Garage Numérique + +desc: un cours accessible à tout le monde pour découvrir le Garage Numérique + +### Qu'est-ce qu'une association + +desc: comprendre le caractère non-lucratif d'une association + +### Histoire du Garage + + +### Organisation du Garage + +file: + +### Projets du Garage + + +## Les outils du Garage Numérique +### Clipperz +### Gitlab +### Nextcloud +### Mattermost +### Framaboard +## Travailler au Garage +### Assurer l'accueil +### Effectuer un diagnostic +### Sauvegarder les fichiers +## Passe Numérique Pro +### Installer Linux +#### Installation avec un Cd +#### Installation avec une clé usb +#### Installation par le réseau +### Utiliser Linux +#### Introduction à la ligne du commande +#### Fonctionnement du système +### Le réseau +#### Configurer un réseau +### Serveurs +#### SSH +#### SMB +#### Apache +#### Nginx +#### Wordpress stack +#### GLPI Stack +### Lua +### Python +### Scripting +#### Versioning +#### Script de diagnostic +## Bac+1 Devops +### Python +### Docker +### ... + + diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..c8cc97f6 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,4 @@ +site_name: Garage Num Doc +site_url: https://garagenum.gitlab.io/doc +site_dir: public + diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 00000000..9119b6e2 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,7 @@ +# Documentation static site generator & deployment tool +mkdocs>=1.1.2 + +# Add your custom theme if not inside a theme_dir +# (https://github.com/mkdocs/mkdocs/wiki/MkDocs-Themes) +# mkdocs-material>=5.4.0 +