Proyecto LSUG - Guia de buenas prácticas en el desarrollo con Liferay

[Roger CARHUATOCTO, modificado hace 12 años.]

Hola LSUG !

a raiz de los comentarios en este thread Buenas prácticas desarrollo de portlets nace la iniciativa de crear un documento de manera colaborativa que refleje recomendaciones, buenas y malas prácticas de cómo desarrollar en Liferay, no sólo el desarrollo de Portlet, también Ext, Hooks, Themes, ...

Tener un documento vivo en constante actualización que refleje las pautas fruto de la experiencia de los miembros de la comunidad, validado y soportado por Liferay sería una buena iniciativa que podemos inciarla desde LSUG.

Sergio González nos sugiere seguir el patrón de trabajo usando gitHub con markdown (https://github.com/liferay/liferay-docs) para la documentación de manera colaborativa, lo cual creo que se ajustaría mucho para este tipo de trabajo.

Quisiera saber vuestro feedback e ideas de cómo iniciar ya con esto.

Mis 5 cents sobre un plan de trabajo

1. Guia de cómo componer documentos de manera colaborativa usando gihub

-> la prepararé, aunque ya se explica en github

2. Guía de estilo

-> pretende normalizar el vocabulario
-> evidentemente iniciaremos con CASTELLANO (Español - Intl), luego haremos las localizaciones al Andaluz, Argentino, Mexicano, ... ;)
-> las traducciones a otros idiomas la dejaremos a otros Users Groups

3. Esqueleto de la Guía de Buenas Prácticas

-> la definiremos todos, lanzaré una propuesta

4. Asignación de líderes por cada apartado o capítulo

-> se encargarán de recopilar tips, buenas o malas prácticas para cada apartado

5. Compilación del documento

-> consolidará toda la documentación
-> revisión ortográfica, gramatical en textos e imágenes/gráficos si los hubiera

6. Fin.

Qué opináis?, cualquier feedback será bienvenido !!

- roger

[Alba García, modificado hace 12 años.]

Creo que esto, aunque sea para el Inglés, podría servirnos de ayuda a la hora de la edición del documento.

Liferay Editorial Guidelines

[Juan Gonzalez P, modificado hace 12 años.]

La idea me parece fantástica Roger.

Muchas gracias por coordinar esto.

Roger CARHUATOCTO:

-> evidentemente iniciaremos con CASTELLANO (Español - Intl), luego haremos las localizaciones al Andaluz, Argentino, Mexicano, ... ;)

Traducir al Andaluz?

[Roger CARHUATOCTO, modificado hace 12 años.]

Gracias Alba! ... sí, servirá ... y gracias Juan!

Hoy hemos hablado de muchas cosas en el #LSUG Alicante y sobre esta iniciativa algunos comentarios.

1. Hay mucho knowhow entre la gente de los LSUG, foros, blogs.... debemos proveer algún protocolo para recoger esa experiencia y así crear un KnowledgeCenter

2. Podemos usar XMLPF para crear una app rápida para introducir esta experiencia y así centralizado

3. La Guía debe contemplar los *puntos más calientes* en el desarrollo (regla de pareto 80%-20%): patrones de arquitectura, servicios, seguridad, testing, autenticación, accesibilidad, terminales móviles, .....

4. Mapear KnowledgeBase con la Guía

5. KnowledgeBase y Guía multi-idioma

6. Para el KnowledgeBase seguir un modelo muy similar a StackOverflow.com

7. Guías para Desarrollo y Sistemas

8. Tools:
- Script para automatizar la validación una instalación de Liferay
- Script para hacer un security code review para Portlets, Hooks, Ext, Themes... o crear filtros para alimentar plugins de eclipse como PMD, FindBugs....
- Test Cases de ejemplo para pruebas funcionales y de carga: test cases que describan qué se prueba, cómo se prueba y qué herramientas usar: JMeter, Selenium, Badboy, ....

Os agradezco vuestro feedback.

Saludos.

Roger

[Alba García, modificado hace 12 años.]

¿A que te refieres con esto?

2. Podemos usar XMLPF para crear una app rápida para introducir esta experiencia y así centralizado

No había oido nunca hablar de eso

[Roger CARHUATOCTO, modificado hace 12 años.]

