#LSUG Project #1 - Quota Control App #
Bienvenida #
¡Bienvenido a la wiki del primer proyecto del grupo de usuarios de Liferay España! Es la primera vez que desarrolladores y apasionados de toda nuestra geografía se pondrán en común para desarrollar herramientas open source que luego compartiremos con toda la comunidad
Introducción al proyecto #
La idea del primer proyecto es reunirnos (física o remotamente) un sábado (el 26 de Enero) y entre todos crear un plugin para el control del espacio en disco que puede consumir cada site, instancia, usuario en Liferay. Desde el panel de control se podrá determinar qué tamaño máximo puede tener la biblioteca de documentos y se comprobará en cada subida de documentos que no se exceden dichas cuotas.
Resumen de requisitos propuestos #
- Control de Cuota debe ser aplicable a: instancias, organizaciones, sitios web, usuarios, roles, grupos de usuarios y teams
- Visualización de espacio asignado y espacio consumido para usuarios y administradores (mostrar histórico y evolución del consumo):
- Mensajes de alerta cuando se llega a X% o cantidad de cuota determinada (vía mail y visual en la UI)
- Deberá tener en cuenta los attachments de todos los portlets (escucha de servicios varios)
- Solicitud de aumento de cuota: forma de notificar al admin. Esto debería ser opcional (configurable)
- Integración en el sistema de permisos: definir acciones tales como crear, editar, eliminar cuota
- Log/auditoría de cambios en la configuración
- Poder visualizar cuotas desde Liferay Sync
- Soporte para control de cuotas de otras entidades: número de blogs, número de MBDiscussions, número de carpetas...
Milestone #1: funcionalidades #1, #2, #3, #4 Milestone #2: funcionalidades #5 y #6
Portlets a desarrollar #
- Server Quota: portlet de administración general para cuotas de instancias en la sección "Server" del panel de control. Será usado por sysadmins.
- Portal Quota: otro portlet para la gestión de cuotas para roles, usergroups y sites en la sección "Portal". Será usado por portal admins.
- Site Quota: portlet de gestión específica de site en la sección del control panel de cada site: se gestionará la cuota de cada usuario y team. Será usado por site admins.
- My Quota: portlet para cada usuario, donde podrá ver qué ha consumido, qué le queda aún y donde estará la opción de solicitar más espacio (ver funcionalidad #5)
Mockups de las UIs #
Enlace a la entrada de Miguel Angel Pau donde se detallan las propuestas de interfaces gráficas (también como adjuntos al final de la página)
Organización #
- Lugar: El Entrego (Asturias). Avd. de la Vega, 4.
- Fecha: 26 de Enero de 2012.
- Horario: 10h - 19h
- Skype: LSUGuser
- IRC: webchat.freenode.net, canal ##LSUG
¿Como llegar?
Para los que vengáis desde fuera de Asturias:
Para quedar con otros miembros, comentadlo en el foro; en caso de ya existir un grupo, se incluirá la información en esta wiki.
Será posible asistir en remoto a la reunión via Skype, el usuario de Skype que creará la reunión será LSUGuser, y mediante la conexión al canal IRC ##LSUG de freenode. El horario establecido es flexible: si no puedes asistir durante todo el evento no pasa nada, así que no hay disculpa que valga!
Para llevar un control de la gente con la que contamos, apuntáos al grupo que más se ajuste a vuestro perfil. Si hubiera un rol diferente a estos, añadidlo a continuación.
- Equipo de desarrollo:
- Juan Fernández
- Adolfo Pérez
- Alberto Martínez Ballesteros
- Javier Lora Peribáñez
- Roberto Díaz (no todo el día)
- Toni Pérez
- Patricia Hevia
- Equipo de diseño gráfico y UX:
- Equipo de QA:
- Luis Mas (Pruebas y Traducción Inglés/Español/Catalán)
- Juan A. Fernández M.
- Equipo de documentación y publicación:
- Albert Coronado (Publicar al Marketplace)
Infraestructura #
- Desarrollo
- Gestión de tareas: usaremos las issues de github para gestionar las tareas. Escoge una tarea (bug o new feature) que esté sin asignar y cuando la tengas lista, haz una Pull Request para que el código sea introducido en la rama master.
- Workflow de trabajo: la idea es hacer desarrollo colaborativo en base a muy pequeñas iteraciones. Cada desarrollador escogerá una tarea y al terminar hará pull request al repositorio. Cada pull será revisada y formateada para dar consistencia al código y que no haya conflictos y luego publicada en la rama master del repositorio.
- Entornos recomendados: cada uno es libre de montarse el entorno como desee, pero para el que no tenga una preferencia clara, se recomienda usar el Liferay IDE
- Gestión de código: para desarrollar de forma colaborativa, haremos uso de github. Hemos creado un repositorio (Quota Control Portlet) al que podéis hacer un fork para trabajar.
- Normas de estilo: para que todo sea consistente, debemos seguir la Guía de estilo de Liferay
- Comunicación: durante todo el día estaremos conectados por Skype (usuario LSUGuser) y al canal IRC ##LSUG en freenode. Además para cada consulta particular se puede usar mensajería instantánea (Gtalk o chat de Skype) para no ocupar los canales comunes.
Configuración del entorno y contribuciones #
- Descarga el plugins sdk desde este link
- Haz un Fork del repositorio
En la URL https://github.com/LSUG-Projects/quota-control-portlet haz click en "Fork"
¡Y listo!¡Ya puedes empezar a contribuir! Los pasos para contribuir una mejora son
- Crea una rama para tu nueva funcionalidad:
git checkout -b mi-nueva-funcionalidad
- Haz Commit de tus cambios:
git commit -am 'Mi nueva funcionalidad'
- Haz Push a tu repositorio:
git push origin mi-nueva-funcionalidad
- Envíanos la pull request (Using pull requests)
