microprofile
diff --git a/‎.github/workflows/antora.yml‎
Lines changed: 21 additions & 12 deletions b/‎.github/workflows/antora.yml‎
Lines changed: 21 additions & 12 deletions
diff --git a/‎.github/workflows/static.yml‎
Lines changed: 43 additions & 0 deletions b/‎.github/workflows/static.yml‎
Lines changed: 43 additions & 0 deletions
diff --git a/‎README.adoc‎
Lines changed: 65 additions & 1 deletion b/‎README.adoc‎
Lines changed: 65 additions & 1 deletion
diff --git a/‎antora-assembler.yml‎
Lines changed: 1 addition & 1 deletion b/‎antora-assembler.yml‎
Lines changed: 1 addition & 1 deletion
@@ -8,27 +8,36 @@ on:
 jobs: 
   build-and-deploy:
     runs-on: ubuntu-latest
+    permissions:
+      id-token: write  # Required for authentication
+      contents: read   # Required to read repository contents
+      pages: write     # Required to deploy to GitHub Pages
     steps: 
       - name: Checkout Repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
 
       - name: Set up Node.js
-        uses: actions/setup-node@v2
+        uses: actions/setup-node@v3
         with:
-          node-version: '14'  # Use the Node.js version that matches your development environment
+          node-version: '18'  # Use a compatible Node.js version
 
-      - name: Install Antora
-        run: npm install -g @antora/cli @antora/site-generator-default
+      - name: Install Antora Locally
+        run: npm install @antora/cli @antora/site-generator-default
 
       - name: Verify Antora Installation
-        run: npm list -g @antora/cli @antora/site-generator-default || echo "Antora packages are not installed."
+        run: npm list @antora/cli @antora/site-generator-default || echo "Antora packages are not installed."
 
       - name: Generate Site with Antora
-        run: antora --fetch --stacktrace playbook.yml
+        run: npx antora --fetch --stacktrace playbook.yml
 
-      - name: Deploy to GitHub Pages
-        uses: peaceiris/actions-gh-pages@v3
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Upload Antora Site to GitHub Pages
+        uses: actions/upload-pages-artifact@v3
         with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./build/site  # The default output directory for Antora
-          publish_branch: gh-pages  # The target branch for GitHub Pages
+          path: ./build/site  # The output directory for Antora
+          
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
@@ -0,0 +1,43 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy static content to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Single deploy job since we're just deploying
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Pages
+        uses: actions/configure-pages@v5
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          # Upload entire repository
+          path: '.'
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
@@ -694,7 +694,7 @@ site:
   title: MicroProfile Tutorial
   url: https://microprofile.io
   keys:
-    seo_description: Comprehensive tutorial for learning Eclipse MicroProfile
+    seo_description: Comprehensive tutorial for learning MicroProfile
     seo_keywords: microprofile, java, cloud-native, microservices
 ----
 
@@ -709,7 +709,9 @@ ui:
     url: ./path/to/local/ui-bundle.zip
     snapshot: true
 ----
+
 Replease _./path/to/local/ui-bundle.zip_ with actual path to your local UI bundle under development.
+
 This approach is useful when developing your own UI bundle or testing modifications.
 
 ### UI Bundle Development
@@ -743,3 +745,65 @@ When troubleshooting UI problems:
 2. Check the browser console for JavaScript errors
 3. Verify that all required resources are loading correctly
 4. Test with different browsers to identify browser-specific issues
+
+## GitHub Actions Workflow for Deployment
+
+The documentation site is automatically built and deployed using GitHub Actions. Below is an overview of the workflow:
+
+### Workflow Configuration
+
+The workflow is defined in `.github/workflows/antora.yml` and includes the following steps:
+
+1. **Checkout Repository**:
+   Uses the `actions/checkout@v3` action to fetch the repository.
+
+2. **Set up Node.js**:
+   Configures Node.js version `18` using `actions/setup-node@v3`.
+
+3. **Install Antora Locally**:
+   Installs Antora CLI and site generator locally:
+   ```bash
+   npm install @antora/cli @antora/site-generator-default
+   ```
+
+4. **Verify Antora Installation**:
+   Ensures the required packages are installed:
+   ```bash
+   npm list @antora/cli @antora/site-generator-default || echo "Antora packages are not installed."
+   ```
+
+5. **Generate Site with Antora**:
+   Builds the site using the playbook:
+   ```bash
+   npx antora --fetch --stacktrace playbook.yml
+   ```
+
+6. **Setup Pages**:
+   Configures GitHub Pages using `actions/configure-pages@v4`.
+
+7. **Upload Site to GitHub Pages**:
+   Uploads the generated site artifact using `actions/upload-pages-artifact@v3`.
+
+8. **Deploy to GitHub Pages**:
+   Deploys the site using `actions/deploy-pages@v4`.
+
+### Permissions
+
+The workflow requires the following permissions:
+- `id-token: write` for authentication.
+- `contents: read` to access repository contents.
+- `pages: write` to deploy the site to GitHub Pages.
+
+### Deployment URL
+
+After a successful deployment, the site is available at:
+```
+https://<username>.github.io/<repository-name>/
+```
+Replace `<username>` (for e.g. microprofile) with your GitHub username and `<repository-name>` (for e.g. microprofile-tutorial) with the name of your repository.
+
+The production branch url for the MicroProfile Tutorial documentation would be:
+
+```
+https://microprofile.github.io/microprofile-tutorial/
+```
@@ -43,4 +43,4 @@ antora:
       output_format: pdf
 
 output:
-  dir: ./build/site
+  dir: ./build/site