Comentamos en el LSUG de Alicante que sería interesante tener algo similar al Knowledge Base de MS, tener una app que nos permita introducir tips o recomendaciones. Todos tenemos algún truco, sugerencia, trozo de código o de configuración que podemos compartir.
Para tener esa app podríamos usar XMLPF ( http://www.xmlportletfactory.org) para crear rápidamente una app y así poder introducir está información.

Saludos.

[Juan Fernández, modificado hace 12 años.]

Alba García:

¿A que te refieres con esto?

2. Podemos usar XMLPF para...

No había oido nunca hablar de eso

Aquí tienes un regalito, Alba: míralo que te gustará xmlportletfactory.org

[Roger CARHUATOCTO, modificado hace 12 años.]

Vamos LSUG, ... necesito vuestro feedback !!

Saludos.

[Juan Fernández, modificado hace 12 años.]

Hola Roger:

a mí me parece una iniciativa brutal *pero* la forma de llevarla a cabo no la veo muy clara. Hablas de Knowledge Base, de crear portlets de gestión del conocimiento... ¿para desplegarlos dónde? Por que en liferay.com es imposible ¿Tendríamos que crear y mantener nosotros esa nueva web? Mucho curro...

Creo que lo mejor es mantener las cosas simples y tal vez con una sección nueva en la wiki del #LSUG sería suficiente. Así podríamos ir añadiendo nuevos artículos y clasificándolos como mejor nos parezca, para luego, cuando tuviéramos una base de artículos, crear un pdf descargable con todos los artículos bien organizados y así tendríamos una guía de buenas prácticas creada por la comunidad que se actualizaría a menudo y evolucionaría según las disponibilidades de los miembros del #LSUG

¿Qué te parece?
Un saludo,
Juan

[Ignacio López Flores, modificado hace 12 años.]

Roger, cuenta con otro más!

En la medida de lo posible, intentaré escribir las experiencias que he tenido, para que entre todos consigamos tener una buena base de conocimiento y "saber hacer".

[Juan Gonzalez P, modificado hace 12 años.]

Juan Fernández:

Hola Roger:

a mí me parece una iniciativa brutal *pero* la forma de llevarla a cabo no la veo muy clara. Hablas de Knowledge Base, de crear portlets de gestión del conocimiento... ¿para desplegarlos dónde? Por que en liferay.com es imposible ¿Tendríamos que crear y mantener nosotros esa nueva web? Mucho curro...

Creo que lo mejor es mantener las cosas simples y tal vez con una sección nueva en la wiki del #LSUG sería suficiente. Así podríamos ir añadiendo nuevos artículos y clasificándolos como mejor nos parezca, para luego, cuando tuviéramos una base de artículos, crear un pdf descargable con todos los artículos bien organizados y así tendríamos una guía de buenas prácticas creada por la comunidad que se actualizaría a menudo y evolucionaría según las disponibilidades de los miembros del #LSUG

¿Qué te parece?
Un saludo,
Juan

De acuerdo en esto. La Wiki se hizo para este tipo de cosas no? (excepto lo de hacer portlets, claro).

[Juan Fernández, modificado hace 12 años.]

Juan Gonzalez P:

Roger CARHUATOCTO:

-> evidentemente iniciaremos con CASTELLANO (Español - Intl), luego haremos las localizaciones al Andaluz, Argentino, Mexicano, ... ;)

Traducir al Andaluz?

Juas! Me parto! Como sevillano, me he encargado de liderar esta traducción y ya tengo el primer trozo traducido. Os dejo un extracto a continuación:

Enga mi'arma, ahora vamoh a creá un pórle, con to'l arte que podamoh esharle ¡vámonoh!

[Xavier Moreno, modificado hace 12 años.]

Juan Fernández:

Juan Gonzalez P:

Roger CARHUATOCTO:

-> evidentemente iniciaremos con CASTELLANO (Español - Intl), luego haremos las localizaciones al Andaluz, Argentino, Mexicano, ... ;)

Traducir al Andaluz?

Juas! Me parto! Como sevillano, me he encargado de liderar esta traducción y ya tengo el primer trozo traducido. Os dejo un extracto a continuación:

Enga mi'arma, ahora vamoh a creá un pórle, con to'l arte que podamoh esharle ¡vámonoh!

+1000 Traducción al andaluz ya

