Manual de uso del repositorio de software: gforge.i-math http://gforge.i-math.cesga.es Andrés Gómez, Administrador de Aplicaciones y Proyectos, CESGA Coordinador José Carlos Mouriño, Técnico Superior de Aplicaciones, CESGA Mª Teresa Sánchez, Técnico Computing Nodo CESGA i-math
2
ÍNDICE 1. INTRODUCCIÓN... 5 2. CUENTAS DE USUARIO...7 2.1. CÓMO CREAR UNA CUENTA?... 7 2.2. PÁGINA DE USUARIO... 9 3. CREAR UN PROYECTO PROPIO... 11 3.1. CÓMO CREAR UN PROYECTO?... 11 4. TIPOS DE PROYECTOS... 15 5. ACCEDER A UN PROYECTO... 16 6. ADMINISTRAR UN PROYECTO... 19 6.1. LA PÁGINA DE ADMINISTRACIÓN DEL PROYECTO... 19 7. UNIRSE A UN PROYECTO... 21 8. AGRADECIMIENTOS... 23 3
4
1. Introducción El repositorio de software gforge.i-math nace con el objetivo de incrementar la visibilidad internacional del software de matemática computacional, generalista o especializado, desarrollado por los grupos de investigación del Proyecto Ingenio Mathematica. En este repositorio se recogerán tanto códigos completos como librerías o utilidades que puedan ser de interés para el resto de participantes del proyecto. Además, los investigadores en Matemáticas encontrarán en esta aplicación diversos links con otros repositorios del mismo ámbito, puestos en marcha por organismos de experiencia contrastada. Qué es un repositorio de software? Un repositorio de software es un entorno de desarrollo colaborativo para facilitar la creación, el mantenimiento y la distribución de proyectos, tanto de creación de software como de documentación. En el repositorio de software gforge.i-math se pueden encontrar: páginas web para cada proyecto, herramientas de comunicación privada entre los miembros de un equipo de desarrollo, herramientas de comunicación con los usuarios, herramientas para distribución de software, herramientas para el control de versiones, seguimiento de errores (bugs) y asignación de tareas. La página web de esta forja es: http://gforge.i-math.cesga.es y su página de inicio se muestra en la Figura 1. Este repositorio de software se ha desarrollado con el paquete de software GForge (http://gforge.org), un sistema de gestión de desarrollo colaborativo de software utilizado habitualmente en el entorno de software libre. El servidor en el que se encuentra alojado el repositorio es una máquina Linux sobre una distribución Fedora Core 6 que se encuentra alojado en el Centro de Supercomputación de Galicia. Se realizan copias de seguridad completas del mismo cada semana e incrementales diariamente. 5
Figura 1. Página de inicio de gforge.i-math 6
2. Cuentas de usuario Las cuentas de usuario en gforge.i-math son necesarias para participar en el desarrollo de algún proyecto de software dentro del repositorio. El repositorio también admite visitantes que no necesitan generar una cuenta de usuario; los visitantes tendrán acceso al software alojado y a la documentación correspondiente, también podrán acceder a los foros y listas de correo. Sin embargo, para participar activamente en los foros de discusión o inscribirse en las listas de correo de los distintos proyectos, sí será necesario registrarse y ser miembro del proyecto de interés. 2.1. Cómo crear una cuenta? Cliquear en el enlace Nueva cuenta / New account (ver Figura 2). Cumplimentar los campos del formulario de registro y pulsar el botón Regístrese / Register. Nombre de la cuenta / Login Name * (mínimo 3 caracteres; máximo 15 caracteres; no use mayúsculas) Contraseña / Password * (mínimo 6 caracteres) Título / Title Nombre / First Name * Apellidos / Last name * Idioma / Language Choice Zona horaria / Timezone Tema / Theme País / Country E-mail / Email Address * Dirección / Address Teléfono / Phone Fax / Fax No olvide rellenar todos los campos marcados con * ya que son obligatorios. 7
Automáticamente el solicitante recibirá un correo electrónico de confirmación. El proceso de registro se completa siguiendo las instrucciones del correo de confirmación. Figura 2. Crear una cuenta de usuario en gforge.i-math Una vez creada la cuenta, se puede acceder a la misma de dos maneras: Cliqueando en la pestaña Mi página / My page, o Cliqueando en el enlace Entrar / Log in. 8
2.2. Página de usuario Cada vez que acceda a su cuenta en gforge.i-math, accederá a su página de usuario, Mi página / My page (ver Figura 3). Figura 3. Página de usuario en gforge.i-math La página de usuario contiene los siguientes menús: Assigned Artifacts: Este menú muestra los elementos del registro asignados al usuario (bugs, parches, nuevas funcionalidades, etc.). Sólo se muestran los elementos abiertos, es decir, aún sin resolver. Assigned Tasks: Este menú muestra las tareas asignadas al usuario por los administradores de los distintos proyectos a los que pertenece. Submitted Artifacts: Muestra los elementos del registro enviados por el usuario al administrador de algún proyecto al que pertenece. 9
Monitored Items: En este menú el usuario puede monitorizar foros o ficheros. Puesto que para cada proyecto abierto en el repositorio habrá su correspondiente foro, el usuario puede elegir monitorizar alguno de los foros de su interés para recibir todas las opiniones incorporadas, sin necesidad de visitar repetidamente la página del mismo. Del mismo modo puede elegir monitorizar los ficheros de algún proyecto en el que colabore, de modo que recibirá un aviso cada vez que se publiquen nuevas versiones de ficheros a descargar del proyecto. Projects: Muestra los proyectos activos en los que el usuario participa o ha participado en su desarrollo. Cliqueando en un proyecto se accede a la página del mismo. Además, en la página de usuario aparecen los siguientes enlaces: Diario y Notas / Diary and Notes: Esta opción permite crear notas relacionadas con su actividad en gforge.i-math. El usuario puede decidir si sus notas son públicas o privadas. Mantenimiento de la cuenta / Account Maintenance: Permite modificar los datos de usuario introducidos en el formulario de registro. Registrar un nuevo proyecto / Register Project: Permite registrar un proyecto en gforge.i-math. 10
3. Crear un proyecto propio En el repositorio de software gforge.i-math se pueden alojar proyectos creados y desarrollados por los investigadores de Ingenio Mathematica. Se pueden alojar tanto códigos completos, como librerías o programotecas, utilidades, etc. 3.1. Cómo crear un proyecto? Prerrequisito: Ser un usuario registrado de gforge.i-math y ser miembro de algún grupo de investigación del Proyecto Ingenio Mathematica. Desde la página de usuario, cliquear en el enlace Registrar un nuevo proyecto / Register Project. Cumplimentar el formulario de registro de proyecto: Nombre completo del Proyecto / Project full name (máximo 40 caracteres). Resumen y objetivos del Proyecto / Project Purpose and Summarization: Se le solicita una descripción detallada y precisa del proyecto que será enviada al administrador de gforge.i-math para su aprobación. Licencia / License: Escoja un tipo de licencia (ver Figura 4). Desde gforge.i-math recomendamos las licencias de software libre GNU GPL y GNU LGPL. Descripción Pública del Proyecto / Project Public Description: Esta descripción se mostrará en la página principal de su proyecto. Nombre Unix del Proyecto / Project Unix Name: Escoja un nombre Unix para su proyecto (ver detalles en Figura 5). SCM / SCM: Escoja una herramienta de versionado, CVS o Subversion. Una vez seleccionada una herramienta no se puede modificar. Desde la Forja i- MATH se prestará soporte únicamente a Subversion (SVN). Enviar el formulario cliqueando en el botón Enviar / Submit. 11
Figura 4. Formulario de registro de un proyecto en gforge.i-math 12
Figura 5. Formulario de registro de un proyecto en gforge.i-math (cont.) 13
Una vez enviado el formulario, la solicitud de aceptación del proyecto será remitida al administrador de gforge.i-math para su aprobación. Para que este trámite sea más rápido posible es recomendable que el resumen del proyecto sea lo más preciso posible pero sin llegar a un nivel de detalle excesivo. Cuando el proyecto sea aprobado, el usuario recibirá varios correos electrónicos de confirmación que contienen información importante para el acceso a los servicios proporcionados. Se recomienda no eliminar dichos correos, especialmente el relacionado con la creación de la lista de correo asociada ya que se suministrará la contraseña de la misma. Una vez aprobado un proyecto, el proceso de creación de los servicios (repositorio de código, listas de correo, etc.) se realizará en las 72 horas siguientes a la recepción del correo de confirmación de creación del proyecto. 14
4. Tipos de proyectos Los proyectos de la Forja i-math pueden ser de dos tipos: Proyectos públicos: Cualquier usuario de internet puede acceder a la información del proyecto a través de la interfaz web, tanto a la descripción del proyecto, como a la documentación y ficheros de las distintas versiones. Únicamente no podrán acceder a la pestaña SCM para el acceso al repositorio de control de versiones. Proyectos privados: Únicamente los miembros del proyecto pueden acceder a la información del mismo. Los proyectos privados no aparecen en el Árbol de proyectos de la Forja. 15
5. Acceder a un proyecto Todos los usuarios pueden acceder a los proyectos del repositorio de software gforge.i-math de las siguientes formas (ver Figura 6): Usando la opción de búsqueda. Desde el Árbol de proyectos / Project Tree. Desde la pestaña Proyectos / Projects de su página de usuario. Figura 6. Acceder a un proyecto de gforge.i-math 16
De esta manera se accede a la página principal del proyecto seleccionado, donde aparecen varias pestañas en las que obtener información o llevar a cabo distintas actividades sobre el mismo (ver Figura 7). Figura 7. Pestaña Resumen de un proyecto en gforge.i-math 17
Si es visitante del proyecto, y éste es de tipo público, tendrá acceso a las pestañas: 1. Resumen / Summary donde podemos obtener la siguiente información: Descripción del proyecto y estadísticas. Administradores y miembros del proyecto. Últimas publicaciones de ficheros. Área pública: Información sobre registro, foros, gestión de documentos, listas de correo, gestión de tareas, etc. Últimas noticias 2. Actividad / Activity donde se muestra un listado de las actividades llevadas a cabo tales como apertura de bugs, envío de mensaje a los foros, etc. 3. Foros / Forums permite acceder a los foros del proyecto. 4. Listas / Lists permite acceder a las listas de correo asociadas al proyecto. 5. Tareas / Tasks donde se muestra un listado de las tareas llevadas a cabo y a realizar en el proyecto. 6. Documentos / Docs donde se listan toda la documentación generada en el desarrollo del proyecto. 7. Noticias / News recoge todas las noticias que se generan en el desarrollo del proyecto. 8. SCM permite acceder al control de versiones del proyecto usando el software específico Subversion. 9. Ficheros / Files donde se pueden encontrar todos los ficheros para descargar el software generado en el proyecto. Si además es usuario registrado de gforge.i-math y se ha inscrito como miembro del proyecto, podrá participar activamente en todos los ítems anteriores sea el proyecto de tipo público o privado. Si es administrador del proyecto podrá acceder a todas las utilidades de la pestaña Admin. 18
6. Administrar un proyecto Para administrar un proyecto es necesario ser miembro de dicho proyecto con privilegios de administrador. Por defecto, el usuario que creó el proyecto, tiene privilegios de administrador. 6.1. La página de administración del proyecto Desde esta página se pueden administrar todos las acciones asociadas a un proyecto. Para acceder a ella un administrador del proyecto debe: Acceder a su cuenta de usuario. Seleccionar el proyecto desde su página personal lo que le llevará a la página Resumen / Summary del proyecto. Seleccionar la pestaña Admin. A través de la página de administración se pueden llevar a cabo tareas administrativas como: Activar o desactivar servicios del proyecto. Añadir usuarios al proyecto y asignarles roles. Crear nuevos elementos del registro, utilidades, parches, nuevas funcionalidades, foros, listas de correo, etc. 19
Figura 8. Página de administración de un proyecto en gforge.i-math 20
7. Unirse a un proyecto Para unirse a un proyecto del repositorio de software gforge.i-math, es necesario: Prerrequisito: Ser miembro registrado del repositorio. Solicitar al administrador del proyecto permiso para unirse como miembro del proyecto cliqueando en el enlace Unirse al proyecto / Request to join o enviando un correo electrónico a los administradores. Figura 9. Unirse a un proyecto de gforge.i-math 21
Se puede participar en un proyecto con distintos roles. Los roles sirven para controlar el acceso a los foros, listas de correo, documentación, etc. El repositorio de software gforge.i-math tiene predefinidos distintos tipos de roles: Senior Developer: permisos de lectura y escritura en el control de versiones SCM; administración de foros, documentación y tareas. Junior Developer: permisos de lectura y escritura en el control de versiones SCM; acceso completo a los foros y tareas. Support Tech: permiso de lectura en el control de versiones SCM; acceso completo a los foros. Doc Writer: permiso de lectura en el control de versiones SCM; acceso completo a los foros; administración de la documentación. 22
8. Agradecimientos La realización de este proyecto contó con la colaboración del personal técnico del Centro de Supercomputación de Galicia CESGA, tanto para la instalación de la infraestructura que alberga el repositorio como para la realización de tareas de mantenimiento. En particular, queremos agradecer la ayuda en esta actividad de Juan Villasuso, Técnico de Comunicaciones del CESGA. 23