Differences between revisions 39 and 40

Deletions are marked like this. Additions are marked like this.
Line 182: Line 182:
Para borrar un proyecto tenemos que navegar hacia el proyecto del que deseemos eliminar los archivos, una vez en la portada del proyecto, nos dirigiremos a la pestaña ficheros: Para borrar ficheros en un proyecto tenemos que navegar hacia el proyecto del que deseemos eliminar los archivos, una vez en la portada del proyecto, nos dirigiremos a la pestaña ficheros:
Line 194: Line 194:
De esta forma se nos presentara una nueva pantalla en la que se nos permite borrar los ficheros necesario: De esta forma se nos presentara una nueva pantalla en la que se nos permite borrar los ficheros necesarios:

Manual de usuario de GForge


Contenidos

1. Introducción


Gforge es un sistema de software que permite gestionar proyectos. Aunque enfocado principalmente al Software, gracias a su soporte de Plugins, se puede adaptar a cualquier tipo de proyectos. Gforge fue una de las ramas libres del código original usado por sourceforge.net, y el líder del proyecto es uno de los creadores.

En este manual nos centraremos en el uso del mismo para gestionar la subida/descarga de los proyectos asi como hacer búsquedas... Cosas practicas en definitiva para facilitarnos el uso diario de la herramienta.

2. Primeros pasos


2.1. Darse de alta

El primer paso dentro de la forja es darse de alta como usuario. Para ello es necesario especificar una serie de datos sobre el nuevo usuario que se solicitan en el formulario de alta de usuario. En la parte superior izquierda de nuestro navegador, encontraremos un enlace a nueva cuenta, y tras pinchar sobre él, aparecerá el formulario de alta de usuario. En dicho formulario puede personalizarse el idioma en el que queremos visualizar el contenido del sitio web. Ni que decir tiene que, a la hora de rellenar el campo contraseña, es conveniente usar cualquier cadena alfanumérica sin orden lógico.

Tras esto recibiremos un email de confirmación a la cuenta de correo que especificamos en el formulario de alta de usuario. Se nos pedirá que pinchemos sobre un enlace para validar la cuenta. Al pinchar sobre él, se abrirá una ventana para completar el registro, que concluirá validando el nombre de usuario y la contraseña. El proceso de registro puede visualizarse en las siguientes capturas de pantalla:

2.2. Login/logout como usuario

Para comenzar a trabajar en la forja debemos iniciar una sesión. En la parte superior del navegador, pinchando sobre el enlace entrar se accede al formulario de ingreso de sesión. En este formulario debemos introducir el nombre de usuario y la contraseña especificadas en el registro. Para salir de la sesión el usuario debe pinchar, también en la parte superior del navegador, sobre el enlace salir

2.3. Registrar un proyecto nuevo

Para registrar un proyecto es necesario haberse autenticado como usuario. Una vez dentro pulsaremos en el enlace mi página y posteriormente en Registrar un nuevo proyecto, en la parte inferior izquierda del navegador. De manera análoga al formulario de alta de usuario, rellenaremos los campos del proyecto en el formulario de registro de proyecto., p. ej., nombre completo del proyecto, la licencia del proyecto o la descripción del proyecto (la descripción del proyecto es pública).

El último campo que tenemos que elegir es un nombre tipo unix para el proyecto. El nombre-unix tiene ciertas restricciones:

  • No puede coincidir con el nombre-unix de otro proyecto.
  • Su longitud debe estar entre 3 y 15 caracteres.
  • Debe contener caracteres numéricos, alfanuméricos y guiones.
  • Las letras deben ser minúsculas.
  • Debe ser un nombre válido para sistemas unix.
  • No debe coincidir con dominios reservados.
  • No podrá cambiarse nunca para ese proyecto.

