Capítulo 5 Guía rápida sobre uso de ixplorer
En este documento describimos brevemente qué encontrará dentro de ixplorer. En caso de que necesite información más detallada sobre el uso de alguna de las funcionales del sitio, por favor buscar en los tutoriales específicos del tema.
5.1 ¿Qué es ixplorer?
Es una plataforma que permite que el trabajo en equipo sobre proyectos de datos sea de una manera más fácil y ordenada ya que permite la clasificación de archivos por repositorios, control de versiones, asignación de tareas, comunicación del estado del proyecto entre otros.
Para esto se tienen varias herramientas que permiten un flujo de trabajo fácil para visualizar el estado de las tareas del proyecto, los repositorios existentes, los colaboradores y su trabajo así como incidencias que surgen durante el desarrollo del proyecto.
Vamos a revisar qué son estas secciones:
5.2 Panel de control
Esta es la pestaña que nos muestra de manera general el entorno en el que nos encontramos, nuestros repositorios, proyectos en las que estamos involucrados y las acciones que hemos generado dentro de todos los repositorios en los que tenemos participación. Este panel es lo que comúnmente se llama “Dashboard” y su función principal es darnos un vistazo rápido del estado del momento.
Dentro del dashboard tenemos la posibilidad de elegir el contexto que queremos visualizar, es decir que las acciones generadas a mostrar sean pertenecientes a un solo tema. Para elegir debemos de hacerlo tal y como se muestra en la siguiente imagen:
También tenemos la opción para mostrar los proyectos a los cuales pertenecemos. Es necesario hacer énfasis en que proyectos hace referencia a grupos de trabajo con un objetivo los cuales pueden tener más de un repositorio. En la siguiente imagen se muestra en la esquina inferior derecha la opción de visualizar los proyectos a las cuales un usuario pertenece:
5.3 Tiquetes
Esta sección está considerada como un espacio para reportar y anotar incidencias que quedaran plasmadas como un tiquete con sus respectivos identificadores. Estas pueden ir desde comentarios en un repositorio para mejorar el código, para sugerir nuevas ideas o para indicar errores encontrados en la funcionalidad del código.
Por ende, si queremos revisar el estado de los tiquetes, tanto los que hemos creado como los que se nos han asignado lo podemos hacer en esta sección.
Así mismo, existen ciertas normas a seguir cuando necesitamos crear un tiquete. Por ejemplo, si al usar código y funciones de un paquete de un repositorio y hemos obtenido un error, para reportarlo debemos de crear un ejemplo reproducible.
Un ejemplo reproducible es una forma de comunicar con detalles los pasos y acciones que cometimos hasta que obtuvimos el error. La idea detrás de esto es que compañeros de trabajo puedan comprender y seguir los mismos pasos (reproducibilidad) para entender y tener mayores posibilidades de corregir el error.
Para mayor información y detalle sobre cómo generar un ejemplo reproducible podemos seguir esta guía.
5.4 Solicitud de fusión
Cuando un usuario crea un repositorio, el código y todos los archivos estarán “bajo su repositorio.” Si un segundo usuario desea utilizar dichos archivos y código podrá hacer una bifurcación, que no es más que una copia. Esto permite que se pueda experimentar introduciendo cambios sin afectar los archivos originales.
Si generamos cambios que tienen utilidad y pueden mejorar el proyecto, necesitamos comunicarle al dueño del repositorio o encargado del repositorio central sobre dichos cambios. Esto con la finalidad de que los acepte e integre al repositorio (archivos y código) original.
Este paso se hace mediante una solicitud de fusión (pull request) que le permitirá al dueño del repositorio revisar los cambios y aceptarlos o rechazarlos.
Si queremos mirar el estado de las solicitudes de fusión lo podemos hacer mediante esta pestaña.
5.5 Explorar
En explorar tenemos un buscador de repositorios, usuarios, proyectos y código. Cuando necesitamos encontrar alguno de estos elementos del equipo DATA de manera rápida lo mejor es hacerlo en esta pestaña.
5.6 Otras opciones
Cuando nos encontremos dentro de ixplorer nos vamos a encontrar más opciones y herramientas que podemos utilizar tal como se muestra en la siguiente imagen:
En la esquina superior derecha tenemos tres íconos que nos permiten (de izquierda a derecha) conocer de manera rápida notificaciones, crear un nuevo repositorio / migración / proyecto y la opción de revisar / configurar nuestro perfil dentro del entorno ixplorer
5.7 Dentro de un repositorio
Al dirigirnos a un repositorio en específico nos encontraremos con una mayor cantidad de opciones y herramientas para trabajar. El repositorio es el sitio donde se guardan los archivos como código, imágenes, archivos de texto o markdown entre otros que se necesitan para que el proyecto DATA funcione.
De manera general, dentro de un repositorio en ixplorer deberíamos de ver lo siguiente:
Vamos paso a paso para que nos podamos ubicar dentro de las opciones que encontramos aquí:
5.7.1 Primera sección
En esa sección encuadrada en rojo tenemos el usuario al cual pertenece el repositorio y opciones para seguirlo/dejar de seguir, destacarlo o bien la opción Bifurcar (fork) que nos permite copiar el mismo repositorio en nuestro repositorio remoto.
5.7.2 Segunda sección
Tenemos siete opciones para visualizar diferentes aspectos como el código, los tiquetes, si se han hecho solicitudes de fusión al repositorio, lanzamientos (trabajos con una versión finalizada), el wiki (ayuda y documentación), actividad dentro del repositorio y la opción de configuración que permite agregar usuarios, cambiar condiciones de privacidad
5.7.3 Tercera sección:
Visualiza de manera rápida la cantidad de commits (cambios generados) y las ramas creadas.
5.7.4 Cuarta sección
Nos indica la información de qué rama está mostrando, el nombre del repositorio, las opciones para crear / subir un nuevo archivo y también la dirección (tanto en HTTPS como en SSH) para poder clonar el repositorio)
5.7.5 Quinta sección
Muestra archivos que se encuentran en la rama anteriormente mostrada, los commits y el tiempo que ha transcurrido desde su creación / modificación.