Merge pull request #244 from Kotlin/documentation

Writerside documentation

.github/workflows/deploy_docs.yml

@@ -0,0 +1,98 @@
+name: Build documentation
+
+on:
+  # The workflow will be triggered automatically once you push to the `main` branch.
+  push:
+    branches: [ "main" ]
+
+  # Specify to run a workflow manually from the Actions tab on GitHub
+  workflow_dispatch:
+
+# Gives the workflow permissions to clone the repo and create a page deployment
+permissions:
+  id-token: write
+  pages: write
+
+env:
+  INSTANCE: docs/kd
+  ARTIFACT: webHelpKD2-all.zip
+  DOCKER_VERSION: 232.10165.1
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v3
+
+      - name: Build Writerside docs using Docker
+        uses: JetBrains/writerside-github-action@v4
+        with:
+          instance: ${{ env.INSTANCE }}
+          artifact: $${{ env.ARTIFACT }}
+          docker-version: ${{ env.DOCKER_VERSION }}
+
+      - name: Upload documentation
+        uses: actions/upload-artifact@v3
+        with:
+          name: docs
+          path: |
+            artifacts/${{ env.ARTIFACT }}
+            artifacts/report.json
+          retention-days: 7
+
+      # TODO: Add Algolia indexes
+      - name: Upload algolia-indexes
+        uses: actions/upload-artifact@v3
+        with:
+          name: algolia-indexes
+          path: artifacts/${{ env.ALGOLIA_ARTIFACT }}
+          retention-days: 7
+
+  test:
+    # Requires build job results
+    needs: build
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v1
+        with:
+          name: docs
+          path: artifacts
+
+      - name: Test documentation
+        uses: Jetbrains/writerside-checker-action@v1
+        with:
+          instance: ${{ env.INSTANCE }}
+
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    # Requires the build job results
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - name: Download artifact
+        uses: actions/download-artifact@v3
+        with:
+          name: docs
+
+      - name: Unzip artifact
+        uses: montudor/action-zip@v1
+        with:
+          args: unzip -qq ${{ env.ARTIFACT }} -d dir
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v2
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: dir
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

docs/c.list

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE categories
+        SYSTEM "https://resources.jetbrains.com/writerside/1.0/categories.dtd">
+<categories>
+    <category id="ext" name="External resources" order="1"/>
+    <category id="get-start" name="Getting Started" order="2"/>
+    <category id="user-guide" name="User Guide" order="3"/>
+    <category id="api-docs" name="API" order="4"/>
+    <category id="examples" name="Examples" order="5"/>
+</categories>

docs/cfg/buildprofiles.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<buildprofiles xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/build-profiles.xsd"
+               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+    <variables>
+        <header-logo>ktn_3d_icon.png</header-logo>
+        <enable-browser-edits>true</enable-browser-edits>
+        <browser-edits-url>https://github.com/kandy/docs/edit/main/</browser-edits-url>
+        <auto-convert-headings-to-chapters>true</auto-convert-headings-to-chapters>
+    </variables>
+    <build-profile instance="kandy">
+        <variables>
+            <noindex-content>false</noindex-content>
+        </variables>
+    </build-profile>
+    <footer>
+        <social type="blog" href="https://blog.jetbrains.com/kotlin/category/data-science/"/>
+        <social type="twitter" href="https://twitter.com/KotlinForData"/>
+        <social type="youtube" href="https://www.youtube.com/@Kotlin"/>
+        <link href="https://github.com/Kotlin/kandy">GitHub</link>
+        <link href="https://kotlinlang.slack.com/archives/C4W52CFEZ">Slack Community</link>
+        <copyright>2000–2024 JetBrains s.r.o.</copyright>
+    </footer>
+</buildprofiles>

docs/cfg/platforms.xml

@@ -0,0 +1,12 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<platforms>
+    <platform id="primary">
+        <src>keymap.xml</src>
+        <use-keymaps>
+            primary_Win-Linux
+        </use-keymaps>
+        <use-keymaps>
+            primary_macOS
+        </use-keymaps>
+    </platform>
+</platforms>