Su nombre-unix es importante porque se utiliza para varios usos, incluyendo:

  • El nombre del sitio: nombre-unix.gforge.zylk.net:8888
  • La raíz de un repositorio CVS/cvsroot/nombre-unix en cvs.nombre-unix.gforge.zylk.net:8888
  • Acceso a una cuenta shell como nombre-unix.gforge.zylk.net:8888
  • Elementos de búsqueda en este sitio.

/!\

Es importante tener en cuenta unos estandares que tendremos que implementar a la hora de elegir el nombre UNIX, ya que lo deberemos hacer de la siguiente forma para que no alla ningun tipo de error en la base de datos. 

Los proyectos que provengan del programa KZlankidetza se denominarán de la siguiente forma:

lankidetzaNNNNN

Es decir la palabra lankidetza y un número de 5 cifras. En realidad se ha calculado para llegar al máximo de caracteres que adminte el nombre (15). La idea es que NNNNN sea un secuencia que comience en 00001 --> 99999.

Los proyectos cuyo origen sea alguna de las empresas de ESLE o la propia asociación:

asociaesleNNNNN

Es decir la palabra asociaesle y un número de 5 cifras. Se ha calculado para llegar al máximo de caracteres que adminte el nombre (15). La idea es que NNNNN sea un secuencia que comience en 00001 --> 99999.

Las secuencias serán gestionadas por ESLE.

3. Funciones específicas de usuario


3.1. Carpeta personal de usuario (Mi página)

En la página principal de cada usuario se encuentran los datos relativos al usuario, como los proyectos en los que está involucrado. Desde aquí se pueden monitorizar las diferentes tareas que tenemos asignadas en los proyectos incluyendo el estado de las mismas, así como las tareas que hemos asignado nosotros.

3.2. Diario y notas

Esta sección puede usarse como si de un cuaderno de apuntes se tratase. En ella se pueden guardar notas y consultarlas posteriormente. Es posible elegir que una nota sea de carácter privado o público seleccionando sobre el cuadro donde especifica publica. De este modo cualquier usuario de la forja podrá ver esa nota. En caso contrario si la marcamos como privada únicamente el usuario podrá consultarla.

4. Funciones específicas de proyecto


4.1. Sumario del proyecto

La forja permite una administración sencilla de nuestros proyectos desde nuestra página (mi página) seleccionando el proyecto correspondiente desde el recuadro inferior derecho. Una vez elegido uno de los proyectos accesibles se muestra el resumen del proyecto. El contenido deberá ir en castellano y en euskera, además de incluir el nombre de la empresa que ha realizado el proyecto e indicar la página web de la misma.

En el menú superior del proyecto pueden encontrase unas etiquetas con las siguientes opciones:

  • Admin: Desde aquí puede darse de alta un servidor ssh para el grupo de usuarios que estén dentro del mismo proyecto, tener y modificar un breve resumen del mismo (se trata información pública del proyecto), historial del proyecto, estadísticas, categorías...

// * Tareas: Lista de tareas por hacer.

  • Documentos: Leer, publicar y administrar documentos.

// * Encuestas: Ver las encuestas. // * Noticias: Las noticias asociadas al proyecto.

  • Ficheros: Acceso y administración de los ficheros relativos proyecto.

5. Crear un proyecto


Cuando queramos crear un proyecto iremos a la sección, "mi pagina" y desde allí podremos registrar nuestro nuevo proyecto haciendo click sobre "registrar un nuevo proyecto". Después de rellenar el formulario e introducir correctamente en nombre unix y que el admin de gforge nos apruebe el proyecto ya podremos ya seguir trabajando sobre él. Pudiendo hacer las siguiente (más importantes) operaciones sobre el:

5.1. Subir ficheros

Una vez tengamos nuestro proyecto aprobado podremos añadirle ficheros al mismo, versiones nuevas, actualizar ficheros...

