Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
cidinene authored Jan 28, 2023
1 parent 3fa3fea commit 0a4d1f7
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## The documentation
In this project the documentation is compiled locally and deployed to GitHub pages.
The deployment url is: [https://arquisoft.github.io/lomap_0/](https://arquisoft.github.io/lomap_0/).
The deployment url is: [https://arquisoft.github.io/lomap_es2a/](https://arquisoft.github.io/lomap_es2a/).

### Documentation build
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, Java and some dependencies to translate the asciidoc code into html. If you are in Linux you can install Ruby and Java simply by executing:
Expand Down Expand Up @@ -30,6 +30,6 @@ npm run build
The documentation will be generated under the `docs/build` directory.

### Documentation deployment
If we want to deploy it to GitHub pages, so it is accesible via [https://arquisoft.github.io/lomap_0/](https://arquisoft.github.io/lomap_0/) we need to execute `npm run deploy`.
If we want to deploy it to GitHub pages, so it is accesible via [https://arquisoft.github.io/lomap_es2a/](https://arquisoft.github.io/lomap_es2a/) 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 in 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 in 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 0a4d1f7

Please sign in to comment.