From 9f3c01c3fb3764b08e4b4a35d96fb7053a1ffea3 Mon Sep 17 00:00:00 2001
From: Carlos Santiago <5726971+csantiago132@users.noreply.github.com>
Date: Sat, 28 Sep 2024 21:17:44 -0500
Subject: [PATCH] fix(docs): restructures Writerside/docs

---
 .github/workflows/build_docs.yml  | 51 ----------------------
 .github/workflows/deploy_docs.yml | 71 +++++++++++++++++++++++++++++++
 Writerside/cfg/buildprofiles.xml  |  2 +-
 Writerside/{kss.tree => dcs.tree} |  6 +--
 Writerside/redirection-rules.xml  | 17 --------
 5 files changed, 75 insertions(+), 72 deletions(-)
 delete mode 100644 .github/workflows/build_docs.yml
 create mode 100644 .github/workflows/deploy_docs.yml
 rename Writerside/{kss.tree => dcs.tree} (71%)
 delete mode 100644 Writerside/redirection-rules.xml

diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml
deleted file mode 100644
index ad018bd..0000000
--- a/.github/workflows/build_docs.yml
+++ /dev/null
@@ -1,51 +0,0 @@
-name: Build documentation
-
-on:
-  push:
-    branches: ['main']
-  workflow_dispatch:
-
-env:
-  INSTANCE: 'Writerside/kurocado-studio-styleguide'
-  ARTIFACT: 'webHelpKSS2-all.zip'
-  DOCKER_VERSION: '242.21870'
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout repository
-        uses: actions/checkout@v4
-        with:
-          token: ${{ secrets.GH_TOKEN }} # Use Personal Access Token (PAT)
-          fetch-depth: 0
-
-      - name: Build docs using Writerside Docker builder
-        uses: JetBrains/writerside-github-action@v4
-        with:
-          instance: ${{ env.INSTANCE }}
-          artifact: ${{ env.ARTIFACT }}
-          docker-version: ${{ env.DOCKER_VERSION }}
-
-      - name: Save artifact with build results
-        uses: actions/upload-artifact@v4
-        with:
-          name: docs
-          path: |
-            artifacts/${{ env.ARTIFACT }}
-            artifacts/report.json
-          retention-days: 7
-  test:
-    needs: build
-    runs-on: ubuntu-latest
-    steps:
-      - name: Download artifacts
-        uses: actions/download-artifact@v4
-        with:
-          name: docs
-          path: artifacts
-
-      - name: Test documentation
-        uses: JetBrains/writerside-checker-action@v1
-        with:
-          instance: ${{ env.INSTANCE }}
diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml
new file mode 100644
index 0000000..4f65f7c
--- /dev/null
+++ b/.github/workflows/deploy_docs.yml
@@ -0,0 +1,71 @@
+name: Build and Deploy Writerside Documentation
+
+on:
+  push:
+    branches: ['main'] # Trigger the workflow on push to the main branch
+  workflow_dispatch: # Allow manual triggering of the workflow
+
+permissions:
+  id-token: write
+  pages: write
+
+env:
+  INSTANCE: Writerside/docs # Set the instance to 'docs' for easier reuse
+  ARTIFACT: webHelpDocs-all.zip # Adjust artifact name to reflect 'docs'
+  DOCKER_VERSION: 242.21870 # Correct Docker version as per Writerside setup
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Pull Writerside Docker image
+        run: docker pull registry.jetbrains.team/p/writerside/builder/writerside-builder:${{ env.DOCKER_VERSION }}
+
+      - name: Build Writerside Documentation
+        uses: JetBrains/writerside-github-action@v4
+        with:
+          instance: ${{ env.INSTANCE }}
+          artifact: ${{ env.ARTIFACT }}
+          docker-version: ${{ env.DOCKER_VERSION }}
+
+      - name: Upload artifact for deployment
+        uses: actions/upload-artifact@v4
+        with:
+          name: docs
+          path: |
+            artifacts/${{ env.ARTIFACT }}
+          retention-days: 7
+
+  deploy:
+    runs-on: ubuntu-latest
+    needs: build
+
+    permissions:
+      pages: write # Permissions to publish to GitHub Pages
+      id-token: write
+
+    steps:
+      - name: Download artifact for deployment
+        uses: actions/download-artifact@v4
+        with:
+          name: docs
+
+      - name: Unzip artifact
+        run: unzip -O UTF-8 -qq ${{ env.ARTIFACT }} -d dir
+
+      - name: Configure GitHub Pages
+        uses: actions/configure-pages@v4
+
+      - name: Upload artifact to GitHub Pages
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: dir
+
+      - name: Deploy to GitHub Pages
+        uses: actions/deploy-pages@v4
diff --git a/Writerside/cfg/buildprofiles.xml b/Writerside/cfg/buildprofiles.xml
index 85ea433..9d953bb 100644
--- a/Writerside/cfg/buildprofiles.xml
+++ b/Writerside/cfg/buildprofiles.xml
@@ -4,7 +4,7 @@
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
 
     <variables></variables>
-    <build-profile instance="kss">
+    <build-profile instance="dcs">
         <variables>
             <noindex-content>false</noindex-content>
         </variables>
diff --git a/Writerside/kss.tree b/Writerside/dcs.tree
similarity index 71%
rename from Writerside/kss.tree
rename to Writerside/dcs.tree
index 10f0e30..b34f765 100644
--- a/Writerside/kss.tree
+++ b/Writerside/dcs.tree
@@ -2,9 +2,9 @@
 <!DOCTYPE instance-profile
         SYSTEM "https://resources.jetbrains.com/writerside/1.0/product-profile.dtd">
 
-<instance-profile id="kss"
-                 name="kurocado-studio-styleguide"
+<instance-profile id="dcs"
+                 name="docs"
                  start-page="starter-topic.md">
 
     <toc-element topic="starter-topic.md"/>
-</instance-profile>
+</instance-profile>
\ No newline at end of file
diff --git a/Writerside/redirection-rules.xml b/Writerside/redirection-rules.xml
deleted file mode 100644
index 988d0fa..0000000
--- a/Writerside/redirection-rules.xml
+++ /dev/null
@@ -1,17 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!DOCTYPE rules SYSTEM "https://resources.jetbrains.com/writerside/1.0/redirection-rules.dtd">
-<rules>
-    <!-- format is as follows
-    <rule id="<unique id>">
-        <accepts>page.html</accepts>
-    </rule>
-    -->
-    <rule id="6b880948">
-        <description>Created after removal of "How to" from Kurocado Studio Styleguide</description>
-        <accepts>How-to.html</accepts>
-    </rule>
-    <rule id="41b9f405">
-        <description>Created after removal of "Tutorial" from Kurocado Studio Styleguide</description>
-        <accepts>Tutorial.html</accepts>
-    </rule>
-</rules>