Para subir ficheros debemos seguir las siguientes instrucciones: * Seleccionaremos el proyecto en nuestra pagina principal y desde allí nos llevara a un resumen del proyecto. * Desde allí haremos click sobre "Ficheros", es la ultima pestaña y como podremos ver podemos ver las versiones ya publicadas y de allí podremos subir nuevas versiones de nuestro proyecto...

* Para subir una nueva versión haremos, click sobre "Para crear una nueva versión haga click aquí", nos llevara a un nuevo formulario y desde alli rellenando todo el formulario y seleccionando el fichero que queremos subir nos lo pondrá disponible para su descarga. Quedando la nueva versión dentro de ficheros.

Cuando pongamos un nombre a un fichero usaremos el siguiente convenio:

Deben existir varios archivos:

1) Instalables
2) Código fuente

Ambos empaquetados en archivos (zip)
Debe indicarse además el tipo de procesador al que van destinados los bianrios (i386) si no se indica nada

Adjuntar los archivos (hay que definir los convenios para las versiones de los archivos)

Pueden existir varias versiones de los mismos

* Dentro de "ficheros" deberá incluirse una versión completa en zip que incluya todos los archivos necesarios para la instalación de la aplicación.

/!\

Se deberá utilizar el siguiente convenio para la nomenclatura de los ficheros que se suban de cada proyecto:

1) Cuando se trate de los instalables:

        NombreProyecto_versión_plataforma_installer.zip

  • Donde:
    • NombreProyecto: Es el nombre que se le ha dado al proyecto al que pertenece el fichero

    • Versión: Se trata de una secuencia de números de la siguiente forma:
      • [mayor.menor.revisión], donde numero 'mayor' se cambia cuando hay cambios significativos en la funcionalidad, el número 'menor' cuando se añaden características menores o arreglos importantes, el número 'revisión' se cambia cuando se hagan arreglos de bugs no importantes. En el caso de la primera versión de un proyecto sería: v1.0.0
    • Plataforma: Donde se indica qué plataforma se requiere para ejecutar el proyecto (win32, linux32)
    Ejemplo: para la primera versión del proyecto prueba
    1. prueba_v1.0.0_win32_installer.zip
    2. prueba_v1.0.0_linux32_installer.zip

2) Cuando se trate del código fuente:

 NombreProyecto_versión_src.zip
  • Ejemplo: para la primera versión del proyecto prueba
    1. prueba_v1.0.0_src.zip

5.2. Eliminar ficheros

Una vez logeados y en nuestra pagina de inicio podemos comenzar el procedimiento para administrar los ficheros de un proyecto.

Para borrar ficheros en un proyecto tenemos que navegar hacia el proyecto del que deseemos eliminar los archivos, una vez en la portada del proyecto, nos dirigiremos a la pestaña ficheros:

Desde allí seleccionaremos la opción del menú inferior, admin:

Ya podremos editar los contenidos de la versión sobre la que estamos trabajando haciendo click sobre Editar versión:

De esta forma se nos presentara una nueva pantalla en la que se nos permite borrar los ficheros necesarios:

En caso de hacer click sobre borrar este fichero podrá ser ya borrado.

5.3. Crear una versión de un proyecto

En el momento que mejoremos la versión del fichero que subimos al gforje nos tocara actualizar nuestra versión en el sistema, para esto seguiremos los siguientes pasos, lo primero ir a la pestaña ficheros y desde allí hacer click sobre "Para crear una nueva versión pulse aquí", en la sección "ident.paquete" tenemos la siguiente opción "crea un nuevo paquete". Haremos click sobre ella y de esta forma especificaremos el nuevo nombre de versión así como los parámetros que se nos piden. Podemos ver el proceso en la imágenes de abajo:

/!\

Para los nombres de ficheros se seguirá el convenio de nombres descrito antes

5.4. Documentación del proyecto

