$whoami
Jorge Aguilera, +25 años dándole a la tecla
$whoami
Jorge Aguilera, +25 años dándole a la tecla
$who are you
LLevar la documentación de tu proyecto un paso más allá que el simple README.md
From
To
Usare un proyecto alojado en Gitlab con varias ramas "incrementales" que nos irán mostrando los avances en nuestra documentación.
Si todo va bien incluso iremos viendo en vivo cómo avanza.!!
git clone git@gitlab.com:jorge-aguilera/one-step-beyond.git
git checkout 1-readme
git checkout 2-app
git checkout 3-pages
git checkout 3-pages
Como eres hábil 1/3, usarás Asciidoctor
blabalblaba
git checkout 3-pages
Como eres hábil 2/3, usarás su imagen Docker
docker run --rm -v "$PWD":/documents/ asciidoctor/docker-asciidoctor asciidoctor -D build/docu src/main/asciidoc/index.adoc
git checkout 3-pages
Como eres hábil 3/3, lo incluirás en un pipeline de Gitlab
build:
stage: build
script:
- chmod +x builddocu.sh
- ./builddocu.sh
artifacts:
paths:
- build/docu
y cada vez que hagas un commit al repo tu documentación será publicada
git checkout 4.1-asciidoc
Nuestra aplicación crece, ya tenemos más letras de canciones, funcionalidades nuevas, otras que queremos implementar, ….
y nuestra documentación crece también … pero un poco "plana", no ?
git checkout 5.0-jbake
Nos decidimos dar un paso adelante en la manera que tenemos de explicar nuestro proyecto y creamos un site jBake.
jBake cuenta con un plugin Gradle que se integra en nuestro proyecto sin problemas |
buildscript {
dependencies {
...
classpath 'org.asciidoctor:asciidoctor-gradle-plugin:1.5.3'
...
}
}
plugins {
...
id 'org.jbake.site' version '1.0.0'
...
}
jbake{
...
}
git checkout 5.1-jbake
Borramos los ejemplos de jBake y empezamos a crear nuestros post
git checkout 6.0-be-social
Esta rama es un ejemplo de cómo podemos incluir contenido extra a nuestro blog, por ejemplo haciendolo más social al incluir un timeline de twitter o añadiendo nuevos elementos en el menú principal para compartir la página.
git checkout 7-slides
En esta rama simplemente es un ejemplo de cómo mezclar contenido generado por jBake con el generado por alguna otra parte de nuestro proyecto, como por ejemplo un generador de presentaciones.
De esta forma nuestro site dispondrá:
Sería fácil integrarlo por ejemplo con Disqus y poder tener feedback de nuestros usuarios (tal vez git checkout 8-disqus ? )
/