Skip to content

Commit

Permalink
Updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
labra committed Jan 27, 2022
1 parent 099326d commit 21c3326
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/README_es.md
Original file line number Diff line number Diff line change
@@ -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:
Expand Down Expand Up @@ -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.

0 comments on commit 21c3326

Please sign in to comment.