Cuando nos haga falta documentar un proyecto, gforge nos permite hacerlo de una manera rápida y simple, simplemente tendremos que seleccionar el proyecto al que le queremos agregar documentación. En la pestaña documentación tenemos tres opciones, "Publicar nuevo documento", "Leer documento", "Administrar", pues bien como los nombres indican, si queremos subir un archivo con la documentación de proyecto tendremos que ir a "Publicar nuevo documento". Desde allí le agregaremos un titulo, haremos una descripción del mismo y por ultimo subiremos el fichero de documentación que queremos hacer. Después de ello simplemente lo subiremos haciendo click sobre "Enviar documento".

Cuando queramos leerlo acudiremos a "Leer documento" y desde allí seleccionaremos el documento que queramos usar. Simplemente haremos click sobre el y de esa forma nos preguntara si lo queremos descargar.

* Quizá dentro de nuestros proyectos tengamos que usar algún lector/editor de pdf, o algún software especial, en este caso no hace falta que lo subamos, pero si que seria interesante dejar especificado que lo necesitamos. Se dejará especificado en los requisitos de software los programas de software que se necesitarán para la lectura de los documentos (Quizá esté bien recomendar software específico).

* Además, se pondrá accesible una versión completa en zip de toda la documentación necesaria para la instalación y manejo de los programas.

/!\

Para la documentación, se crearan dos categorías:

1) manuales de usuario
2) manuales técnicos

Notación de los archivos sería equivalente a la de ficheros
nombreproyecto_version_nombre_manual

EJ: arotzdraw:

arotzdraw_v1.0.0_manual_usuario.pdf (categoría de manuales de usuario)
arotzdraw_v1.0.0_manual_instalacion.pdf (categoría de manuales de usuario)
arotzdraw_v1.0.0_manual_arquitectura.pdf (categoría de manuales técnicos)
arotzdraw_v1.0.0_documentacion.zip (toda la documentación del proyecto)

Para hacer las dos secciones Documentos de usuario y Documentos técnicos debemos de dirigirnos a las sección de documentación y desde alli hacer click sobre Administración. Dentro de administración volveremos a clickear sobre Crear Grupos de documentos y ya desde allí crearemos el grupo rellenando todos los campos oportunos.

Este paso lo tendremos que hacer sobre todos los proyectos que creemos ya que siempre habrá que crear los dos subgéneros de documentación.

5.5. Tareas

Las tareas en los proyectos son incidencias dentro del mismo en las que podemos hacer una lista de las cosas que quedan por hacer y asignárselas a alguien como si de una lista de To Do se tratase. Cuando seleccionamos un proyecto y nos vamos a su etiqueta Tareas nos encontramos con dos secciones To Do y Next release, nosostros nos centraremos en To Do.

Si hacemos click sobre To Do podemos ver que se nos abrirá un nuevo formulario. En esta nueva pagina tendremos que hacer click sobre Añadir tarea y nos parecera una ventana como esta:

Rellenaremos todos los combos y campos de texto con su correspondiente información haciendo inca pie en Porcentaje completado donde pondremos el porcentaje de la tarea que ya esta hecho. Por ultimo también mencionar que en Asignar a le asignaremos la tarea a la persona a la que le corresponda, incluso nos la podemos asignar a nosotros mismo.

Cuando hallamos terminado la tarea habrá sido reportada.

Por ultimo a medida que vallamos avanzando con la tarea tendremos que ir editando la misma, esto se hace haciendo click sobre ella misma y actualizando los campos que al crearla rellenamos. Haremos esto hasta que la tarea este al 100% y entonces sera cuando cambiemos el estado de Open a Closed. Si por algún motivo la queremos borrar por que ya no hace falta terminarla simplemente le cambiaremos el estado a Deleted.

6. Referencias


GforgeManualUsuario (last edited 2008-02-19 11:27:56 by DabidMartinez)

Ribera de Axpe 11, Edificio A, L215
48950 Erandio - Bilbao (Bizkaia)
Tfno : 944272119
Email: info at zylk dot net