Bueno, la idea de la guía de buenas prácticas o del wiki, no pasa por ser una mera fuente de referencia, la wiki oficial y la guía casi más basada en la experiencia. Al margen del camino a seguir, otro de las ideas que surgió en la quedada alicantina, fue el intentar apostar por una sitio tipo Stackoverflow (me imagino que lo conoceremos todos), donde siempre todas la información importante está mucho más clara y accesible, que no tal y como se encuentra en los foros. A parte, tiene una mejor categorización, formas de buscar, hay "karma" entre los usuarios, por lo que puedes ver que usuario es más "de fiar" a parte de dar una especie de incentivo a responder, etc.. en resumidas cuentas, pasar de la web 1.0 (foros) a la 2.0 (colaborativo).. creo que este gráfico de la propia web, más o menos simplifica todas estas líneas ;)



Pues nada, ¿qué opináis al respecto, mi ' armas :-P?

[Juan Fernández, modificado hace 12 años.]

El tema de Stackoverflow ya está implementado en 6.1, así que es cuestión de tiempo que migremos liferay.com a dicha versión para que tengamos esa funcionalidad.
Sin embargo eso no es incompatible con comenzar el proyecto que propone Roger.
Lanzo la pregunta al aire ¿siguientes pasos a dar? ¿Por dónde empezamos? ¿Quién quiere escribir sobre qué?
Últimamente Miguel Ángel Pau está escribiendo unos artículos interesantísimos sobre SEO en su blog. Sería guay hacer artículos de ese estilo.

[Xavier Moreno, modificado hace 12 años.]

Hmm.. la verdad es que yo creo que los primeros pasos a dar sería el poner un poco en común una guía o estructura de los pasos a desarrollar. Ya que, por ejemplo, yo a la hora de desarrollar portlets, estoy más acostumbrado a montarlos haciendo uso de Spring que no un LiferayPortlet, etc.. vamos, que cada uno tiene su propia "guía de desarrollo" pero no por ello debe ser "buenas prácticas", de ahí que lo ideal sería delimitar las pautas, metodología, etc. a seguir a la hora de desarrollar esta guía. No sé si me he explicado claramente, espero que sí ;)

Un saludo

[Alba García, modificado hace 12 años.]

Propongo una de las cosas que deberíamos incluir en la guía o por lo menos que a mi me interesa.

• Buenas prácticas para el uso del log

Por lo que tengo entendido habría que usar siempre las clases del paquete com.liferay.portal.kernel.log, declarar una variable private static final al final del código _log y siempre preguntar si el modo depuración está habilitado antes de escribir algo en el log Ej:

if (_log.isDebugEnabled()) {… _log.debug(…)  ...}

También me interesaría que debatiésemos los siguientes puntos:

• Buenas practicas en el uso de Hibernate a la hora de crear portlets que hagan uso de Base de Datos tanto de la del portal como de otro esquema distinto.
• Como determinar mediante creación de bancos de pruebas si un portlet cumple las Buenas Practicas.
• Como saber si un Site es pesado o no para tenerlo presente antes de importarlo en mi instancia de Liferay para no deteriorar el servicio del resto al resto de Sites de la instancia.
• Buenas practicas en la integración de Liferay con un Gestor Documental Ej.: Alfresco, OpenOffice,...

Seguro que se me irán ocurriendo mas cosas que deberían estar en esta Guía para basarnos en la experiencia de los desarrolladores y administradores de Liferay.

[Sergio González, modificado hace 12 años.]

Respecto al cómo o dónde hacerlo... qué os parece hacerlo en GitHub? Ahora mismo la documentación oficial de Liferay (developer guide, user guide, etc...) está dentro de GitHub y es muy sencillo la colaboración, ya que simplemente se envía una pull request con los cambios y se aplican. Para la documentación oficial se está utilizando markdown que es muy sencillo de leer y luego queda bastante bonito de cara a ponerlo en una web o a un PDF.

Para mí lo que me parece atractivo de la idea de github es la de que sea algo centralizado, de modo que permite una colaboración muy sencilla por parte de cualquier persona (enviando una pull request o directamente haciendo comentarios sobre el texto desde la interfaz de github), y a la vez y muy interesante es que tiene que haber alguien que se encargue de hacer la revisión de todo lo que se envía, de modo que se mantiene una coherencia y consistencia a la hora de redactar, de formato, ejemplos, etc. que convierte la lectura en algo muy atractivo. Ese precisamente es el problema de la Wiki, que al final cada artículo o página es completamente distinto a todos los demás, mientras que una buena guía debe de tener esa consistencia a lo largo de las distintas secciones y páginas.

Qué os parece?