Skip to content

Commit

Permalink
Prueba de acceso
Browse files Browse the repository at this point in the history
  • Loading branch information
UO285267 authored Jan 29, 2024
1 parent 01d6c18 commit 3558312
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ For the documentation, we are going to use [AsciiDoc](https://asciidoc.org/) and
```shell
apt-get install ruby default-jre
```

On Windows, you can use [these instructions](https://www.ruby-lang.org/en/documentation/installation). Probably you will have Java already installed in your system, if not, you can download it [here](https://www.oracle.com/es/java/technologies/javase/javase8-archive-downloads.html)

Once Ruby is working you can install some gems with `asciidoctor` and `asciidoctor-diagram`.
Expand All @@ -32,4 +32,4 @@ The documentation will be generated under the `docs/build` directory.
### Documentation deployment
If we want to deploy it to GitHub pages, so it is accessible via [https://arquisoft.github.io/wiq_es3a/](https://arquisoft.github.io/wiq_es3a/), we need to execute `npm run deploy`.

If you check the `package.json` in this directory you can see how deploying is as easy as executing `gh-pages -d build`, which can be directly executed using `npm run deploy` in the docs directory. The `gh-pages` package is in charge of pushing the documentation generated directory (basically some htmls) to a special github branch called gh-pages. Everything pushed to this branch is accessible on the repository page. Note that we only want to push there the documentation. Also is important that the documentation build is not pushed to the other branches of the project.
If you check the `package.json` in this directory you can see how deploying is as easy as executing `gh-pages -d build`, which can be directly executed using `npm run deploy` in the docs directory. The `gh-pages` package is in charge of pushing the documentation generated directory (basically some htmls) to a special github branch called gh-pages. Everything pushed to this branch is accessible on the repository page. Note that we only want to push there the documentation. Also is important that the documentation build is not pushed to the other branches of the project.

0 comments on commit 3558312

Please sign in to comment.