Project used to generate the online help for the Isogeo administration platform.
For full detailed developement guidelines, see this wiki.
The project is tested, built and served on Azure DevOps: https://dev.azure.com/isogeo/Documentations/_build?definitionId=27&_a=summary. As specified in the configuration (see: azure-pipelines.yml):
-
each commit triggers a deploy on QA :
-
each tagged commit triggers a deploy on PROD:
It pushes built static website on a Static Website hosted on Azure Storage (GPv2). For more details on this kind of product, refer to these resources:
- Blog: Static website hosting for Azure Storage now in public preview
- Official documentation: Static website hosting in Azure Storage
To upload built result, rclone is preferred to azure-cli because of more efficient and flexible. It's installed and used through go context in CircleCI. It needs some environment variables corresponding to the storage account keys and set in the CircleCI project settings.
Git clone this repository then:
yarn
yarn gitbook install
yarn gitbook serveFirst of all: build it.
docker build --rm -f Dockerfile -t isogeo/gitbook-builder:latest .docker run --name isogeo-help -v $PWD:/srv/gitbook --rm -it -d -p 4567:4567 isogeo/gitbook-builder:latest
# alternativately, you can use the live reload server
docker run --name isogeo-help -v $PWD:/srv/gitbook --rm -it -d -p 4567:4567 -p 35729:35729 isogeo/gitbook-builder:latestThen, open your favorite browser to http://localhost:4567.
To stop it : docker stop isogeo-help
docker run --rm -v $PWD:/srv/gitbook -v $PWD/dist:/srv/html isogeo/gitbook-builder gitbook build . /srv/htmlUsing Azure CLI (see: official doc).
# login
az login -u [email protected] -p myGre4atPachweurd
# tag it
docker build --rm -f Dockerfile -t isogeo.azurecr.io/gitbook-builder:latest .
# push it
docker push isogeo.azurecr.io/gitbook-builder:latest
# check it
az acr repository list --name isogeo