diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml deleted file mode 100644 index a03dbb2..0000000 --- a/.github/workflows/build_docs.yml +++ /dev/null @@ -1,70 +0,0 @@ -name: Build and Deploy Writerside Documentation - -on: - push: - branches: ['canary'] - workflow_dispatch: - -permissions: - id-token: write - pages: write - -env: - INSTANCE: Writerside/Kurocado Studio Styleguide # Adjust the instance based on your configuration - ARTIFACT: webHelpKSS2-all.zip # Adjust if needed - DOCKER_VERSION: 242.21870 - -jobs: - build: - runs-on: ubuntu-latest - - steps: - - name: Checkout repository - uses: actions/checkout@v4 - with: - fetch-depth: 0 - - - name: Build Writerside docs using Docker - uses: JetBrains/writerside-github-action@v4 - with: - instance: ${{ env.INSTANCE }} - artifact: ${{ env.ARTIFACT }} - docker-version: ${{ env.DOCKER_VERSION }} - # Update to reflect the path of your Writerside directory inside the app - path: Writerside - - - name: Upload artifact - uses: actions/upload-artifact@v4 - with: - name: docs - path: | - artifacts/${{ env.ARTIFACT }} - retention-days: 7 - - deploy: - environment: - name: github-pages - url: ${{ steps.deployment.outputs.page_url }} - needs: build - runs-on: ubuntu-latest - - steps: - - name: Download artifact - uses: actions/download-artifact@v4 - with: - name: docs - - - name: Unzip artifact - run: unzip -O UTF-8 -qq ${{ env.ARTIFACT }} -d dir - - - name: Setup Pages - uses: actions/configure-pages@v4.0.0 - - - name: Upload artifact - uses: actions/upload-pages-artifact@v3.0.1 - with: - path: dir - - - name: Deploy to GitHub Pages - id: deployment - uses: actions/deploy-pages@v4.0.4 diff --git a/.github/workflows/deploy_docs.yml b/.github/workflows/deploy_docs.yml new file mode 100644 index 0000000..949bf88 --- /dev/null +++ b/.github/workflows/deploy_docs.yml @@ -0,0 +1,36 @@ +name: Build documentation + +on: + push: + branches: ['main'] + workflow_dispatch: + +env: + INSTANCE: 'Writerside/dcs' + ARTIFACT: 'webHelpDCS2-all.zip' + DOCKER_VERSION: '242.21870' + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout repository + uses: actions/checkout@v4 + with: + token: ${{ secrets.GITHUB_TOKEN }} + 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 }} + retention-days: 7 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"> - + false diff --git a/Writerside/kss.tree b/Writerside/dcs.tree similarity index 77% rename from Writerside/kss.tree rename to Writerside/dcs.tree index bf9793b..b34f765 100644 --- a/Writerside/kss.tree +++ b/Writerside/dcs.tree @@ -2,8 +2,8 @@ - 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 @@ - - - - - - Created after removal of "How to" from Kurocado Studio Styleguide - How-to.html - - - Created after removal of "Tutorial" from Kurocado Studio Styleguide - Tutorial.html - - diff --git a/Writerside/topics/starter-topic.md b/Writerside/topics/starter-topic.md index 10488d5..2437067 100644 --- a/Writerside/topics/starter-topic.md +++ b/Writerside/topics/starter-topic.md @@ -1,4 +1,4 @@ -# About Kurocado Studio Styleguide +# About docs diff --git a/Writerside/writerside-config.xml b/Writerside/writerside-config.xml index d07aef0..38b8c11 100644 --- a/Writerside/writerside-config.xml +++ b/Writerside/writerside-config.xml @@ -1,3 +1,5 @@ - - - + + + + + diff --git a/Writerside/writerside.cfg b/Writerside/writerside.cfg index 2b59f56..2f58de1 100644 --- a/Writerside/writerside.cfg +++ b/Writerside/writerside.cfg @@ -4,5 +4,5 @@ - +