Fullmenu null

 

01 August 2017

Puedes acceder a todo el contenido en formato HTML a través de este enlace https://groovy-lang.gitlab.io/101-scripts/
Puedes acceder a todo el contenido en formato PDF a través de este enlace 101-groovy-scripts-pdf.pdf
Puedes acceder a todo el contenido en formato eBook a través de este enlace 101-groovy-scripts-epub.epub

101 Scripts de Groovy pretende ser una serie de prácticos scripts desarrollados en groovy y que puedan servir como base para aplicarlos en su día a día. Tú puedes aportar el tuyo, simplemente tienes que seguir esta guía:

Consideraciones

  • Queremos añadir scripts que solucionen un problema específico (real o inventando). No importa que tu script sea particular a una situación concreta pero seguro que aporta ideas de cómo atacar situaciones parecidas.

  • Tampoco importa que sea fácil o simple. Lo que a tí te parece sencillo a otro le puede resolver un problema (y así llegamos a 101 antes)

  • Debes adjuntar al menos un script y una documentación. Si quieres adjuntar imágenes perfecto pero no es vital.

  • El script debe ser funcional y completo. La idea es que bajo las circunstancias documentadas el script funcione tal como se explice.

  • Hemos creado una serie de categorías pero no es una lista cerrada. Si quieres que tu script pertenezca a una nueva categoría comentálo y se crea.

  • Usamos Asciidoctor como herramienta para documentar. Es imperativo porque es la herramienta que nos permite publicar en Html, Pdf y ePub sin modificar la documentación. Sin embargo no tienes porqué usar todas sus funcionalidades.

  • Para la parte web usamos el generador de contenidos estático JBake. Hay otros pero a nosotros nos gusta este. Lo bueno es que ya está montado y no tendrás que pelearte con él.

Organización

Tu script se debe de alojar en src/jbake/assets/script/categoria donde categoria es una en la que creas que mejor encaja. Actualmente tenemos basico,bbdd,docker,file ,google,office, etc

Tu documentación se debe de alojar en src/jbake/content/categoria (atención a los directorios)

Como normal general el script lo capitalizamos y la documentación no. Si tu documentación está en ingles es preferible que le añadas el sufijo -en al nombre (por ejemplo la-docu-en.adoc ). Si está en español no es necesario.

Toda documentación tiene que contener una cabecera similar a:

= Titulo
Nombre <email@email.dominio>
yyyy-mm-dd
:jbake-type: post
:jbake-status: published
:jbake-tags: blog, asciidoc, los tags que quieras
:jbake-category: la categoria a la que pertenece el script
:jbake-script: /scripts/categoria/NombreScript.groovy
:jbake-lang: es (o en si está en inglés. Por defecto se toma español)
:idprefix:
:imagesdir: ../images

Tu documentacion comienza aqui

jbake-category es el atributo que sirve al generador para ubicar tu script en el menu jbake-script es el atributo que sirve al generador para enlazar tu scritp con la docu jbake-lang es el atributo que indica en que idioma está la documentación jbake-type indica que es un documento tipo post (el que usamos) jbake-status indica que el documento está listo para su publicación (si no deberías usar draft)

Localhost

Si cuentas con Java instalado en tu máquina es posible ejecutar el blog en local y así te será más fácil revisarlo antes de hacer el Merge Request. Para ello ejecuta simplemente desde el raiz del proyecto

./gradlew serveApp

y tras bajarse media internet podrás acceder a http://localhost:8081/101-scripts

Entorno de trabajo

Puedes usar desde un simple editor a un IDE sofisticado. Nosotros trabajamos con Intellij pero probablemente Eclipse te sirva también. Simplemente recuerda que debes reiniciar la tarea serveApp para que te vuelva a generar el contenido