Documentación de usuario de SidelabCode¶
Si has llegado hasta aquí es porque estás interesado en conocer cómo se utiliza SidelabCode. SidelabCode es la forja de desarrollo del laboratorio Sidelab.
Cualquiera puede descargar e instalar SidelabCode en su propio servidor, pero toda la documentación de esta página considera que quieres acceder a la forja que está instalada en http://code.sidelab.es.
¿Qué datos necesitas para acceder a SidelabCode?¶
Lo primero que necesitas saber es tu nombre de usuario, tu contraseña y el proyecto al que tienes acceso. En el resto de la documentación, el usuario será "pepe", su contraseña será "pepepass" y el proyecto se llamará "pepepfc". Seguramente Mica, Patxi o algún otro colaborador de Sidelab te habrá hecho llegar tus datos de acceso y el identificador del proyecto al que tienes acceso.
Acceso a los servicios de la forja¶
Los miembros de un proyecto en SidelabCode tienen acceso a los siguientes servicios:- Un proyecto en Redmine
- Un repositorio Subversion accesible por https
- Una carpeta privada protegida por contraseña accesible por SFTP (lectura y escritura) y por https (Sólo lectura)
- Una carpeta pública accesible por http. La modificación del contenido de esa carpeta se realizará por SFTP protegido por contraseña.
Además, SidelabCode permite que los proyectos sean públicos o privados:
- Privados: Sólo serán accesibles (tanto lectura como escritura) por los usuarios asignados al proyecto. De esa forma está garantizada la confidencialidad de los proyectos. Un proyecto privado es ideal para el desarrollo de proyectos internos.
- Públicos: Sólo podrán escribir en ellos los usuarios asignados al proyecto. En cambio, la siguiente información será pública:
- Proyecto en Redmine (wiki, issues, miembros del proyecto...)
- Repositorio SVN: Accesible por http de sólo lectura sin autenticación
Acceso al proyecto en Redmine¶
Redmine es una aplicación web que permite gestionar proyectos software. Cada proyecto dispone de un wiki, issues, foros, acceso vía web al repositorio de código, etc. Visita la guía de usuario oficial si tienes dudas sobre cómo usar esta aplicación web. La página que estás leyendo, es una página del wiki de un proyecto del Redmine de SidelabCode.
La página del proyecto de pepe está en la dirección http://code.sidelab.es/projects/pepepfc
Si el proyecto es público, cualquiera podrá acceder al contenido del proyecto (pero no modificarlo). Para acceder a Redmine, hay que ir a la opción "Conexión" de la esquina superior derecha e insertar las credenciales de acceso.
Acceso al repositorio de código SVN¶
Lo más normal es que estés usando SidelabCode para desarrollar un proyecto software, y por tanto, tendrás acceso a un repositorio de código SVN.
La ruta de acceso al repositorio del proyecto de pepe es: https://code.sidelab.es/svn/pepepfc (ojo que hay que poner el protocolo https, con la "s"). Con esta URL podrás conectar el repositorio a Eclipse para subir y bajar los cambios.
Si el proyecto es público, además cualquier podrá tener un acceso de lectura del repositorio en http://code.sidelab.es/svn/pepepfc (ojo que ahora si es http, sin la "s").
Acceso a las carpetas compartidas¶
Todo proyecto de la forja dispone de dos carpetas en el servidor, una pública y otra privada. Estas dos carpetas están siempre disponibles independientemente de si el proyecto es público o privado.
Para acceder a estas carpetas, usamos el protocolo SFTP. Nosotros usamos FileZilla para acceder a los ficheros. En principio, cualquier software que soporte SFTP debería funcionar, pero hemos tenido problemas de compatibilidad con Nautilus en Ubuntu y no podemos acceder.
La ruta de acceso a las carpetas de pepepfc son:- Carpeta pública: sftp://code.sidelab.es/public/pepepfc
- Carpeta privada: sftp://code.sidelab.es/private/pepepfc
- Carpeta pública: http://code.sidelab.es/public/pepepfc
- Carpeta privada: https://code.sidelab.es/private/pepepfc (protegido por contraseña)
NOTA: Debido a un error. Actualmente el acceso por https a la carpeta privada no está soportado
¿Cómo poner una página web a un proyecto?¶
Todo proyecto software público debería tener una página web. La página web debería contener información de presentación, descripción del proyecto, documentación, etc. En Sidelab existen varias formas de crear una página web para un proyecto.
Página en HTML/PHP
El formato estándar de creación de páginas webs es HTML. Pero todos sabemos que crear una página desde cero sólo en HTML en poco eficiente, sobre todo porque las páginas acaban compartiendo un menú común y la administración manual es muy costosa. Con PHP podemos crear páginas web simples de forma manual de forma razonablemente eficiente.
En SidelabCode, podemos crear una página web del proyecto en la carpeta "www" de la carpeta pública. El contenido de esa carpeta es accesible en la URL http://www.sidelab.es/projects/pepepfc. Podemos usar HTML y PHP.
Incluso de puede usar Drupal o Joomla, pero eso requiere de intervención manual de los administradores de la forja porque hay que crear la base de datos necesaria de forma manual.
Página del wiki
Para proyectos más informales, el wiki de Redmime puede servir perfectamente como página web. No permite mucha personalización, pero es un sistema muy ágil de editar y eso favorece que esté siempre actualizado. La URL de acceso al wiki del proyecto de pepepfc es http://code.sidelab.es/projects/pepepfc/wiki. No obstante, como esa URL no es muy "amigable", los proyectos que no tienen carpeta "www" en su carpeta pública, tienen una redirección desde http://www.sidelab.es/projects/pepepfc a la página del wiki.
¿Cómo cambiar mi contraseña?¶
En SidelabCode, los administradores ponen una contraseña de acceso a los usuarios. Pero es bastante recomendable que los usuarios modifiquen la contraseña y la cambien por la que ellos prefieran.
Para cambiar la contraseña se accede a la aplicación de administración de la forja SidelabCode en la dirección https://code.sidelab.es:5555/. Se introduce el nombre de usuario y la contraseña y se hace login. Al acceder se pueden ver los datos del usuario: nombre, apellidos, userid, correo electrónico. También aparece información relativa a los proyectos en los que está el usuario, que para cambiar la contraseña no es relevante.
Para cambiar la contraseña tenemos que pulsar en el botón "Editar" que aparece a la derecha de la etiqueta "Menú de Usuario". Eso habilitará el checkbox de "Modificar contraseña del usuario". Al ser pulsado, aparecen tres cuadros de texto, uno para introducir la contraseña antigua y otros dos para poner la nueva. Para terminar, se deberá pulsar el botón "Guardar cambios".
Yo quiero un SidelabCode para mi¶
Una vez que te acostumbras a usar una forja de desarrollo ya no puedes vivir sin ella. Las forjas de desarrollo proporcionan muchas herramientas para imprescindibles para el desarrollo colaborativo de aplicaciones.
Siempre puedes instalarte SidelabCode en tu propio servidor. Pero no todo el mundo tiene un servidor y una conexión a Internet para poder instalarse su propia forja. Si este es tu caso, echa un vistazo a la página de Servicios de Redmine y SVN gratuitos para desarrollo de proyectos privados.