From 21c3326f6c0347af3e603c88ed6e3b32a61dc2dc Mon Sep 17 00:00:00 2001 From: Jose Emilio Labra Gayo Date: Thu, 27 Jan 2022 16:59:34 +0100 Subject: [PATCH] Updated readme --- docs/README_es.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/README_es.md b/docs/README_es.md index 0acb1b1..e30f5e9 100644 --- a/docs/README_es.md +++ b/docs/README_es.md @@ -1,6 +1,6 @@ ## Documentación La documentación de este proyecto se compila localmente y se despliega en GitHub pages. -la url en la que se despliega es: [https://pglez82.github.io/asw2122_0/](https://pglez82.github.io/asw2122_0/). +la url en la que se despliega es: [https://arquisoft.github.io/dede_0/](https://arquisoft.github.io/dede_0/). ### Build Documentación For the documentation we are going to use [AsciiDoc](https://asciidoc.org/) and [PlantUML](https://plantuml.com) and follows the [Arc42](https://github.com/arc42/arc42-template) template. If you want to be able to generate the doc locally you need to install Ruby and some dependencies to translate the asciidoc code into html: @@ -32,6 +32,6 @@ npm run build La documentación se generará en el directorio `docs/build`. ### Despliegue Documentación -Si queremos desplegar la documentación en GitHub pages, estará accesible en [https://pglez82.github.io/asw2122_0/](https://pglez82.github.io/asw2122_0/) necesitamos ejecutar `npm run deploy`. +Si queremos desplegar la documentación en GitHub pages, estará accesible en [https://arquisoft.github.io/dede_0/](https://arquisoft.github.io/dede_0/) necesitamos ejecutar `npm run deploy`. Si revisas el `package.json` de este directorio veras como desplegar es tan facil como ejecutar `gh-pages -d build`, que puede hacerse ejecutando directamente `npm run deploy` en el directorio de la doumentación. el paquete `gh-pages` se encarga de subir la documentación generada (basicamente archivo html) a una rama especial de github llamda gh-pages. Todo lo que se suba a esa rama es acesible en la página del repositorio. Ten en cuenta que solo queremos subir ahí la documentación. También es importante que el build de la documentación no se suba a otras ramas del proyecto. \ No newline at end of file