Merge pull request AxonFramework#2997 from dgomezg/docs

Github action to build docs uses orgs variable (with default value)
lachja · Mar 13, 2024 · 2f10aeb · 2f10aeb
2 parents d9a5855 + 237427c
commit 2f10aeb
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -14,6 +14,9 @@ on:
     paths:
       - 'docs/**'
 
+env:
+  VALE_VERSION: ${{ vars.LIBRARY_VALE_VERSION || '3.3.0' }}
+
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -28,14 +31,15 @@ jobs:
 
       - name: Install vale
         run: |
-            wget https://github.com/errata-ai/vale/releases/download/v2.23.0/vale_2.23.0_Linux_64-bit.tar.gz
-            sudo tar -xvzf vale_2.23.0_Linux_64-bit.tar.gz -C /usr/local/bin vale
+          wget "https://github.com/errata-ai/vale/releases/download/v${VALE_VERSION}/vale_${VALE_VERSION}_Linux_64-bit.tar.gz"
+          sudo tar -xvzf vale_${VALE_VERSION}_Linux_64-bit.tar.gz -C /usr/local/bin vale
 
       - name: Generate Site
         run: |
           cd docs/_playbook/
           npm install
           export GIT_CREDENTIALS='https://axoniq-devops:${{ secrets.LIBRARY_DEVBOT_TOKEN }}@github.com'
+          echo 'Using' `vale -v`
           npx antora playbook.yaml
 
       - name: Notify AxonIQ Library (if a push to a tracked branch)

diff --git a/docs/reference/modules/ROOT/pages/overview.adoc b/docs/reference/modules/ROOT/pages/overview.adoc
@@ -11,7 +11,7 @@ Here is a somewhat simplified structure of a typical Axon-based application.
 include::attachment$axonframework_overview.gv[]
 ....
 
-TIP: If you want to build _(or merely explore)_ a simple example of such an application, the xref:giftcard::index.adoc[] tutorial walks you through the process.
+TIP: If you want to build _(or merely explore)_ a simple example of such an application, the xref:bikerental-demo::index.adoc[] tutorial walks you through the process.
 
 
 === The benefits