Pour tout problème contactez-nous par mail : support@froggit.fr | La FAQ :grey_question: | Rejoignez-nous sur le Chat :speech_balloon:

Skip to content
Snippets Groups Projects
Commit 981c34c5 authored by Marc's avatar Marc
Browse files

readme : utilisation de partials

parent 16518d23
No related branches found
No related tags found
No related merge requests found
= template-asciidoctor-dockerized = template-asciidoctor-dockerized
:hide-uri-scheme:
Génération de slides, pdf, ebook, docx à l'aide de https://docs.asciidoctor.org/asciidoctor/latest/[Asciidoctor], https://docs.asciidoctor.org/reveal.js-converter/latest/[RevealJs] et https://docs.docker.com/compose/[Docker Compose]. Génération de slides, pdf, ebook, docx à l'aide de https://docs.asciidoctor.org/asciidoctor/latest/[Asciidoctor,window=_blank], https://docs.asciidoctor.org/reveal.js-converter/latest/[RevealJs,window=_blank] et https://docs.docker.com/compose/[Docker Compose,window=_blank].
Ce dépôt a été généré à partir du template : https://github.com/baldir-fr/template-asciidoctor-dockerized Ce dépôt a été généré à partir du template : https://github.com/baldir-fr/template-asciidoctor-dockerized[window=_blank]
== Documents générés == Documents générés
* link:docs/index.html[Slides générées au format HTML] * link:docs/index.html[Slides générées au format HTML,window=_blank]
* link:docs/output.pdf[Pdf] * link:docs/output.pdf[Pdf,window=_blank]
* link:docs/output.epub[Ebook] * link:docs/output.epub[Ebook,window=_blank]
* link:docs/output.docbook.xml[Docbook] * link:docs/output.docbook.xml[Docbook,window=_blank]
* link:docs/output.docx[Docx] * link:docs/output.docx[Docx,window=_blank]
== Écrire du contenu == Écrire du contenu
...@@ -46,7 +47,7 @@ docker compose run --rm build-slides; rm -rf docs/assets;cp -r 01-slides/assets ...@@ -46,7 +47,7 @@ docker compose run --rm build-slides; rm -rf docs/assets;cp -r 01-slides/assets
make 01-pdf make 01-pdf
---- ----
=== Génération du E-book === Génération de l'E-book
[source,shell] [source,shell]
---- ----
...@@ -58,7 +59,6 @@ make 01-epub ...@@ -58,7 +59,6 @@ make 01-epub
[#_generation_du_docbook] [#_generation_du_docbook]
=== Génération du docbook === Génération du docbook
[source,shell] [source,shell]
---- ----
docker compose run build-docbook docker compose run build-docbook
...@@ -83,80 +83,7 @@ pandoc --from docbook \ ...@@ -83,80 +83,7 @@ pandoc --from docbook \
docs/output.docbook.xml docs/output.docbook.xml
---- ----
== Déploiement include::readme/deploiement.adoc[]
=== Gitlab
Si ce dépôt est sur Gitlab.
La pipeline `.gitlab-ci.yml` est préconfigurée pour
* copier les assets
* générer les slides au format HTML
* générer le PDF
* générer l'ebook au format epub
* générer le schéma docbook
* générer le docx (à partir du schéma docbook)
* publier l'ensemble du contenu sur la gitlab page correspondant au projet
=== Gitlab CI + Gitlab Pages depuis un dépôt Git externe
Il est possible de créer un projet Gitlab uniquement pour exécuter la CI et le déploiement sur des Gitlab pages.
Dans ce mode, Gitlab (premium) va créer un projet uniquement pour executer la pipeline déclarée dans .gitlab-ci.yml[`.gitlab-ci.yml`].
Pour que le déclenchement automatique lors de changements
- Run https://docs.gitlab.com/ee/ci/ci_cd_for_external_repos/index.html[CI/CD for external repository]
image:gitlab-ci-pages-from-github.png[]
https://gitlab.com/marc-bouvier/template-asciidoctor-dockerized-gitlab-pages/-/pipelines
=== Github Pages "classique"
Dans ce mode de déploiement, le contenu devra être généré au préalable.
C'est à dire que le contenu du dossier `docs` est généré sur le dépôt local du développeur, puis commit et push.
Cette configuration génère un site jekyll à partir d'une github action préconfigurée.
* Dans le menu "Settings" de Github.
** Section "Pages"
*** Build and deployment
**** Source : Deploy from branch
**** Branch : `main`, `/docs`
image::github-pages-setup.png[Capture d'écran du menu "Settings" de Github. Section "Pages" est sélectionnée. Build and deployment : Source : Deploy from branch. Branch : `main`, `/docs`]
=== Github Pages via Github Actions
Dans ce mode de déploiement, une Github Action est définie dans `.github/workflows/`.
Elle est préconfigurée pour
* copier les assets
* générer les slides au format HTML
* générer le PDF
* générer l'ebook au format epub
* générer le schéma docbook
* générer le docx (à partir du schéma docbook)
* publier l'ensemble du contenu sur la gitlab page correspondant au projet
==== Configuration de Github Pages depuis une Action
* Dans le menu "Settings" de Github.
** Section "Pages"
*** Build and deployment
**** Source : Github Actions
image::github-pages-action-setup.png[Capture d'écran du menu "Settings" de Github. Section "Pages" est sélectionnée. Build and deployment : Source : Github Actions.]
[#_ressources-asciidoctor-complementaires]
== Ressources Asciidoctor complémentaires
* https://github.com/asciidoctor/docker-asciidoctor/blob/main/README.adoc[docker-asciidoctor] include::readme/ressources-asciidoctor-complementaires.adoc[]
* https://docs.asciidoctor.org/asciidoctor/latest/cli/:[Asciidoc CLI]
* https://docs.asciidoctor.org/reveal.js-converter/latest/converter/features/[Asciidoctor revealjs — écrire une présentation]
* https://docs.asciidoctor.org/reveal.js-converter/latest/converter/revealjs-options/[Asciidoctor revealjs — configurer revealjs]
* https://docs.asciidoctor.org/asciidoc/latest/directives/include-tagged-regions/#tagging-regions[Asciidoctor — inclure des snippets à l'aide de régions]
* https://docs.asciidoctor.org/asciidoc/latest/directives/ifdef-ifndef/[Asciidoc — Conditionals / ifdef and ifndef Directives]
* https://mrduguo.github.io/asciidoctor.org/docs/asciidoctor-revealjs/#content-meant-for-multiple-back-ends[Asciidoctor-revealjs — Content meant for multiple back-ends]
readme/assets/github-pages-action-setup.png

620 KiB

File moved
=== GitHub Pages via GitHub Actions
Dans ce mode de déploiement, une Github Action est définie dans link:.github/workflows/generate-docs-and-publish-with-gitlab-pages.yml[`.github/workflows/generate-docs-and-publish-with-gitlab-pages.yml`].
Elle est préconfigurée pour
* copier les assets
* Générer les slides au format HTML
* Générer le PDF
* Générer l'e-book au format epub
* Générer le schéma docbook
* Générer le docx (à partir du schéma docbook)
* Publier l'ensemble du contenu sur la gitlab page correspondant au projet
==== Configuration de Github Pages depuis une Action
* Dans le menu "Settings" de Github.
** Section "Pages"
*** Build and deployment
**** Source : GitHub Actions
image::github-pages-action-setup.png[Capture d'écran du menu "Settings" de Github. Section "Pages" est sélectionnée. Build and deployment : Source : Github Actions.]
\ No newline at end of file
=== Github Pages "classique"
Dans ce mode de déploiement, le contenu devra être généré au préalable.
C'est-à-dire que le contenu du dossier link:docs[`docs`] est généré sur le dépôt local du développeur, puis commit et push.
Cette configuration génère un site jekyll à partir d'une github action préconfigurée.
* Dans le menu "Settings" de Github.
** Section "Pages"
*** Build and deployment
**** Source : Deploy from branch
**** Branch : `main`, `/docs`
image::github-pages-setup.png[Capture d'écran du menu "Settings" de Github. Section "Pages" est sélectionnée. Build and deployment : Source : Deploy from branch. Branch : `main`, `/docs`]
\ No newline at end of file
=== Gitlab CI + Gitlab Pages depuis un dépôt Git externe
Il est possible de créer un projet Gitlab uniquement pour exécuter la CI et le déploiement sur des Gitlab pages.
Dans ce mode, Gitlab (premium) va créer un projet uniquement pour exécuter le pipeline déclaré dans link:.gitlab-ci.yml[`.gitlab-ci.yml`].
Pour que le déclenchement automatique lors de changements
- Run https://docs.gitlab.com/ee/ci/ci_cd_for_external_repos/index.html[CI/CD for external repository]
image:gitlab-ci-pages-from-github.png[]
Exemple de contenu déployé sur une Gitlab Page : https://gitlab.com/marc-bouvier/template-asciidoctor-dockerized-gitlab-pages/-/pipelines[window=_blank]
\ No newline at end of file
=== Gitlab
Si ce dépôt est sur Gitlab.
Le pipeline link:.gitlab-ci.yml[`.gitlab-ci.yml`] est préconfigurée pour
* Copier les assets
* Générer les slides au format HTML
* Générer le PDF
* Générer l'e-book au format epub
* Générer le schéma docbook
* Générer le docx (à partir du schéma docbook)
* Publier l'ensemble du contenu sur la gitlab page correspondant au projet
\ No newline at end of file
== Déploiement
include::deploiement-gitlab-ci.adoc[]
include::deploiement-gitlab-ci-for-external-repos.adoc[]
include::deploiement-github-pages-classic.adoc[]
include::deploiement-github-pages-actions.adoc[]
\ No newline at end of file
[#_ressources-asciidoctor-complementaires]
== Ressources Asciidoctor complémentaires
* https://github.com/asciidoctor/docker-asciidoctor/blob/main/README.adoc[docker-asciidoctor]
* https://docs.asciidoctor.org/asciidoctor/latest/cli/:[Asciidoc CLI]
* https://docs.asciidoctor.org/reveal.js-converter/latest/converter/features/[Asciidoctor RevealJs — écrire une présentation]
* https://docs.asciidoctor.org/reveal.js-converter/latest/converter/revealjs-options/[Asciidoctor RevealJs — configurer RevealJs]
* https://docs.asciidoctor.org/asciidoc/latest/directives/include-tagged-regions/#tagging-regions[Asciidoctor — inclure des snippets à l'aide de régions]
* https://docs.asciidoctor.org/asciidoc/latest/directives/ifdef-ifndef/[Asciidoc — Conditionals / ifdef and ifndef Directives]
* https://mrduguo.github.io/asciidoctor.org/docs/asciidoctor-revealjs/#content-meant-for-multiple-back-ends[Asciidoctor-RevealJs — Content meant for multiple back-ends]
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment