Información sobre la entrega del proyecto final en GitLab de facultad
Información sobre la entrega del proyecto final en GitLab de facultad
Timag - Proyecto final
El proyecto final de Timag (código y sitio web) se entregará en un repositorio de GITLAB de facultad.
Para hacerse una idea de cómo queda el proyecto allí se puede ver los ejemplos:
[Repo ejemplo 1] https://gitlab.fing.edu.uy/timag/proyecto_timag_con_pagina_pre_hecha
[Repo ejemplo 2] https://gitlab.fing.edu.uy/timag/pelican
[Repo ejemplo 3] https://gitlab.fing.edu.uy/timag/mkdocs/prueba_mkdocs
Para ver los repositorios y para usar Gitlab en general se accede con el usuario de facultad.
El repositorio del proyecto se hará en el usuario de algún integrante del grupo.
Manejo del repositorio Gitlab
La
edición de archivos puede hacerse directamente en el repositorio
mediante la herramienta “Web IDE” disponible en Gitlab. Esta herramienta
es similar a VSCode. El repositorio puede clonarse en una máquina local, realizar los cambios localmente y luego subirlos al repositorio. Esto puede realizarse con comandos git [1] en una terminal o integrado a un ambiente de desarrollo. Ver por ejemplo [2] para el caso de VSCode.
Generación del sitio web
Para la generación de la página web del proyecto se sugieren dos alternativas:
El sitio web se crea con una herramienta externa.
Se debe tratar de un sitio web estático [3]. Todos los links y referencias en las páginas deben ser caminos relativos.
Se crea el sitio web con la herramienta externa
Se agrega el sitio creado en un directorio “public” en el repositorio de Gitlab
Se agrega en el repositorio de Gitlab un archivo de nombre “.gitlab-ci.yml” igual al que existe en el [Repo ejemplo 1]
En el repositorio se puede ver dónde va a quedar la página yendo a Settings->Pages->Access pages
La aparición de la página en dicho lugar puede demorar algunos minutos.
Se usa un generador de sitio web disponible para Gitlab.
Hay distintos generadores para Gitlab . Les damos un ejemplo con Pelican [4].
El ejemplo con Pelican se muestra en el [Repo ejemplo 2].
En este caso las páginas se crean usando Markdown (similar a la celdas de texto de los notebooks) y el generador crea a partir de ello las páginas web.
El ejemplo [Repo ejemplo 2] se puede usar como base. En dicho ejemplo, el contenido para crear la página se compone del directorio “page_conf” y del archivo “.gitlab-ci.yml”.
Dentro del directorio “page_conf” están los archivos de configuración de la página (pelicanconf.py, publishconf.py). En el directorio “content” están los archivos markdown, imágenes y otros con la información del proyecto. Ver por ejemplo el archivo “introduction.md” dentro del directorio “content/pages”.
Al sitio web se le puede dar un estilo mediante distintos “themes” disponibles en [5]. El “theme” usado se define en el archivo “pelicanconf.py”. Puede verse como quedan algunos estilos en [6].
En el repositorio se puede ver dónde va a quedar la página yendo a Settings->Pages->Access pages
La aparición de la página en dicho lugar puede demorar algunos minutos.Tienen más información en el README.md dentro del directorio “pages_conf”
3. Otro posible generador de sitio web es MkDocs [7]
Un ejemplo con MkDocs se muestra en el [Repo ejemplo 3].
Nota:
La
estructura del sitio en [Repo ejemplo 1], [Repo ejemplo 2] y [Repo ejemplo 3] son sólo a
modo de ejemplo. Pueden estructurar el sitio como les quede más
apropiado para describir su proyecto.
[2] https://code.visualstudio.com/docs/introvideos/versioncontrol
[3] https://en.wikipedia.org/wiki/Static_web_page
[5] https://github.com/getpelican/pelican-themes
[6] https://iie.fing.edu.uy/~agomez/__timag_tmp__/2023/estilos_pagina_web/