Creando presentaciones con Markdown y herramientas Open Source

/ / Blog, Digital Development
Restaurando Alfresco: cómo se usa una copia de seguridad
Desarrollando un servicio web con WindowsPreview.Media.Ocr

Tras la generalización de la versión 5.1 de Alfresco, hemos ido actualizando nuestro material formativo para desarrolladores. Este material, que venimos utilizando tanto para formación interna como para formación externa en los últimos años, está desarrollado básicamente en PowerPoint y Keynote. Durante las últimas actualizaciones de Alfresco ya sentimos la necesidad de cambiar nuestra herramienta de elaboración de documentación para formación, dado que este tipo de programas (incluido Impress) no son adecuados para gestionar este tipo de tareas.

Desde hace algún tiempo venimos empleando Markdown para nuestra documentación interna y su uso cotidiano nos ha demostrado que es lo suficientemente versátil como para soportar con facilidad la mayoría de requisitos de la escritura técnica.

Por este motivo, a partir de la versión 5.1, hemos comenzado con una nueva estrategia para la escritura del material de formación:

    • Los textos están íntegramente escritos en Markdown, utilizando archivos con extensión .md
    • Las figuras las seguimos realizando en PowerPoint o Keynote, pero las almacenamos en formato imagen
    • Las presentaciones las realizamos con remark.js, que permite utilizar cualquier navegador como visualizador de transparencias y acepta texto en formato Markdown simple para los contenidos
      • Para realizar presentaciones en modo offline, puede usarse el servidor HTTP simple de python que utiliza el puerto 8000 por defecto
        $ python -m SimpleHTTPServer
      • Para publicar las transparencias en PDF es recomendable utilizar la opción de impresión de Google Chrome estableciendo la resolución de pantalla a 1024×768
    • El contenido también puede ser publicado en formato PDF como un documento de trabajo mediante programas como typora
    • Nuestros gestor de versiones, Bitbucket Server, permite incorporar archivos de texto con extensión .md que se previsualizan en el navegador web de manera similar a lo que ofrece el conocido GitHub
      • Al incorporar el texto de nuestro material al gestor de versiones, la trazabilidad de cambios es obtenida de manera automática
      • En el mismo repositorio, pueden incorporarse los ejemplos de código fuente para que sean mantenidos de manera conjunta con el material formativo
    • Las soluciones a los ejercicios planteados, las almacenamos como un patch del proyecto original
      $ diff -ruN /wkrspc/base-backend/src/ /wkrspc/base-backend-solved/src/ > solutions.patch

Una vez automatizado este método de trabajo, hemos comprobado que nuestro material es de más utilidad tanto para nosotros como para nuestros alumnos.

Os dejamos a continuación algunos ejemplos para que os hagáis una idea de lo que hemos obtenido tras pasarnos a escribir el material formativo en Markdown:

Código original en Markdown

![keensoft](images/keensoft-logo.png)
# Formación Alfresco Developer
## keen**soft**
---
![ACE](images/conceptos.png)
# Temario ACE
---
# Descripción del curso
Duración: 4 jornadas de 6-8 horas

Requisitos previos

* Conocimientos básicos de programación Java
* Conocimientos básicos de Git, Maven y Eclipse
* Equipo de desarrollo con Alfresco y Alfresco SDK instalado

Temario

* Día 1 – Introducción
* Día 2 – Integración
* Día 3 – Desarrollo
* Día 4 – Administración (opcional)

---

# Día 1 – Introducción

Arquitectura

* Repositorio, Base de Datos, SOLR

Protocolos

* HTTP, WebDAV, FTP, CIFS, SPP, CMIS, IMAP, SMTP

Subsistemas

* Notificaciones, auditoría, autenticación, almacén de contenidos, email, sistema de ficheros, Google Docs, LibreOffice, búsqueda

Conceptos básicos

* Modelado de contenido, eventos (behaviours y policies), reglas de carpetas, acciones y transformaciones

Workflows

* Activiti

---

# Día 2 – Integración

CMIS

* Apache Workbench, Apache HTTP, curl

REST API

* swagger.io

Alfresco SDK

* Configuración del entorno de desarrollo, desarrollo RAD, compilación y despliegue de artefactos

Alfresco APIs

* Foundation Services API, Freemarker Services API, JavaScript API

Alfresco Web Scripts

* Java, JavaScript

---

# Día 3 – Desarrollo

Repositorio

* Modelos de contenido, acciones, behaviours, extensión de componentes nativos

Share

* Aikau
* Configuración
* Extensión de componentes nativos: declarativa, programática
* Sobreescritura de componentes nativos: surf, aikau

Selección, personalización y desarrollo de addons

Buenas prácticas de desarrollo

---

# Día 4 – Administración (opcional)

Instalación

* Validaciones previas, pruebas de capacidad, métodos de instalación, proceso de instalación, configuración de servidores, configuración de subsistemas, verificación
* Dimensionamiento horizontal y vertical
* Configuración SSL

Administración

* Arranque y parada, consolas web de administración, gestión de permisos, configuración del sistema (repo y share), búsquedas, transformaciones, workflows, almacenes de contenido, auditoría

Mantenimiento

* Monitorización, respaldo y restauración, actualización, ficheros de traza, problemas comunes
* Gestión de paquetes externos

 

Os esperamos en nuestra formación Alfresco 5.1 especializada para desarrolladores

Unidad de negocio, keensoft